Accounts and users

Update SCIM user attributes

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Update certain attributes of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.

This endpoint allows for selective adding, removing, or replacing specific attributes while leaving other attributes unchanged.

patch/v1/provisioning/scim/Users/{userId}

Request

Path parameters

userIdinteger required

The ID of the user.

Request body

schemasstring[]

SCIM schema for the given resource.

Example request

{
  "Operations": [
    {
      "op": "replace",
      "path": "active",
      "value": "test"
    },
    {
      "op": "add",
      "path": "nickName",
      "value": "johndoe"
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}

Response

User details

activeboolean

Status of the user.

displayNamestring

Display name of the user.

userNamestring required

Unique identifier of the user. This is usually an email address.

idstring required

ID of the user.

Example response

{
  "active": true,
  "displayName": "John Doe",
  "userName": "john.doe@example.com",
  "name": {
    "formatted": "Mr. John J Doe"
  },
  "id": "359"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.