Skip to main content
GET
Error

Authorizations

x-cdata-authtoken
string
header
required

A Sync user auth token. Generate one via POST /v2/users/generate-token.

Query Parameters

filter
string

Filter expression applied to the collection, on endpoints that support filtering. Filters on resource fields such as id and name.

sort
string

Sort expression applied to the collection, on endpoints that support sorting (e.g. a field name optionally followed by a direction).

Response

One or more users

id
string
user
string

Username.

email_address
string
is_active
boolean
roles
object[]
sso_enabled
boolean
mfa_enabled
boolean
api_enabled
boolean
auth_token_created_at
string<date-time>
auth_token_expires_in
integer

Seconds until token expiry.

created_at
string<date-time>
updated_at
string<date-time>