Authentication
List people who can get a key
Lists the people a key can be issued for, which depends on the caller's role. Use it to populate a person picker before you issue a key.
Requires: desk.admin scope, workspace owner or admin.
Authorization
bearerAuth AuthorizationBearer <token>
A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.
In: header
Query Parameters
cursor?string
next_cursor from the previous page. Leave it out for the first page.
limit?integer
Page size: 100 by default, 100 at most.
Response
OK
Example
{ "data": [ { "user_id": "ba7d8e12-8a4f-478d-9d10-86689fa3b682", "name": "Amina Wanjiru", "role": "agent", "scopes": [ "example" ] } ], "next_cursor": "eyJvIjoyNX0", "has_more": false, "you": { "user_id": "ba7d8e12-8a4f-478d-9d10-86689fa3b682", "name": "Amina Wanjiru", "role": "agent", "scopes": [ "example" ] }}FieldTypeDescription
datarequiredobject[]user_idrequiredstringThe id of the person.namerequiredstringA name for it.rolerequiredstringThe role: admin, agent or viewer.scopesrequiredstring[]The most the key may do: a list of desk.read, desk.write, desk.supervise and desk.admin.next_cursorrequiredstring | nullhas_morerequiredbooleanyourequiredanyuser_idrequiredstringThe id of the person.namerequiredstringA name for it.rolerequiredstringThe role: admin, agent or viewer.scopesrequiredstring[]The most the key may do: a list of desk.read, desk.write, desk.supervise and desk.admin.curl -X GET "https://api.sautidesk.com/v1/desk/api-keys/people"