Manage users programmatically

Learn how to automate user management tasks using the Davis Assistant API.

General requirements

A DESK Managed environment
A valid, enabled Davis Assistant API token with admin permissions
A system with network access to Davis Assistant on port 443

Note

User management in Davis Assistant is only supported for DESK Managed environments.

Authorization

All requests must include the Authorization header that includes a Davis Assistant API token.
Create a new Davis Assistant API token in the Davis Assistant API configuration settings (in Davis Assistant, go to Account settings > Integrations > Davis API).

Note

You must be an administrator of the active (selected) environment to access the Davis Assistant API configuration section. If the token is invalid, the API will return a 401 Unauthorized status code. If you're attempting to perform an action that requires administrative privileges for the active (selected) environment, and lack these privileges, the API will return a 403 Forbidden status code.

GET users

URL	https://assistant.desk.com/api/v2/tenant/users
Method	GET
Header	Authorization: api-token ${DAVIS API TOKEN}

Response format

Parameters Example

Element	Type	Description
firstName	string	User's first name
lastName	string	User's last name
email	string	User's email address
timezone	string	User's time zone in tzdata format
admin	boolean	User has administrative privileges.

Response body (Status code 200):

[
  {
    "firstName": "Test",
    "lastName": "One",
    "email": "test.one@desk.com",
    "timezone": "America/Detroit",
    "admin": true
  },
  {
    "firstName": "Test",
    "lastName": "Two",
    "email": "test.two@desk.com",
    "timezone": "America/Detroit",
    "admin": false
  }
]

POST user

URL	https://assistant.desk.com/api/v2/tenant/users/${EMAIL ADDRESS}
Method	POST
Header	Content-Type: application/json
Header	Authorization: api-token ${DAVIS API TOKEN}

Parameters

Parameters Example

Parameter	Description	Type	Required
firstName	User's first name	string	required
lastName	User's last name	string	required
email	User's email address	string	required
timezone	User's time zone in tzdata format	string	required
admin	User has administrative privileges.	boolean	required

Request body:

{
  "firstName": "Test",
  "lastName": "Three",
  "timezone": "America/Detroit",
  "email": "test.three@desk.com",
  "admin": true
}

Response format

Response body (Status code 201):

None

PUT user

URL	https://assistant.desk.com/api/v2/tenant/users/${EMAIL ADDRESS}
Method	PUT
Header	Content-Type: application/json
Header	Authorization: api-token ${DAVIS API TOKEN}

Parameters

Parameters Example

Parameter	Description	Type	Required
admin	User has administrative privileges	boolean	required

Request body:

{
  "admin": true
}

Response format

Response body (Status code 200):

{
  "message": "Successfully updated",
  "changes": [
    "Added admin permission"
  ]
}

DELETE user

URL	https://assistant.desk.com/api/v2/tenant/users/${EMAIL ADDRESS}
Method	PUT
Header	Content-Type: application/json
Header	Authorization: api-token ${DAVIS API TOKEN}

Response format

Response body (Status code 200):

{
  "message": "Successfully removed the user"
}