UserQuery

Composable identity-provider user search request. Populated restrictions are combined, except role arrays which match any supplied role.

assetsstring[]

Match users linked to any of these asset identifiers.

attributes object[]

Attribute predicates combined with AND.

Array [

name object

String matcher supporting exact, prefix, suffix, or contains matching, case sensitivity, and negation.

caseSensitiveboolean

matchstring

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

negateboolean

valuestring

negatedboolean

Invert this attribute predicate.

Example: false

value object

String matcher supporting exact, prefix, suffix, or contains matching, case sensitivity, and negation.

caseSensitiveboolean

matchstring

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

negateboolean

valuestring

]

clientRoles object[]

Array [

caseSensitiveboolean

matchstring

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

negateboolean

valuestring

]

idsstring[]

Match these exact identity-provider user identifiers.

limitinteger<int32>

Maximum number of results.

Example: 100

offsetinteger<int32>

Number of matching results to skip.

Example: 0

orderBy object

User result ordering.

descendingboolean

Reverse the default ascending order.

Example: false

propertystring

User property used for ordering.

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

Example: USERNAME

pathPredicate object

Matches an asset ancestry path represented as ordered asset identifiers.

pathstring[]

Ordered asset identifiers in the ancestry path.

realmPredicate object

Matches an exact realm name.

namestring

Realm name.

Example: building

realmRoles object[]

Array [

caseSensitiveboolean

matchstring

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

negateboolean

valuestring

]

select object

User response projection.

basicboolean

Return basic identity fields only, omitting administrative details.

Example: true

serviceUsersbooleannullable

True selects service users, false selects human users, null includes both.

usernames object[]

Array [

caseSensitiveboolean

matchstring

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

negateboolean

valuestring

]

UserQuery

{
  "assets": [
    "string"
  ],
  "attributes": [
    {
      "name": {
        "caseSensitive": true,
        "match": "EXACT",
        "negate": true,
        "value": "string"
      },
      "negated": false,
      "value": {
        "caseSensitive": true,
        "match": "EXACT",
        "negate": true,
        "value": "string"
      }
    }
  ],
  "clientRoles": [
    {
      "caseSensitive": true,
      "match": "EXACT",
      "negate": true,
      "value": "string"
    }
  ],
  "ids": [
    "string"
  ],
  "limit": 100,
  "offset": 0,
  "orderBy": {
    "descending": false,
    "property": "USERNAME"
  },
  "pathPredicate": {
    "path": [
      "string"
    ]
  },
  "realmPredicate": {
    "name": "building"
  },
  "realmRoles": [
    {
      "caseSensitive": true,
      "match": "EXACT",
      "negate": true,
      "value": "string"
    }
  ],
  "select": {
    "basic": true
  },
  "serviceUsers": true,
  "usernames": [
    {
      "caseSensitive": true,
      "match": "EXACT",
      "negate": true,
      "value": "string"
    }
  ]
}