Update User's Attributes

Change all fields of the user entity. Cannot change ID.

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

scim

❗️

API Availability

The SCIM API is only available for customers enrolled in Talkdesk's Early Access (EA) program.
To enter the EA program, contact a Customer Success Manager.

Body Request - Example

{
  "schemas": [
    "urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User",
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "name": {
    "familyName": "string",
    "givenName": "string"
  },
  "externalId": "string",
  "userName": "string",
  "active": true,
  "urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User": {
    "rolesString": "string",
    "teamsString": "string"
  }
}

Body Response - Schema

200 OK (the user has been updated)

User entity

ParameterTypeDescriptionRequired
schemasarray[string]URN schemas for User resource. Allowed values:
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User"
yes
idstringThe ID for the object. Immutable.yes
activebooleanthe user's administrative statusyes
externalIdstringthe external ID for the userno
metaobjectuser metadata. "meta" subdivides into:

1 - "created" (string
)
- date and time the resource was created.

2 - "lastModified" (string) - date and time the resource was last modified.

3 - "resourceType" (string) - the resource type.

4 - "location" (string) - the location (URI) of the resource.

5 - "version" (string) - the version of the resource.
no
nameobjectThe components of the user's real name. "name" subdivides into:

1 - "familyName" (string) - the family name of the User, or Last Name in most Western languages (for example, Jensen given the full name Ms. Barbara J Jensen, III.). Required.

2 - "givenName" (string) - the given name of the User, or First Name in most Western languages. Required.
yes
userNamestringThe user's email.yes
urn:ietf:params:scim:schemas:extension:talkdesk:2.0:UserobjectThe user's custom attributes. "urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User" subdivides into:

1 - "rolesString" (string) - a list of roles for the user that collectively represent who the user is separated by semicolons, e.g., 'Student;Faculty'. Required.

2 - "teamsString" (string) - the user's team list separated by semicolons.
yes

400 (bad request), 401 (missing or invalid authorization), 403 (forbidden operation), 404 (user not found), 406 (not acceptable), 409 (conflict with user)

SCIM-related error

ParameterTypeDescriptionRequired
schemasarray[string]URN schema for errors.
Allowed value:
urn:ietf:params:scim:api:messages:2.0:Error
yes
statusstringHTTP status codeyes
detailsstringmessage detailing the erroryes
scimTypestringtype of SCIM errorno

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Credentials
Header
Click Try It! to start a request and see the response here!