APIUsers

Get user

Get a single user by id.

GET
/users/{user_id}

Get a single user by id.

Authorization

ApiKeyAuth
headerAuthorizationBearer <token>

Bearer token authentication. Send an API key (a saai_api_-prefixed token) as Authorization: Bearer <token>.

Required permission

view_users

Path Parameters

user_id*string
Formatuuid

Response Body

The request has succeeded.

application/json
  1. response

A person in your organization who signs in and whom agents act on behalf of.

id*uuid
Formatuuid
display_name*string

The user's name as shown in the workspace.

email*string

The user's email address.

groups*array<string>

Names of the groups the user belongs to.

seen_in*array<>

Where the gateway has observed this person. Set by the system; never edited.

roles*array<>

The roles this person holds.

created_at*string
Formatdate-time
curl -X GET "https://example.com/users/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "display_name": "string",  "email": "string",  "groups": [    "string"  ],  "seen_in": [    "gateway"  ],  "roles": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "system": true    }  ],  "created_at": "2019-08-24T14:15:22Z"}