BEbeyondidentity
SCIM

Replace a User

To replace all attributes of an existing user, send a PUT request to /Users/$USER_ID. As specified in RFC-7644 §3.5.1, this operation performs a complete replacement of all attributes except server-managed attributes. Values in the request body for immutable or read-only fields will be ignored. If an attribute is not specified in the request, it will be removed or reset to its default value. Important notes about email handling: - Only one email address is supported per user - The email must be marked as primary (primary: true) - If multiple email addresses are provided, only the primary email will be used and all others will be ignored

put/scim/v2/Users/{user_id}

Request

Path parameters

user_idstring required

ID of the user.

Request body

Example request

{
  "user": {
    "schemas": [
      "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "id": "ed9fcce6-ec82-458e-ae58-e2d975cfc32d",
    "externalId": "external-id-abcdef",
    "userName": "test_user",
    "displayName": "Test User",
    "active": true,
    "emails": [
      {
        "primary": true,
        "value": "test@test.com",
        "type": "work"
      }
    ],
    "name": {
      "givenName": "Barbara",
      "familyName": "Jensen"
    },
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
      "employeeNumber": "10.164682/g9j6r80"
    },
    "groups": [
      {
        "value": "e9e30dba-f08f-4109-8486-d5c6a331660a",
        "$ref": "../Groups/e9e30dba-f08f-4109-8486-d5c6a331660a",
        "type": "direct"
      }
    ],
    "meta": {
      "resourceType": "Group",
      "created": "2022-04-07T07:23:33Z",
      "lastModified": "2023-03-30T07:00:14Z",
      "location": "Groups/ed9fcce6-ec82-458e-ae58-e2d975cfc32d",
      "version": "W/0"
    }
  }
}

Response

Successfully replaced the User resource. The response contains the full representation of the modified User, including any server-side changes and read-only attributes as specified in RFC-7644 §3.5.1.

schemasstring[] required

The list of schemas used to define the user. This must contain only the core User schema ("urn:ietf:params:scim:schemas:core:2.0:User").

idstring

The unique ID of the user. This is automatically generated on creation. This field is immutable and output-only.

externalIdstring

The provisioning client's unique identifier for the resource. This value must be unique across all users.

userNamestring

The unique username of the user. The value of this field will be returned as the subject of an OIDC ID Token.

displayNamestring

Display name of the User. This name is used for display purposes.

activeboolean

Indicator for the user's administrative status. If true, the user has administrative capabilities.

Example response

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "ed9fcce6-ec82-458e-ae58-e2d975cfc32d",
  "externalId": "external-id-abcdef",
  "userName": "test_user",
  "displayName": "Test User",
  "active": true,
  "emails": [
    {
      "primary": true,
      "value": "test@test.com",
      "type": "work"
    }
  ],
  "name": {
    "givenName": "Barbara",
    "familyName": "Jensen"
  },
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "employeeNumber": "10.164682/g9j6r80"
  },
  "groups": [
    {
      "value": "e9e30dba-f08f-4109-8486-d5c6a331660a",
      "$ref": "../Groups/e9e30dba-f08f-4109-8486-d5c6a331660a",
      "type": "direct"
    }
  ],
  "meta": {
    "resourceType": "Group",
    "created": "2022-04-07T07:23:33Z",
    "lastModified": "2023-03-30T07:00:14Z",
    "location": "Groups/ed9fcce6-ec82-458e-ae58-e2d975cfc32d",
    "version": "W/0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.