API ReferenceUsers

Get users

Returns a stream of users, filtered according to query parameters.

Authentication

AuthorizationBearer

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

Path parameters

realmstringRequired

Query parameters

briefRepresentationbooleanOptional

Boolean which defines whether brief representations are returned (default: false)

emailstringOptional
A String contained in email, or the complete email, if param "exact" is true
emailVerifiedbooleanOptional
whether the email has been verified
enabledbooleanOptional
Boolean representing if user is enabled or not
exactbooleanOptional
Boolean which defines whether the params "last", "first", "email" and "username" must match exactly
firstintegerOptional
Pagination offset
firstNamestringOptional
A String contained in firstName, or the complete firstName, if param "exact" is true
idpAliasstringOptional
The alias of an Identity Provider linked to the user
idpUserIdstringOptional
The userId at an Identity Provider linked to the user
lastNamestringOptional
A String contained in lastName, or the complete lastName, if param "exact" is true
maxintegerOptional

Maximum results size (defaults to 100)

qstringOptional

A query to search for custom attributes, in the format ‘key1:value2 key2:value2’

searchstringOptional

A String contained in username, first or last name, or email. Default search behavior is prefix-based (e.g., foo or foo*). Use foo for infix search and “foo” for exact search.

usernamestringOptional
A String contained in username, or the complete username, if param "exact" is true

Response

OK
organizationslist of strings
idstring
usernamestring
firstNamestring
lastNamestring
emailstring
emailVerifiedboolean
attributesmap from strings to lists of strings
userProfileMetadataobject
enabledboolean
selfstring
originstring
createdTimestamplong
totpboolean
serviceAccountClientIdstring
credentialslist of objects
disableableCredentialTypeslist of strings
requiredActionslist of strings
federatedIdentitieslist of objects
realmRoleslist of strings
clientRolesmap from strings to lists of strings
clientConsentslist of objects
notBeforeinteger
groupslist of strings
accessmap from strings to booleans
applicationRolesmap from strings to lists of stringsDeprecated