# Update a user

Update a user for the specified platform

Endpoint: PUT /api/orgs/{platform_key}/scim/v2/Users/{id}
Version: 4.84.1-ai-plus
Security: PlatformApiKeyAuthentication

## Query parameters:

  - `format` (string)
    Enum: "json", "scim+json"

## Path parameters:

  - `id` (string, required)

  - `platform_key` (string, required)

## Request fields (application/scim+json):

  - `schemas` (array)
    SCIM schema identifiers

  - `userName` (string, required)
    Unique username/email for the user

  - `name` (object, required)
    User's name information

  - `name.formatted` (string, required)
    Full formatted name

  - `name.familyName` (string, required)
    Family/last name

  - `name.givenName` (string, required)
    Given/first name

  - `emails` (array, required)
    User's email addresses

  - `emails.value` (string, required)
    Email address

  - `emails.primary` (boolean)
    Whether this is the primary email

  - `emails.type` (string)
    Email type (work, home, etc.)

  - `active` (boolean)
    Whether the user is active

  - `displayName` (string)
    Display name

  - `locale` (string)
    User locale

  - `timezone` (string)
    User timezone

  - `title` (string)
    Job title

  - `organization` (string)
    Organization

  - `phoneNumbers` (array)
    Phone numbers

  - `phoneNumbers.value` (string, required)
    Phone number

  - `phoneNumbers.type` (string, required)
    Phone type (work, home, mobile, etc.)

  - `addresses` (array)
    Addresses

  - `addresses.type` (string, required)
    Address type (work, home, etc.)

  - `addresses.formatted` (string, required)
    Full formatted address

  - `addresses.streetAddress` (string, required)
    Street address

  - `addresses.locality` (string, required)
    City

  - `addresses.region` (string, required)
    State/region

  - `addresses.postalCode` (string, required)
    Postal code

  - `addresses.country` (string, required)
    Country

  - `entitlements` (array)
    User entitlements

  - `roles` (array)
    User roles

  - `x509Certificates` (array)
    X.509 certificates

  - `password` (string)
    User password

  - `provider` (string)
    Authentication provider

  - `tpaUid` (string)
    Third-party authentication UID

  - `isStaff` (boolean)
    Whether the user is a staff member

  - `update` (boolean)
    Whether to update existing user

  - `platformOrgs` (array)
    List of platform organizations to link the user to

  - `departmentIds` (array)
    List of department IDs to make the user a member of

  - `groupIds` (array)
    List of group IDs to add the user to

  - `rbacGroupUniqueIds` (array)
    List of RBAC group unique IDs to add the user to

  - `meta` (object)
    Resource metadata

  - `meta.resourceType` (string)
    Resource type

  - `meta.created` (string)
    Creation timestamp

  - `meta.lastModified` (string)
    Last modification timestamp

  - `meta.version` (string)
    Resource version

  - `meta.location` (string)
    Resource location URL

## Response 200 fields (application/scim+json):

  - `schemas` (array, required)
    SCIM schema identifiers

  - `id` (string, required)
    User ID

  - `userName` (string, required)
    Username

  - `name` (object, required)
    User's name information

  - `name.formatted` (string, required)
    Full formatted name

  - `name.familyName` (string, required)
    Family/last name

  - `name.givenName` (string, required)
    Given/first name

  - `emails` (array, required)
    User's email addresses

  - `emails.value` (string, required)
    Email address

  - `emails.primary` (boolean)
    Whether this is the primary email

  - `emails.type` (string)
    Email type (work, home, etc.)

  - `active` (boolean, required)
    Whether the user is active

  - `urn_ietf_params_scim_schemas_extension_enterprise_2_0_User` (object, required)
    Enterprise user extension data

  - `urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.edxData` (any)
    edX user data

  - `urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.userData` (any)
    User metadata

  - `urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.departments` (array)
    List of department memberships

  - `urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.groups` (array)
    List of group memberships

  - `urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.rbacGroups` (array)
    List of RBAC groups the user belongs to

  - `urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.platforms` (array)
    List of platforms the user has access to

  - `meta` (object)
    Resource metadata

  - `meta.resourceType` (string)
    Resource type

  - `meta.created` (string)
    Creation timestamp

  - `meta.lastModified` (string)
    Last modification timestamp

  - `meta.version` (string)
    Resource version

  - `meta.location` (string)
    Resource location URL