Search Users
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.
Header Parameters
- x-zitadel-orgid string
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
Request Body required
query object
- sortingColumn the field the result is sorted
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[]
Request Body required
query object
- sortingColumn the field the result is sorted
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[]
Request Body required
query object
- sortingColumn the field the result is sorted
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[]
- 200
- 400
- default
A list of all users matching the query
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details object
- sortingColumn string
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": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-11"
},
"sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2023-05-11",
"changeDate": "2023-05-11",
"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
}
},
"machine": {
"name": "zitadel",
"description": "The one and only IAM",
"hasSecret": "true",
"accessTokenType": "ACCESS_TOKEN_TYPE_BEARER"
}
}
]
}
- Schema
- Example (from schema)
Schema
details object
- sortingColumn string
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": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-11"
},
"sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2023-05-11",
"changeDate": "2023-05-11",
"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
}
},
"machine": {
"name": "zitadel",
"description": "The one and only IAM",
"hasSecret": "true",
"accessTokenType": "ACCESS_TOKEN_TYPE_BEARER"
}
}
]
}
- Schema
- Example (from schema)
Schema
details object
- sortingColumn string
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": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-11"
},
"sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2023-05-11",
"changeDate": "2023-05-11",
"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
}
},
"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
- code int32
- message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
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
- code int32
- message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
POST /users/_search
Authorization
type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud
Request
Request
curl -L -X POST 'https://$ZITADEL_DOMAIN/management/v1/users/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
"queries": [
{
"userNameQuery": {
"userName": "gigi-giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"firstNameQuery": {
"firstName": "Gigi",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"lastNameQuery": {
"lastName": "Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"nickNameQuery": {
"nickName": "string",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"displayNameQuery": {
"displayName": "Gigi Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"emailQuery": {
"emailAddress": "gigi@zitadel.com",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"stateQuery": {
"state": "USER_STATE_UNSPECIFIED"
},
"typeQuery": {
"type": "TYPE_UNSPECIFIED"
},
"loginNameQuery": {
"loginName": "gigi@zitadel.cloud",
"method": "TEXT_QUERY_METHOD_EQUALS"
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/management/v1/users/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
"queries": [
{
"userNameQuery": {
"userName": "gigi-giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"firstNameQuery": {
"firstName": "Gigi",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"lastNameQuery": {
"lastName": "Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"nickNameQuery": {
"nickName": "string",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"displayNameQuery": {
"displayName": "Gigi Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"emailQuery": {
"emailAddress": "gigi@zitadel.com",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"stateQuery": {
"state": "USER_STATE_UNSPECIFIED"
},
"typeQuery": {
"type": "TYPE_UNSPECIFIED"
},
"loginNameQuery": {
"loginName": "gigi@zitadel.cloud",
"method": "TEXT_QUERY_METHOD_EQUALS"
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/management/v1/users/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
"queries": [
{
"userNameQuery": {
"userName": "gigi-giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"firstNameQuery": {
"firstName": "Gigi",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"lastNameQuery": {
"lastName": "Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"nickNameQuery": {
"nickName": "string",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"displayNameQuery": {
"displayName": "Gigi Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"emailQuery": {
"emailAddress": "gigi@zitadel.com",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"stateQuery": {
"state": "USER_STATE_UNSPECIFIED"
},
"typeQuery": {
"type": "TYPE_UNSPECIFIED"
},
"loginNameQuery": {
"loginName": "gigi@zitadel.cloud",
"method": "TEXT_QUERY_METHOD_EQUALS"
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/management/v1/users/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
"queries": [
{
"userNameQuery": {
"userName": "gigi-giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"firstNameQuery": {
"firstName": "Gigi",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"lastNameQuery": {
"lastName": "Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"nickNameQuery": {
"nickName": "string",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"displayNameQuery": {
"displayName": "Gigi Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"emailQuery": {
"emailAddress": "gigi@zitadel.com",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"stateQuery": {
"state": "USER_STATE_UNSPECIFIED"
},
"typeQuery": {
"type": "TYPE_UNSPECIFIED"
},
"loginNameQuery": {
"loginName": "gigi@zitadel.cloud",
"method": "TEXT_QUERY_METHOD_EQUALS"
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/management/v1/users/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
"queries": [
{
"userNameQuery": {
"userName": "gigi-giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"firstNameQuery": {
"firstName": "Gigi",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"lastNameQuery": {
"lastName": "Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"nickNameQuery": {
"nickName": "string",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"displayNameQuery": {
"displayName": "Gigi Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"emailQuery": {
"emailAddress": "gigi@zitadel.com",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"stateQuery": {
"state": "USER_STATE_UNSPECIFIED"
},
"typeQuery": {
"type": "TYPE_UNSPECIFIED"
},
"loginNameQuery": {
"loginName": "gigi@zitadel.cloud",
"method": "TEXT_QUERY_METHOD_EQUALS"
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/management/v1/users/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
"queries": [
{
"userNameQuery": {
"userName": "gigi-giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"firstNameQuery": {
"firstName": "Gigi",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"lastNameQuery": {
"lastName": "Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"nickNameQuery": {
"nickName": "string",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"displayNameQuery": {
"displayName": "Gigi Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"emailQuery": {
"emailAddress": "gigi@zitadel.com",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"stateQuery": {
"state": "USER_STATE_UNSPECIFIED"
},
"typeQuery": {
"type": "TYPE_UNSPECIFIED"
},
"loginNameQuery": {
"loginName": "gigi@zitadel.cloud",
"method": "TEXT_QUERY_METHOD_EQUALS"
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/management/v1/users/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
"queries": [
{
"userNameQuery": {
"userName": "gigi-giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"firstNameQuery": {
"firstName": "Gigi",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"lastNameQuery": {
"lastName": "Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"nickNameQuery": {
"nickName": "string",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"displayNameQuery": {
"displayName": "Gigi Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"emailQuery": {
"emailAddress": "gigi@zitadel.com",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"stateQuery": {
"state": "USER_STATE_UNSPECIFIED"
},
"typeQuery": {
"type": "TYPE_UNSPECIFIED"
},
"loginNameQuery": {
"loginName": "gigi@zitadel.cloud",
"method": "TEXT_QUERY_METHOD_EQUALS"
}
}
]
}'