Skip to main content

Search user schemas

POST 
/resources/v3alpha/user_schemas/_search

Search all matching user schemas. By default, we will return all user schema of your instance. Make sure to include a limit and sorting for pagination.

Request​

Query Parameters

    instance.id string
    instance.domain string
    query.offset uint64
    query.limit int64

    Maximum amount of events returned. If not configured otherwise, the default is 100, the maximum is 1000. If the limit exceeds the maximum, ZITADEL throws an error.

    query.desc boolean

    default is ascending, because together with the creation date sorting column, this returns the most deterministic pagination results.

    sortingColumn string

    Possible values: [FIELD_NAME_UNSPECIFIED, FIELD_NAME_TYPE, FIELD_NAME_STATE, FIELD_NAME_REVISION, FIELD_NAME_CHANGE_DATE, FIELD_NAME_CREATION_DATE]

    Default value: FIELD_NAME_UNSPECIFIED

    The field the result is sorted by. The default is the creation date. Beware that if you change this, your result pagination might be inconsistent.

Body

required

Define the criteria to filter for.

  • Array [

    • orFilter

    object

    Union the results of each sub filter ('OR').

    queries

    object[]

  • Array [

    • 0
    1
    2
    3
    4
    5
    6
    7
    8
    9

  • ]

    • andFilter

    object

    Limit the result to match all sub queries ('AND'). Note that if you specify multiple queries, they will be implicitly used as andQueries. Use the andFilter in combination with orFilter and notFilter.

    queries

    object[]

  • Array [

    • 0
    1
    2
    3
    4
    5
    6
    7
    8
    9

  • ]

    • notFilter

    object

    Exclude / Negate the result of the sub filter ('NOT').

    filter

    object

    0
    1
    2
    3
    4
    5
    6
    7
    8
    9

    typeFilter

    object

    Limit the result to a specific schema type.

    type stringrequired

    Possible values: <= 200 characters

    Defines which type to filter for.

    method string

    Possible values: [TEXT_FILTER_METHOD_EQUALS, TEXT_FILTER_METHOD_EQUALS_IGNORE_CASE, TEXT_FILTER_METHOD_STARTS_WITH, TEXT_FILTER_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_FILTER_METHOD_CONTAINS]

    Default value: TEXT_FILTER_METHOD_EQUALS

    Defines which text comparison method used for the type filter.

    stateFilter

    object

    Limit the result to a specific state of the schema.

    state stringrequired

    Possible values: [STATE_UNSPECIFIED, STATE_ACTIVE, STATE_INACTIVE]

    Default value: STATE_UNSPECIFIED

    Defines the state to filter for.

    idFilter

    object

    Limit the result to a specific schema ID.

    id stringrequired

    Possible values: non-empty and <= 200 characters

    Defines the ID of the user schema to filter for.

    method string

    Possible values: [TEXT_FILTER_METHOD_EQUALS, TEXT_FILTER_METHOD_EQUALS_IGNORE_CASE, TEXT_FILTER_METHOD_STARTS_WITH, TEXT_FILTER_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_FILTER_METHOD_CONTAINS]

    Default value: TEXT_FILTER_METHOD_EQUALS

    Defines which text comparison method used for the id filter.

  • ]

Responses​

A list of all user schema matching the search

Schema

    details

    object

    Details provides information about the returned result including total amount found.

    appliedLimit uint64
    totalResult uint64
    timestamp date-time

    the last time the projection got updated

    sortingColumn string

    Possible values: [FIELD_NAME_UNSPECIFIED, FIELD_NAME_TYPE, FIELD_NAME_STATE, FIELD_NAME_REVISION, FIELD_NAME_CHANGE_DATE, FIELD_NAME_CREATION_DATE]

    Default value: FIELD_NAME_UNSPECIFIED

    States by which field the results are sorted.

    result

    object[]

    The result contains the user schemas, which matched the queries.

  • Array [

    • details

    object

    Details provide some base information (such as the last change date) of the schema.

    id string
    created date-time

    the timestamp of the first event applied to the object.

    changed date-time

    the timestamp of the last event applied to the object.

    owner

    object

    the parent object representing the returned objects context.

    type string

    Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

    Default value: OWNER_TYPE_UNSPECIFIED

    id string

    config

    object

    type stringrequired

    Possible values: non-empty and <= 200 characters

    Type is a human readable word describing the schema.

    schema objectrequired

    JSON schema representation defining the user.

    possibleAuthenticators string[]

    Possible values: [AUTHENTICATOR_TYPE_UNSPECIFIED, AUTHENTICATOR_TYPE_USERNAME, AUTHENTICATOR_TYPE_PASSWORD, AUTHENTICATOR_TYPE_WEBAUTHN, AUTHENTICATOR_TYPE_TOTP, AUTHENTICATOR_TYPE_OTP_EMAIL, AUTHENTICATOR_TYPE_OTP_SMS, AUTHENTICATOR_TYPE_AUTHENTICATION_KEY, AUTHENTICATOR_TYPE_IDENTITY_PROVIDER]

    Defines the possible types of authenticators.

    state string

    Possible values: [STATE_UNSPECIFIED, STATE_ACTIVE, STATE_INACTIVE]

    Default value: STATE_UNSPECIFIED

    Current state of the schema.

    revision int64

    Revision is a read only version of the schema, each update of the schema-field increases the revision.

  • ]

Loading...