Search Users​
Search for users. By default, we will return users of your organization. Make sure to include a limit and sorting for pagination.
Request Body required
- Array [
- Array [
- ]
- Array [
- ]
- ]
query object
Object unspecific list filters like offset, limit and asc/desc.
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: [USER_FIELD_NAME_UNSPECIFIED
, USER_FIELD_NAME_USER_NAME
, USER_FIELD_NAME_FIRST_NAME
, USER_FIELD_NAME_LAST_NAME
, USER_FIELD_NAME_NICK_NAME
, USER_FIELD_NAME_DISPLAY_NAME
, USER_FIELD_NAME_EMAIL
, USER_FIELD_NAME_STATE
, USER_FIELD_NAME_TYPE
, USER_FIELD_NAME_CREATION_DATE
]
Default value: USER_FIELD_NAME_UNSPECIFIED
queries object[]
userNameQuery object
Query for users with a specific user name.
Possible values: non-empty
and <= 200 characters
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 equality method is used
firstNameQuery object
Query for users with a specific first name.
Possible values: non-empty
and <= 200 characters
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 equality method is used
lastNameQuery object
Query for users with a specific last name.
Possible values: non-empty
and <= 200 characters
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 equality method is used
nickNameQuery object
Query for users with a specific nickname.
Possible values: non-empty
and <= 200 characters
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 equality method is used
displayNameQuery object
Query for users with a specific display name.
Possible values: non-empty
and <= 200 characters
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 equality method is used
emailQuery object
Query for users with a specific email.
Possible values: <= 200 characters
email address of the user
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 equality method is used
stateQuery object
Query for users with a specific state.
Possible values: [USER_STATE_UNSPECIFIED
, USER_STATE_ACTIVE
, USER_STATE_INACTIVE
, USER_STATE_DELETED
, USER_STATE_LOCKED
, USER_STATE_INITIAL
]
Default value: USER_STATE_UNSPECIFIED
current state of the user
typeQuery object
Query for users with a specific type.
Possible values: [TYPE_UNSPECIFIED
, TYPE_HUMAN
, TYPE_MACHINE
]
Default value: TYPE_UNSPECIFIED
the type of the user
loginNameQuery object
Query for users with a specific state.
Possible values: non-empty
and <= 200 characters
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 equality method is used
inUserIdsQuery object
Query for users with ID in list of IDs.
the ids of the users to include
orQuery object
Connect multiple sub-condition with and OR operator.
queries object[]
the sub queries to 'OR'
andQuery object
Connect multiple sub-condition with and AND operator.
queries object[]
the sub queries to 'AND'
notQuery object
Negate the sub-condition.
query object
the sub query to negate (NOT)
inUserEmailsQuery object
Query for users with email in list of emails.
the emails of the users to include
organizationIdQuery object
Query for users under a specific organization as resource owner.
Possible values: non-empty
and <= 200 characters
Request Body required
- Array [
- Array [
- ]
- Array [
- ]
- ]
query object
Object unspecific list filters like offset, limit and asc/desc.
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: [USER_FIELD_NAME_UNSPECIFIED
, USER_FIELD_NAME_USER_NAME
, USER_FIELD_NAME_FIRST_NAME
, USER_FIELD_NAME_LAST_NAME
, USER_FIELD_NAME_NICK_NAME
, USER_FIELD_NAME_DISPLAY_NAME
, USER_FIELD_NAME_EMAIL
, USER_FIELD_NAME_STATE
, USER_FIELD_NAME_TYPE
, USER_FIELD_NAME_CREATION_DATE
]
Default value: USER_FIELD_NAME_UNSPECIFIED
queries object[]
userNameQuery object
Query for users with a specific user name.
Possible values: non-empty
and <= 200 characters
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 equality method is used
firstNameQuery object
Query for users with a specific first name.
Possible values: non-empty
and <= 200 characters
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 equality method is used
lastNameQuery object
Query for users with a specific last name.
Possible values: non-empty
and <= 200 characters
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 equality method is used
nickNameQuery object
Query for users with a specific nickname.
Possible values: non-empty
and <= 200 characters
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 equality method is used
displayNameQuery object
Query for users with a specific display name.
Possible values: non-empty
and <= 200 characters
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 equality method is used
emailQuery object
Query for users with a specific email.
Possible values: <= 200 characters
email address of the user
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 equality method is used
stateQuery object
Query for users with a specific state.
Possible values: [USER_STATE_UNSPECIFIED
, USER_STATE_ACTIVE
, USER_STATE_INACTIVE
, USER_STATE_DELETED
, USER_STATE_LOCKED
, USER_STATE_INITIAL
]
Default value: USER_STATE_UNSPECIFIED
current state of the user
typeQuery object
Query for users with a specific type.
Possible values: [TYPE_UNSPECIFIED
, TYPE_HUMAN
, TYPE_MACHINE
]
Default value: TYPE_UNSPECIFIED
the type of the user
loginNameQuery object
Query for users with a specific state.
Possible values: non-empty
and <= 200 characters
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 equality method is used
inUserIdsQuery object
Query for users with ID in list of IDs.
the ids of the users to include
orQuery object
Connect multiple sub-condition with and OR operator.
queries object[]
the sub queries to 'OR'
andQuery object
Connect multiple sub-condition with and AND operator.
queries object[]
the sub queries to 'AND'
notQuery object
Negate the sub-condition.
query object
the sub query to negate (NOT)
inUserEmailsQuery object
Query for users with email in list of emails.
the emails of the users to include
organizationIdQuery object
Query for users under a specific organization as resource owner.
Possible values: non-empty
and <= 200 characters
Request Body required
- Array [
- Array [
- ]
- Array [
- ]
- ]
query object
Object unspecific list filters like offset, limit and asc/desc.
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: [USER_FIELD_NAME_UNSPECIFIED
, USER_FIELD_NAME_USER_NAME
, USER_FIELD_NAME_FIRST_NAME
, USER_FIELD_NAME_LAST_NAME
, USER_FIELD_NAME_NICK_NAME
, USER_FIELD_NAME_DISPLAY_NAME
, USER_FIELD_NAME_EMAIL
, USER_FIELD_NAME_STATE
, USER_FIELD_NAME_TYPE
, USER_FIELD_NAME_CREATION_DATE
]
Default value: USER_FIELD_NAME_UNSPECIFIED
queries object[]
userNameQuery object
Query for users with a specific user name.
Possible values: non-empty
and <= 200 characters
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 equality method is used
firstNameQuery object
Query for users with a specific first name.
Possible values: non-empty
and <= 200 characters
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 equality method is used
lastNameQuery object
Query for users with a specific last name.
Possible values: non-empty
and <= 200 characters
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 equality method is used
nickNameQuery object
Query for users with a specific nickname.
Possible values: non-empty
and <= 200 characters
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 equality method is used
displayNameQuery object
Query for users with a specific display name.
Possible values: non-empty
and <= 200 characters
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 equality method is used
emailQuery object
Query for users with a specific email.
Possible values: <= 200 characters
email address of the user
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 equality method is used
stateQuery object
Query for users with a specific state.
Possible values: [USER_STATE_UNSPECIFIED
, USER_STATE_ACTIVE
, USER_STATE_INACTIVE
, USER_STATE_DELETED
, USER_STATE_LOCKED
, USER_STATE_INITIAL
]
Default value: USER_STATE_UNSPECIFIED
current state of the user
typeQuery object
Query for users with a specific type.
Possible values: [TYPE_UNSPECIFIED
, TYPE_HUMAN
, TYPE_MACHINE
]
Default value: TYPE_UNSPECIFIED
the type of the user
loginNameQuery object
Query for users with a specific state.
Possible values: non-empty
and <= 200 characters
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 equality method is used
inUserIdsQuery object
Query for users with ID in list of IDs.
the ids of the users to include
orQuery object
Connect multiple sub-condition with and OR operator.
queries object[]
the sub queries to 'OR'
andQuery object
Connect multiple sub-condition with and AND operator.
queries object[]
the sub queries to 'AND'
notQuery object
Negate the sub-condition.
query object
the sub query to negate (NOT)
inUserEmailsQuery object
Query for users with email in list of emails.
the emails of the users to include
organizationIdQuery object
Query for users under a specific organization as resource owner.
Possible values: non-empty
and <= 200 characters
- 200
- 400
- 403
- 404
- default
A list of all users matching the query
Schema
- Array [
- ]
details object
the last time the projection got updated
Possible values: [USER_FIELD_NAME_UNSPECIFIED
, USER_FIELD_NAME_USER_NAME
, USER_FIELD_NAME_FIRST_NAME
, USER_FIELD_NAME_LAST_NAME
, USER_FIELD_NAME_NICK_NAME
, USER_FIELD_NAME_DISPLAY_NAME
, USER_FIELD_NAME_EMAIL
, USER_FIELD_NAME_STATE
, USER_FIELD_NAME_TYPE
, USER_FIELD_NAME_CREATION_DATE
]
Default value: USER_FIELD_NAME_UNSPECIFIED
result object[]
Possible values: [USER_STATE_UNSPECIFIED
, USER_STATE_ACTIVE
, USER_STATE_INACTIVE
, USER_STATE_DELETED
, USER_STATE_LOCKED
, USER_STATE_INITIAL
]
Default value: USER_STATE_UNSPECIFIED
current state of the user
human object
one of type use human or machine
Unique identifier of the user.
Possible values: [USER_STATE_UNSPECIFIED
, USER_STATE_ACTIVE
, USER_STATE_INACTIVE
, USER_STATE_DELETED
, USER_STATE_LOCKED
, USER_STATE_INITIAL
]
Default value: USER_STATE_UNSPECIFIED
current state of the user
Username of the user, which can be globally unique or unique on organization level.
Possible usable login names for the user.
Preferred login name of the user.
profile object
Profile information of the user.
Possible values: non-empty
and <= 200 characters
Possible values: non-empty
and <= 200 characters
Possible values: <= 200 characters
Possible values: <= 200 characters
Possible values: <= 10 characters
Possible values: [GENDER_UNSPECIFIED
, GENDER_FEMALE
, GENDER_MALE
, GENDER_DIVERSE
]
Default value: GENDER_UNSPECIFIED
avatar URL of the user
email object
Email of the user, if defined.
Possible values: non-empty
and <= 200 characters
phone object
Phone of the user, if defined.
Possible values: <= 200 characters
User is required to change the used password on the next login.
machine object
one of type use human or machine
Possible values: [ACCESS_TOKEN_TYPE_BEARER
, ACCESS_TOKEN_TYPE_JWT
]
Default value: ACCESS_TOKEN_TYPE_BEARER
Type of access token to receive
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"timestamp": "2024-06-13T06:44:35.801Z"
},
"sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
"result": [
{
"userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
"state": "USER_STATE_UNSPECIFIED",
"username": "minnie-mouse",
"loginNames": [
"gigi@zitadel.com",
"gigi@zitadel.zitadel.ch"
],
"preferredLoginName": "gigi@zitadel.com",
"human": {
"userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
"state": "USER_STATE_UNSPECIFIED",
"username": "minnie-mouse",
"loginNames": [
"gigi@zitadel.com",
"gigi@zitadel.zitadel.ch"
],
"preferredLoginName": "gigi@zitadel.com",
"profile": {
"givenName": "Minnie",
"familyName": "Mouse",
"nickName": "Mini",
"displayName": "Minnie Mouse",
"preferredLanguage": "en",
"gender": "GENDER_FEMALE",
"avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
},
"email": {
"email": "mini@mouse.com",
"isVerified": true
},
"phone": {
"phone": "+41791234567",
"isVerified": true
},
"passwordChangeRequired": true
},
"machine": {
"name": "zitadel",
"description": "The one and only IAM",
"hasSecret": "true",
"accessTokenType": "ACCESS_TOKEN_TYPE_BEARER"
}
}
]
}
Schema
- Array [
- ]
details object
the last time the projection got updated
Possible values: [USER_FIELD_NAME_UNSPECIFIED
, USER_FIELD_NAME_USER_NAME
, USER_FIELD_NAME_FIRST_NAME
, USER_FIELD_NAME_LAST_NAME
, USER_FIELD_NAME_NICK_NAME
, USER_FIELD_NAME_DISPLAY_NAME
, USER_FIELD_NAME_EMAIL
, USER_FIELD_NAME_STATE
, USER_FIELD_NAME_TYPE
, USER_FIELD_NAME_CREATION_DATE
]
Default value: USER_FIELD_NAME_UNSPECIFIED
result object[]
Possible values: [USER_STATE_UNSPECIFIED
, USER_STATE_ACTIVE
, USER_STATE_INACTIVE
, USER_STATE_DELETED
, USER_STATE_LOCKED
, USER_STATE_INITIAL
]
Default value: USER_STATE_UNSPECIFIED
current state of the user
human object
one of type use human or machine
Unique identifier of the user.
Possible values: [USER_STATE_UNSPECIFIED
, USER_STATE_ACTIVE
, USER_STATE_INACTIVE
, USER_STATE_DELETED
, USER_STATE_LOCKED
, USER_STATE_INITIAL
]
Default value: USER_STATE_UNSPECIFIED
current state of the user
Username of the user, which can be globally unique or unique on organization level.
Possible usable login names for the user.
Preferred login name of the user.
profile object
Profile information of the user.
Possible values: non-empty
and <= 200 characters
Possible values: non-empty
and <= 200 characters
Possible values: <= 200 characters
Possible values: <= 200 characters
Possible values: <= 10 characters
Possible values: [GENDER_UNSPECIFIED
, GENDER_FEMALE
, GENDER_MALE
, GENDER_DIVERSE
]
Default value: GENDER_UNSPECIFIED
avatar URL of the user
email object
Email of the user, if defined.
Possible values: non-empty
and <= 200 characters
phone object
Phone of the user, if defined.
Possible values: <= 200 characters
User is required to change the used password on the next login.
machine object
one of type use human or machine
Possible values: [ACCESS_TOKEN_TYPE_BEARER
, ACCESS_TOKEN_TYPE_JWT
]
Default value: ACCESS_TOKEN_TYPE_BEARER
Type of access token to receive
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"timestamp": "2024-06-13T06:44:35.802Z"
},
"sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
"result": [
{
"userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
"state": "USER_STATE_UNSPECIFIED",
"username": "minnie-mouse",
"loginNames": [
"gigi@zitadel.com",
"gigi@zitadel.zitadel.ch"
],
"preferredLoginName": "gigi@zitadel.com",
"human": {
"userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
"state": "USER_STATE_UNSPECIFIED",
"username": "minnie-mouse",
"loginNames": [
"gigi@zitadel.com",
"gigi@zitadel.zitadel.ch"
],
"preferredLoginName": "gigi@zitadel.com",
"profile": {
"givenName": "Minnie",
"familyName": "Mouse",
"nickName": "Mini",
"displayName": "Minnie Mouse",
"preferredLanguage": "en",
"gender": "GENDER_FEMALE",
"avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
},
"email": {
"email": "mini@mouse.com",
"isVerified": true
},
"phone": {
"phone": "+41791234567",
"isVerified": true
},
"passwordChangeRequired": true
},
"machine": {
"name": "zitadel",
"description": "The one and only IAM",
"hasSecret": "true",
"accessTokenType": "ACCESS_TOKEN_TYPE_BEARER"
}
}
]
}
Schema
- Array [
- ]
details object
the last time the projection got updated
Possible values: [USER_FIELD_NAME_UNSPECIFIED
, USER_FIELD_NAME_USER_NAME
, USER_FIELD_NAME_FIRST_NAME
, USER_FIELD_NAME_LAST_NAME
, USER_FIELD_NAME_NICK_NAME
, USER_FIELD_NAME_DISPLAY_NAME
, USER_FIELD_NAME_EMAIL
, USER_FIELD_NAME_STATE
, USER_FIELD_NAME_TYPE
, USER_FIELD_NAME_CREATION_DATE
]
Default value: USER_FIELD_NAME_UNSPECIFIED
result object[]
Possible values: [USER_STATE_UNSPECIFIED
, USER_STATE_ACTIVE
, USER_STATE_INACTIVE
, USER_STATE_DELETED
, USER_STATE_LOCKED
, USER_STATE_INITIAL
]
Default value: USER_STATE_UNSPECIFIED
current state of the user
human object
one of type use human or machine
Unique identifier of the user.
Possible values: [USER_STATE_UNSPECIFIED
, USER_STATE_ACTIVE
, USER_STATE_INACTIVE
, USER_STATE_DELETED
, USER_STATE_LOCKED
, USER_STATE_INITIAL
]
Default value: USER_STATE_UNSPECIFIED
current state of the user
Username of the user, which can be globally unique or unique on organization level.
Possible usable login names for the user.
Preferred login name of the user.
profile object
Profile information of the user.
Possible values: non-empty
and <= 200 characters
Possible values: non-empty
and <= 200 characters
Possible values: <= 200 characters
Possible values: <= 200 characters
Possible values: <= 10 characters
Possible values: [GENDER_UNSPECIFIED
, GENDER_FEMALE
, GENDER_MALE
, GENDER_DIVERSE
]
Default value: GENDER_UNSPECIFIED
avatar URL of the user
email object
Email of the user, if defined.
Possible values: non-empty
and <= 200 characters
phone object
Phone of the user, if defined.
Possible values: <= 200 characters
User is required to change the used password on the next login.
machine object
one of type use human or machine
Possible values: [ACCESS_TOKEN_TYPE_BEARER
, ACCESS_TOKEN_TYPE_JWT
]
Default value: ACCESS_TOKEN_TYPE_BEARER
Type of access token to receive
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"timestamp": "2024-06-13T06:44:35.802Z"
},
"sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
"result": [
{
"userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
"state": "USER_STATE_UNSPECIFIED",
"username": "minnie-mouse",
"loginNames": [
"gigi@zitadel.com",
"gigi@zitadel.zitadel.ch"
],
"preferredLoginName": "gigi@zitadel.com",
"human": {
"userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
"state": "USER_STATE_UNSPECIFIED",
"username": "minnie-mouse",
"loginNames": [
"gigi@zitadel.com",
"gigi@zitadel.zitadel.ch"
],
"preferredLoginName": "gigi@zitadel.com",
"profile": {
"givenName": "Minnie",
"familyName": "Mouse",
"nickName": "Mini",
"displayName": "Minnie Mouse",
"preferredLanguage": "en",
"gender": "GENDER_FEMALE",
"avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
},
"email": {
"email": "mini@mouse.com",
"isVerified": true
},
"phone": {
"phone": "+41791234567",
"isVerified": true
},
"passwordChangeRequired": true
},
"machine": {
"name": "zitadel",
"description": "The one and only IAM",
"hasSecret": "true",
"accessTokenType": "ACCESS_TOKEN_TYPE_BEARER"
}
}
]
}
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"
}
]
}