Query users based on criteria
POST/user/query
Query users based on criteria
Request
Header Parameters
- application/json
Body
Array [
]
Array [
]
Array [
]
Array [
]
realmPredicate
object
pathPredicate
object
select
object
usernames
object[]
Possible values: [EXACT, BEGIN, END, CONTAINS]
attributes
object[]
name
object
Possible values: [EXACT, BEGIN, END, CONTAINS]
value
object
Possible values: [EXACT, BEGIN, END, CONTAINS]
clientRoles
object[]
Possible values: [EXACT, BEGIN, END, CONTAINS]
realmRoles
object[]
Possible values: [EXACT, BEGIN, END, CONTAINS]
orderBy
object
Possible values: [CREATED_ON, FIRST_NAME, LAST_NAME, USERNAME, EMAIL]
Responses
- default
default response
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
attributes
object
property name*
string[]
string
Possible values: >= 3 characters and <= 255 characters, Value must match regular expression ^(?=[\p{IsLatin}|\p{IsCommon}]+$)(?=[^<>&"'\s\v\h$%!#?§,;:*~/\\|^=\[\]{}()\p{Cntrl}]+$).*$`
[
{
"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"
}
]