Skip to main content

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

Body

    realmPredicate

    object

    name string
    assets string[]

    pathPredicate

    object

    path string[]
    ids string[]

    select

    object

    basic boolean

    usernames

    object[]

  • Array [

  • match string

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

    caseSensitive boolean
    value string
    negate boolean
  • ]

  • attributes

    object[]

  • Array [

  • negated boolean

    name

    object

    match string

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

    caseSensitive boolean
    value string
    negate boolean

    value

    object

    match string

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

    caseSensitive boolean
    value string
    negate boolean
  • ]

  • clientRoles

    object[]

  • Array [

  • match string

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

    caseSensitive boolean
    value string
    negate boolean
  • ]

  • realmRoles

    object[]

  • Array [

  • match string

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

    caseSensitive boolean
    value string
    negate boolean
  • ]

  • serviceUsers boolean
    limit int32
    offset int32

    orderBy

    object

    property string

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

    descending boolean

Responses

default response

Schema

  • Array [

  • realm string
    realmId string
    id string
    firstName string
    lastName string
    email string
    enabled boolean
    createdOn date-time
    secret string

    attributes

    object

    property name*

    string[]

  • Array [

  • string

  • ]

  • serviceAccount boolean
    username string

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

  • ]

Loading...