Get users

Gets a list of users for an account.

application/json

Body

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

null

total_count

number

optional

Total results available without any search parameters

Example:

null

result

required

Any of

allOf {2}

array[object (Cloudflare Client API_users) {11}]

allOf {2}

One of

array[object (Cloudflare Client API_users) {11}]

object

access_seat

boolean

schemas-access_seat

optional

True if the user has authenticated with Cloudflare Access.

Example:

false

active_device_count

number

active_device_count

optional

The number of active devices registered to the user.

Example:

created_at

string <date-time>

timestamp

read-onlyoptional

Example:

2014-01-01T05:20:00.12345Z

string <email>

components-schemas-email

optional

The email of the user.

Example:

jdoe@example.com

gateway_seat

boolean

schemas-gateway_seat

optional

True if the user has logged into the WARP client.

Example:

false

users_components-schemas-id

optional

The ID of the user.

Example:

f3b12456-80dd-4e89-9f5f-ba3dfff12365

last_successful_login

string <date-time>

last_successful_login

optional

The time at which the user last successfully logged in.

Example:

2020-07-01T05:20:00Z

name

string

users_components-schemas-name

optional

The name of the user.

Example:

Jane Doe

seat_uid

optional

The unique API identifier for the Zero Trust seat.

uid

optional

The unique API identifier for the user.

updated_at

string <date-time>

timestamp

read-onlyoptional

Example:

2014-01-01T05:20:00.12345Z

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "access_seat": false,
            "active_device_count": 2,
            "created_at": "2014-01-01T05:20:00.12345Z",
            "email": "jdoe@example.com",
            "gateway_seat": false,
            "id": "f3b12456-80dd-4e89-9f5f-ba3dfff12365",
            "last_successful_login": "2020-07-01T05:20:00Z",
            "name": "Jane Doe",
            "seat_uid": null,
            "uid": null,
            "updated_at": "2014-01-01T05:20:00.12345Z"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 100,
        "total_count": 1
    }
}

Request

Request samples

Responses