Skip to main content
GET
List users

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

statuses
string[]

User statuses to include (e.g. ACTIVE, DISABLED). Defaults to all statuses.

query
string
required

Search text matched against user name and email.

search-type
enum<string>
default:ALL

Which user fields the query is matched against. Defaults to ALL.

Available options:
ALL,
EMAIL,
NAME,
USER_ID
filter
enum<string>
default:ALL_SOURCES

Filter users by account source (e.g. SCIM). Defaults to ALL_SOURCES.

Available options:
RISK_CLOUD,
IDENTITY_PROVIDER,
ALL_SOURCES
pageable
object
required

Response

OK

totalElements
integer<int64>
totalPages
integer<int32>
first
boolean
last
boolean
numberOfElements
integer<int32>
pageable
object
sort
object
size
integer<int32>
content
object[]

Entity for storing all information pertaining to a user.

number
integer<int32>
empty
boolean