User Resource Type

Check the user resource type

📘

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

Describes the attributes and metadata constituting a resource such as a user.

ParameterTypeDescriptionRequired
schemasarray[string]related URNs of the resource typeyes
descriptionstringthe resource's description, e.g.: access user resourcesyes
endpointstringthe relative endpoint to obtain the resource, e.g.: /scim/v2/Usersyes
idstringthe resource's ID, e.g.: "User"yes
namestringthe resource's name, e.g.: "User"yes
schemastringthe resource's associated schema, e.g.: urn:ietf:params:scim:schemas:core:2.0:Useryes
metaobjectType and location of resource type. "meta" subdivides into:

1 - "resourceType" - resource's type. Required.

2 - "location" - URL of resource schema of the resource, e.g.: https://api.talkdeskapp.com/scim/v2/ResourceTypes/User. Required.
no

401 (missing or invalid authorization), 403 (forbidden operation)

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
detailstringmessage 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
Credentials
Header
Click Try It! to start a request and see the response here!