get https://api.talkdeskapp.com/scim/v2/ServiceProviderConfig
Check the service provider configurations available in this instance
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
Represents the service provider's configuration
| Parameter | Type | Description | Required |
|---|---|---|---|
| schemas | array[string] | URN of the schemas for this document | yes |
| bulk | object | Displays bulk feature. "bulk" subdivides into: 1 - "supported" (boolean) - displays if feature is supported or not. Required. 2 - "maxOperations" (integer) - displays the maximum number of operations supported. Required. 3 - "maxPayloadSize" (integer) - displays the maximum payload size supported. Required. | yes |
| changePassword | object | Displays change password feature. "changePassword" subdivides into: "supported" (boolean) - displays if feature is supported or not. Required. | yes |
| documentationUrl | string | service provider's documentation | yes |
| etag | object | Displays ETag feature. "etag" subdivides into: "supported" (boolean) - displays if feature is supported or not. Required. | yes |
| filter | object | Displays filter feature. "filter" subdivides into: 1 - "supported" (boolean) - displays if feature is supported or not. Required. 2 - "maxResults" (integer) - default value for max results in pagination. Required. | yes |
| patch | object | Displays patch feature. "patch" subdivides into: "supported" (boolean) - displays if feature is supported or not. Required. | yes |
| sort | object | Displays sort feature. "sort" subdivides into: "supported" (boolean) - displays if feature is supported or not. Required. | yes |
| meta | object | Displays meta information. "meta" subdivides into: 1 - "resourceType" (string) - displays the resource type. Required. 2 - "location" (string) - displays the resource location. Required. | no |
401 (missing or invalid authorization), 403 (forbidden operation)
SCIM-related error
| Parameter | Type | Description | Required |
|---|---|---|---|
| schemas | array[string] | URN schema for errors. Allowed value: urn:ietf:params:scim:api:messages:2.0:Error | no |
| status | string | HTTP status code | no |
| detail | string | message detailing the error | no |
| scimType | string | type of SCIM error | no |
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.