post https://api.talkdeskapp.com/scim/v2/Users
Creates new user in authenticated account
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
201 (user response)
User entity
| Parameter | Type | Description | Required |
|---|---|---|---|
| schemas | array[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 |
| id | string | The ID for the object. Immutable. | yes |
| active | boolean | the user's administrative status | no |
| externalId | string | the external ID for the user | no |
| meta | object | User 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 |
| name | object | The 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 |
| userName | string | The user's email. | yes |
| urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User | object | The 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 |
400 (bad request), 401 (missing or invalid authorization), 403 (forbidden operation), 409 (conflict with user)
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 |
| details | 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.