Search Users
POST/users/_search
Search for users within an organization. By default, we will return users of your organization. Make sure to include a limit and sorting for pagination.
Deprecated: please use user service v2 ListUsers
Request​
Header Parameters
The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data.
- application/json
- application/grpc
- application/grpc-web+proto
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
Possible values: <= 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
Possible values: <= 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
Possible values: <= 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
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
Possible values: <= 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
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
Possible values: [USER_STATE_UNSPECIFIED
, USER_STATE_ACTIVE
, USER_STATE_INACTIVE
, USER_STATE_DELETED
, USER_STATE_LOCKED
, USER_STATE_SUSPEND
, USER_STATE_INITIAL
]
Default value: USER_STATE_UNSPECIFIED
current state of the user
typeQuery
object
Possible values: [TYPE_UNSPECIFIED
, TYPE_HUMAN
, TYPE_MACHINE
]
Default value: TYPE_UNSPECIFIED
the type of the user
loginNameQuery
object
Possible values: <= 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
the ids of the users to include
orQuery
object
queries
object[]
the sub queries to 'OR'
andQuery
object
queries
object[]
the sub queries to 'AND'
notQuery
object
query
object
the sub query to negate (NOT)
inUserEmailsQuery
object
the emails of the users to include
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
Possible values: <= 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
Possible values: <= 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
Possible values: <= 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
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
Possible values: <= 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
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
Possible values: [USER_STATE_UNSPECIFIED
, USER_STATE_ACTIVE
, USER_STATE_INACTIVE
, USER_STATE_DELETED
, USER_STATE_LOCKED
, USER_STATE_SUSPEND
, USER_STATE_INITIAL
]
Default value: USER_STATE_UNSPECIFIED
current state of the user
typeQuery
object
Possible values: [TYPE_UNSPECIFIED
, TYPE_HUMAN
, TYPE_MACHINE
]
Default value: TYPE_UNSPECIFIED
the type of the user
loginNameQuery
object
Possible values: <= 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
the ids of the users to include
orQuery
object
queries
object[]
the sub queries to 'OR'
andQuery
object
queries
object[]
the sub queries to 'AND'
notQuery
object
query
object
the sub query to negate (NOT)
inUserEmailsQuery
object
the emails of the users to include
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
Possible values: <= 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
Possible values: <= 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
Possible values: <= 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
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
Possible values: <= 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
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
Possible values: [USER_STATE_UNSPECIFIED
, USER_STATE_ACTIVE
, USER_STATE_INACTIVE
, USER_STATE_DELETED
, USER_STATE_LOCKED
, USER_STATE_SUSPEND
, USER_STATE_INITIAL
]
Default value: USER_STATE_UNSPECIFIED
current state of the user
typeQuery
object
Possible values: [TYPE_UNSPECIFIED
, TYPE_HUMAN
, TYPE_MACHINE
]
Default value: TYPE_UNSPECIFIED
the type of the user
loginNameQuery
object
Possible values: <= 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
the ids of the users to include
orQuery
object
queries
object[]
the sub queries to 'OR'
andQuery
object
queries
object[]
the sub queries to 'AND'
notQuery
object
query
object
the sub query to negate (NOT)
inUserEmailsQuery
object
the emails of the users to include
Responses​
- 200
- 400
- default
A list of all users matching the query
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object
the last time the view 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[]
details
object
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 first event of the object
on create: 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
Possible values: [USER_STATE_UNSPECIFIED
, USER_STATE_ACTIVE
, USER_STATE_INACTIVE
, USER_STATE_DELETED
, USER_STATE_LOCKED
, USER_STATE_SUSPEND
, USER_STATE_INITIAL
]
Default value: USER_STATE_UNSPECIFIED
current state of the user
human
object
one of type use human or machine
profile
object
a user can set the display name, if nothing is set ZITADEL computes "first_name last_name"
language tag analog https://tools.ietf.org/html/rfc3066
Possible values: [GENDER_UNSPECIFIED
, GENDER_FEMALE
, GENDER_MALE
, GENDER_DIVERSE
]
Default value: GENDER_UNSPECIFIED
the gender of the human
avatar URL of the user
email
object
email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)
Is true if the user verified the email or if the email is managed outside ZITADEL
phone
object
mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)
Is true if the user verified the phone or if the phone is managed outside ZITADEL
The time the user last changed their password.
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",
"viewTimestamp": "2024-12-09T07:30:51.559Z"
},
"sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-12-09T07:30:51.559Z",
"changeDate": "2024-12-09T07:30:51.559Z",
"resourceOwner": "69629023906488334"
},
"state": "USER_STATE_UNSPECIFIED",
"userName": "gigi-giraffe",
"loginNames": [
"gigi@zitadel.com",
"gigi@zitadel.zitadel.ch"
],
"preferredLoginName": "gigi@zitadel.com",
"human": {
"profile": {
"firstName": "Gigi",
"lastName": "Giraffe",
"nickName": "gigi-giraffe",
"displayName": "Gigi Giraffe",
"preferredLanguage": "en",
"gender": "GENDER_UNSPECIFIED",
"avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
},
"email": {
"email": "gigi@zitadel.com",
"isEmailVerified": true
},
"phone": {
"phone": "+41 71 000 00 00",
"isPhoneVerified": true
},
"passwordChanged": "2024-12-09T07:30:51.560Z"
},
"machine": {
"name": "zitadel",
"description": "The one and only IAM",
"hasSecret": "true",
"accessTokenType": "ACCESS_TOKEN_TYPE_BEARER"
}
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object
the last time the view 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[]
details
object
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 first event of the object
on create: 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
Possible values: [USER_STATE_UNSPECIFIED
, USER_STATE_ACTIVE
, USER_STATE_INACTIVE
, USER_STATE_DELETED
, USER_STATE_LOCKED
, USER_STATE_SUSPEND
, USER_STATE_INITIAL
]
Default value: USER_STATE_UNSPECIFIED
current state of the user
human
object
one of type use human or machine
profile
object
a user can set the display name, if nothing is set ZITADEL computes "first_name last_name"
language tag analog https://tools.ietf.org/html/rfc3066
Possible values: [GENDER_UNSPECIFIED
, GENDER_FEMALE
, GENDER_MALE
, GENDER_DIVERSE
]
Default value: GENDER_UNSPECIFIED
the gender of the human
avatar URL of the user
email
object
email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)
Is true if the user verified the email or if the email is managed outside ZITADEL
phone
object
mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)
Is true if the user verified the phone or if the phone is managed outside ZITADEL
The time the user last changed their password.
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",
"viewTimestamp": "2024-12-09T07:30:51.562Z"
},
"sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-12-09T07:30:51.562Z",
"changeDate": "2024-12-09T07:30:51.562Z",
"resourceOwner": "69629023906488334"
},
"state": "USER_STATE_UNSPECIFIED",
"userName": "gigi-giraffe",
"loginNames": [
"gigi@zitadel.com",
"gigi@zitadel.zitadel.ch"
],
"preferredLoginName": "gigi@zitadel.com",
"human": {
"profile": {
"firstName": "Gigi",
"lastName": "Giraffe",
"nickName": "gigi-giraffe",
"displayName": "Gigi Giraffe",
"preferredLanguage": "en",
"gender": "GENDER_UNSPECIFIED",
"avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
},
"email": {
"email": "gigi@zitadel.com",
"isEmailVerified": true
},
"phone": {
"phone": "+41 71 000 00 00",
"isPhoneVerified": true
},
"passwordChanged": "2024-12-09T07:30:51.562Z"
},
"machine": {
"name": "zitadel",
"description": "The one and only IAM",
"hasSecret": "true",
"accessTokenType": "ACCESS_TOKEN_TYPE_BEARER"
}
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object
the last time the view 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[]
details
object
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 first event of the object
on create: 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
Possible values: [USER_STATE_UNSPECIFIED
, USER_STATE_ACTIVE
, USER_STATE_INACTIVE
, USER_STATE_DELETED
, USER_STATE_LOCKED
, USER_STATE_SUSPEND
, USER_STATE_INITIAL
]
Default value: USER_STATE_UNSPECIFIED
current state of the user
human
object
one of type use human or machine
profile
object
a user can set the display name, if nothing is set ZITADEL computes "first_name last_name"
language tag analog https://tools.ietf.org/html/rfc3066
Possible values: [GENDER_UNSPECIFIED
, GENDER_FEMALE
, GENDER_MALE
, GENDER_DIVERSE
]
Default value: GENDER_UNSPECIFIED
the gender of the human
avatar URL of the user
email
object
email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)
Is true if the user verified the email or if the email is managed outside ZITADEL
phone
object
mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)
Is true if the user verified the phone or if the phone is managed outside ZITADEL
The time the user last changed their password.
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",
"viewTimestamp": "2024-12-09T07:30:51.564Z"
},
"sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-12-09T07:30:51.564Z",
"changeDate": "2024-12-09T07:30:51.564Z",
"resourceOwner": "69629023906488334"
},
"state": "USER_STATE_UNSPECIFIED",
"userName": "gigi-giraffe",
"loginNames": [
"gigi@zitadel.com",
"gigi@zitadel.zitadel.ch"
],
"preferredLoginName": "gigi@zitadel.com",
"human": {
"profile": {
"firstName": "Gigi",
"lastName": "Giraffe",
"nickName": "gigi-giraffe",
"displayName": "Gigi Giraffe",
"preferredLanguage": "en",
"gender": "GENDER_UNSPECIFIED",
"avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
},
"email": {
"email": "gigi@zitadel.com",
"isEmailVerified": true
},
"phone": {
"phone": "+41 71 000 00 00",
"isPhoneVerified": true
},
"passwordChanged": "2024-12-09T07:30:51.564Z"
},
"machine": {
"name": "zitadel",
"description": "The one and only IAM",
"hasSecret": "true",
"accessTokenType": "ACCESS_TOKEN_TYPE_BEARER"
}
}
]
}
invalid list query
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}