Query users based on criteria

POST 
/user/query

Query users based on criteria

Request

Header Parameters

Authorization string
X-Forwarded-Proto string
X-Forwarded-Host string

application/json

Body

realmPredicate

object

namestring
assetsstring[]

pathPredicate

object

pathstring[]
idsstring[]

select

object

basicboolean

usernames

object[]

Array [

matchstring

Possible values: [EXACT, BEGIN, END, CONTAINS]

caseSensitiveboolean

valuestring

negateboolean

]

attributes

object[]

Array [

negatedboolean

name

object

matchstring

Possible values: [EXACT, BEGIN, END, CONTAINS]

caseSensitiveboolean

valuestring

negateboolean

value

object

matchstring

Possible values: [EXACT, BEGIN, END, CONTAINS]

caseSensitiveboolean

valuestring

negateboolean

]

clientRoles

object[]

Array [

matchstring

Possible values: [EXACT, BEGIN, END, CONTAINS]

caseSensitiveboolean

valuestring

negateboolean

]

realmRoles

object[]

Array [

matchstring

Possible values: [EXACT, BEGIN, END, CONTAINS]

caseSensitiveboolean

valuestring

negateboolean

]

serviceUsersboolean
limitint32
offsetint32

orderBy

object

propertystring

Possible values: [CREATED_ON, FIRST_NAME, LAST_NAME, USERNAME, EMAIL]

descendingboolean

Responses

default

default response

application/json

Schema

Schema

• Array [

realmstring
realmIdstring
idstring
firstNamestring
lastNamestring
emailstring
enabledboolean
createdOndate-time
secretstring

attributes

object

property name*

string[]

Array [

string

]

serviceAccountboolean
usernamestring

Possible values: >= 3 characters and <= 255 characters, Value must match regular expression [A-Za-z0-9\-_@.]+

• ]

Example (from schema)

[
  {
    "realm": "string",
    "realmId": "string",
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "enabled": true,
    "createdOn": "2024-07-29T15:51:28.071Z",
    "secret": "string",
    "attributes": {},
    "serviceAccount": true,
    "username": "string"
  }
]