User Details

📘

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 Response - Schema

200 OK (user response)

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
no
idstringThe ID for the object. Immutable.yes
activebooleanthe user's administrative statusno
externalIdstringthe external ID for the userno
metaobjectUser metadata. "meta" subdivides into:

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

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. Required.

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. 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'.

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

401 (missing or invalid authorization), 404 (user not found)

SCIM-related error

ParameterTypeDescriptionRequired
schemasarray[string]URN schema for errors.
Allowed value:
urn:ietf:params:scim:api:messages:2.0:Error
no
statusstringHTTP status codeno
detailsstringmessage detailing the errorno
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
Authorization
Header
Click Try It! to start a request and see the response here!