List users
List users in the organization.
List users in the organization.
ApiKeyAuthAuthorizationBearer <token>Bearer token authentication. Send an API key (a saai_api_-prefixed token) as Authorization: Bearer <token>.
Required permission
view_usersoffset?integerNumber of items to skip before returning results.
int320 <= value0limit?integerMaximum number of items to return per page.
int320 <= value <= 25610search?stringFree-text search term to filter results by name.
length <= 255sort_by?stringField to sort users by.
"created_at""created_at""display_name""email"sort_order?stringDirection to sort results.
"desc""asc""desc"group?array<string>Filter to users belonging to any of these groups (by group name).
group_not?array<string>Exclude users belonging to any of these groups.
group_match?stringWhether group requires any of the values (default) or all of them.
"any""all"seen_in?array<>Filter to users the gateway has observed in any of these places.
seen_in_not?array<>Exclude users the gateway has observed in any of these places.
seen_in_match?stringWhether seen_in requires any of the values (default) or all of them.
"any""all"role_id?array<>Filter to users holding any of these roles.
role_id_not?array<>Exclude users holding any of these roles.
role_id_match?stringWhether role_id requires any of the values (default) or all of them.
"any""all"The request has succeeded.
application/json- response
A page of results together with its paging information.
items*array<>The items in this page.
meta*Paging information for a list response.
curl -X GET "https://example.com/users"{ "items": [ { "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" } ], "meta": { "total": 0, "offset": 0, "limit": 0 }}