Get all users

GET
/api/users

Query Parameters

page
number

Page Number

size
number

Page Size

filter
string

Value by which the users needs to be filtered.

sort
string

Value in 'sort_key:sort_order' format, by which results will be sorted. Sort order value can be '1' for ascending and '-1' for descending. Acceptable sort key values are 'given_name', 'middle_name', 'family_name', 'name', 'creation_time', and 'last_updated'

Authentication

X-API-KEY
header
Required

Api key needed to access the endpoints. X-API-KEY: Your_API_Key

Headers

accept
string
  • application/json
  • application/problem+json

Responses

200
OK
400
Bad Request
401
Unauthorized
403
Forbidden

Request Example

Request
curl -X GET "https://<your-domain>/api/users?page=1&size=10&filter=bob&sort=given_name:1" \
 -H "X-API-KEY: <your-api-key>" \
 -H "Accept: application/json"

Response Example

Response
200 OK
[
  {
"emails": [
{
"authenticators": [ "password", "email"
], "verified": true, "id": "6cec8047-6149-4d9b-8d99-91c83c22a9dc", "email": "user@example.com", "primary": false,
"idps": [ "monocloud", "google"
]
}
], "creation_time": 1640975400,
"phone_numbers": [
{ "phone": "+441514960453",
"authenticators": [ "password", "phone"
], "verified": true, "id": "ab66b6a2-df6b-4f9d-9eb2-5a7142984e70", "primary": false,
"idps": [ "monocloud", "google"
]
}
], "last_updated": 1640975400, "password_updated_at": 1640975400, "user_id": "UOtBaOybB6dTpIJNrnkRw",
"claims": { "name": "John Doe", "given_name": "John", "family_name": "Doe"
}, "disabled": true,
"idps": [
{ "provider_user_id": "79a500f9-aba6-4f03-baec-c18f4b7136ad", "authenticator": "google"
}
],
"username": {
"authenticators": [ "password"
], "id": "9082b772-dbf6-4610-a71e-05fb93c0ab73",
"idps": [ "monocloud", "google"
], "username": "username"
}, "has_password": true } ]