Service Provider's Resource Types

Check the service provider available resource types

📘

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 (the request has succeeded)

ParameterTypeDescriptionRequired
schemasarray[string]related URNs of the resource type of the responseno
totalResultsintegernumber of resource types presentno
resourcesarray[object]Resource types supported. "resources" subdivides into:

1 - "schemas" (array[string]) - related URNs of the resource type. Required.

2 - "description" (string) - the resource's description, e.g.: Access User Resources. Required.

3 - "endpoint" (string) - the relative endpoint to obtain the resource, e.g.: /scim/v2/Users. Required.

4 - "id" (string) - the resource's id, e.g.: "User". Required.

5 - "name" (string) - the resource's name, e.g. "User". Required.

6 - "schema" (string) - the resource's associated schema, e.g.: urn:ietf:params:scim:schemas:core:2.0:User. Required.

7 - "meta" (object) - type and location of resource type.
7.1 - "resourceType" - resource's type. Required.
7.2 - "location" - URL of resource schema of the resource, e.g.: https://api.talkdeskapp.com/scim/v2/ResourceTypes/User. Required.
no
startIndexintegerthe 1-based index of the first result in the current set of list resultsno
itemsPerPageintegerthe number of resources returned in a list response pageno

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