List user schemas​
List 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 Body required
- Array [
- Array [
- ]
- Array [
- ]
- ]
query object
list limitations and ordering.
Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.
default is descending
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_TYPE
, FIELD_NAME_STATE
, FIELD_NAME_REVISION
, FIELD_NAME_CHANGE_DATE
]
Default value: FIELD_NAME_UNSPECIFIED
the field the result is sorted.
queries object[]
Define the criteria to query for.
orQuery object
Union the results of each sub query ('OR').
queries object[]
andQuery 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 andQuery in combination with orQuery and notQuery.
queries object[]
notQuery object
Exclude / Negate the result of the sub query ('NOT').
query object
typeQuery object
Limit the result to a specific schema type.
Possible values: <= 200 characters
Defines which type to query for.
Possible values: [TEXT_QUERY_METHOD_EQUALS
, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE
, TEXT_QUERY_METHOD_STARTS_WITH
, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE
, TEXT_QUERY_METHOD_CONTAINS
, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE
, TEXT_QUERY_METHOD_ENDS_WITH
, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE
]
Default value: TEXT_QUERY_METHOD_EQUALS
Defines which text comparison method used for the type query.
stateQuery object
Limit the result to a specific state of the schema.
Possible values: [STATE_UNSPECIFIED
, STATE_ACTIVE
, STATE_INACTIVE
]
Default value: STATE_UNSPECIFIED
Defines the state to query for.
idQuery object
Limit the result to a specific schema ID.
Possible values: non-empty
and <= 200 characters
Defines the ID of the user schema to query for.
Possible values: [TEXT_QUERY_METHOD_EQUALS
, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE
, TEXT_QUERY_METHOD_STARTS_WITH
, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE
, TEXT_QUERY_METHOD_CONTAINS
, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE
, TEXT_QUERY_METHOD_ENDS_WITH
, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE
]
Default value: TEXT_QUERY_METHOD_EQUALS
Defines which text comparison method used for the id query.
Request Body required
- Array [
- Array [
- ]
- Array [
- ]
- ]
query object
list limitations and ordering.
Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.
default is descending
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_TYPE
, FIELD_NAME_STATE
, FIELD_NAME_REVISION
, FIELD_NAME_CHANGE_DATE
]
Default value: FIELD_NAME_UNSPECIFIED
the field the result is sorted.
queries object[]
Define the criteria to query for.
orQuery object
Union the results of each sub query ('OR').
queries object[]
andQuery 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 andQuery in combination with orQuery and notQuery.
queries object[]
notQuery object
Exclude / Negate the result of the sub query ('NOT').
query object
typeQuery object
Limit the result to a specific schema type.
Possible values: <= 200 characters
Defines which type to query for.
Possible values: [TEXT_QUERY_METHOD_EQUALS
, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE
, TEXT_QUERY_METHOD_STARTS_WITH
, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE
, TEXT_QUERY_METHOD_CONTAINS
, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE
, TEXT_QUERY_METHOD_ENDS_WITH
, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE
]
Default value: TEXT_QUERY_METHOD_EQUALS
Defines which text comparison method used for the type query.
stateQuery object
Limit the result to a specific state of the schema.
Possible values: [STATE_UNSPECIFIED
, STATE_ACTIVE
, STATE_INACTIVE
]
Default value: STATE_UNSPECIFIED
Defines the state to query for.
idQuery object
Limit the result to a specific schema ID.
Possible values: non-empty
and <= 200 characters
Defines the ID of the user schema to query for.
Possible values: [TEXT_QUERY_METHOD_EQUALS
, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE
, TEXT_QUERY_METHOD_STARTS_WITH
, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE
, TEXT_QUERY_METHOD_CONTAINS
, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE
, TEXT_QUERY_METHOD_ENDS_WITH
, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE
]
Default value: TEXT_QUERY_METHOD_EQUALS
Defines which text comparison method used for the id query.
Request Body required
- Array [
- Array [
- ]
- Array [
- ]
- ]
query object
list limitations and ordering.
Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.
default is descending
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_TYPE
, FIELD_NAME_STATE
, FIELD_NAME_REVISION
, FIELD_NAME_CHANGE_DATE
]
Default value: FIELD_NAME_UNSPECIFIED
the field the result is sorted.
queries object[]
Define the criteria to query for.
orQuery object
Union the results of each sub query ('OR').
queries object[]
andQuery 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 andQuery in combination with orQuery and notQuery.
queries object[]
notQuery object
Exclude / Negate the result of the sub query ('NOT').
query object
typeQuery object
Limit the result to a specific schema type.
Possible values: <= 200 characters
Defines which type to query for.
Possible values: [TEXT_QUERY_METHOD_EQUALS
, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE
, TEXT_QUERY_METHOD_STARTS_WITH
, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE
, TEXT_QUERY_METHOD_CONTAINS
, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE
, TEXT_QUERY_METHOD_ENDS_WITH
, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE
]
Default value: TEXT_QUERY_METHOD_EQUALS
Defines which text comparison method used for the type query.
stateQuery object
Limit the result to a specific state of the schema.
Possible values: [STATE_UNSPECIFIED
, STATE_ACTIVE
, STATE_INACTIVE
]
Default value: STATE_UNSPECIFIED
Defines the state to query for.
idQuery object
Limit the result to a specific schema ID.
Possible values: non-empty
and <= 200 characters
Defines the ID of the user schema to query for.
Possible values: [TEXT_QUERY_METHOD_EQUALS
, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE
, TEXT_QUERY_METHOD_STARTS_WITH
, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE
, TEXT_QUERY_METHOD_CONTAINS
, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE
, TEXT_QUERY_METHOD_ENDS_WITH
, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE
]
Default value: TEXT_QUERY_METHOD_EQUALS
Defines which text comparison method used for the id query.
- 200
- 400
- 403
- 404
- default
A list of all user schema matching the query
Schema
- Array [
- ]
details object
Details provides information about the returned result including total amount found.
the last time the projection got updated
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_TYPE
, FIELD_NAME_STATE
, FIELD_NAME_REVISION
, FIELD_NAME_CHANGE_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.
ID is the read-only unique identifier of the schema.
details object
Details provide some base information (such as the last change date) of the schema.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Type is a human readable text describing the schema.
Possible values: [STATE_UNSPECIFIED
, STATE_ACTIVE
, STATE_INACTIVE
]
Default value: STATE_UNSPECIFIED
Current state of the schema.
Revision is a read only version of the schema, each update of the schema
-field increases the revision.
JSON schema representation defining the user.
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. This allows creating different user types like human/machine without usage of actions to validate possible authenticators. Removal of an authenticator does not remove the authenticator on a user.
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"timestamp": "2024-06-13T06:44:35.980Z"
},
"sortingColumn": "FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629012906488334",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.980Z",
"resourceOwner": "69629023906488334"
},
"type": "employees",
"state": "STATE_ACTIVE",
"revision": "2",
"schema": {
"$schema": "https://example.com/user/employees",
"type": "object",
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string"
}
}
},
"possibleAuthenticators": [
"AUTHENTICATOR_TYPE_USERNAME",
"AUTHENTICATOR_TYPE_PASSWORD",
"AUTHENTICATOR_TYPE_WEBAUTHN"
]
}
]
}
Schema
- Array [
- ]
details object
Details provides information about the returned result including total amount found.
the last time the projection got updated
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_TYPE
, FIELD_NAME_STATE
, FIELD_NAME_REVISION
, FIELD_NAME_CHANGE_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.
ID is the read-only unique identifier of the schema.
details object
Details provide some base information (such as the last change date) of the schema.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Type is a human readable text describing the schema.
Possible values: [STATE_UNSPECIFIED
, STATE_ACTIVE
, STATE_INACTIVE
]
Default value: STATE_UNSPECIFIED
Current state of the schema.
Revision is a read only version of the schema, each update of the schema
-field increases the revision.
JSON schema representation defining the user.
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. This allows creating different user types like human/machine without usage of actions to validate possible authenticators. Removal of an authenticator does not remove the authenticator on a user.
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"timestamp": "2024-06-13T06:44:35.981Z"
},
"sortingColumn": "FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629012906488334",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.981Z",
"resourceOwner": "69629023906488334"
},
"type": "employees",
"state": "STATE_ACTIVE",
"revision": "2",
"schema": {
"$schema": "https://example.com/user/employees",
"type": "object",
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string"
}
}
},
"possibleAuthenticators": [
"AUTHENTICATOR_TYPE_USERNAME",
"AUTHENTICATOR_TYPE_PASSWORD",
"AUTHENTICATOR_TYPE_WEBAUTHN"
]
}
]
}
Schema
- Array [
- ]
details object
Details provides information about the returned result including total amount found.
the last time the projection got updated
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_TYPE
, FIELD_NAME_STATE
, FIELD_NAME_REVISION
, FIELD_NAME_CHANGE_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.
ID is the read-only unique identifier of the schema.
details object
Details provide some base information (such as the last change date) of the schema.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Type is a human readable text describing the schema.
Possible values: [STATE_UNSPECIFIED
, STATE_ACTIVE
, STATE_INACTIVE
]
Default value: STATE_UNSPECIFIED
Current state of the schema.
Revision is a read only version of the schema, each update of the schema
-field increases the revision.
JSON schema representation defining the user.
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. This allows creating different user types like human/machine without usage of actions to validate possible authenticators. Removal of an authenticator does not remove the authenticator on a user.
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"timestamp": "2024-06-13T06:44:35.981Z"
},
"sortingColumn": "FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629012906488334",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.981Z",
"resourceOwner": "69629023906488334"
},
"type": "employees",
"state": "STATE_ACTIVE",
"revision": "2",
"schema": {
"$schema": "https://example.com/user/employees",
"type": "object",
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string"
}
}
},
"possibleAuthenticators": [
"AUTHENTICATOR_TYPE_USERNAME",
"AUTHENTICATOR_TYPE_PASSWORD",
"AUTHENTICATOR_TYPE_WEBAUTHN"
]
}
]
}
invalid list query
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the user does not have permission to access the resource.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}