List IAM Members​
Members are users with permission to administrate ZITADEL on different levels. This request returns all users with memberships on the instance level, matching the search queries. The search queries will be AND linked.
application/json
application/grpc
application/grpc-web+proto
Request Body required
query object
queries object[]
Request Body required
query object
queries object[]
Request Body required
query object
queries object[]
Responses
- 200
- 403
- 404
- default
members of the IAM
application/json
application/grpc
application/grpc-web+proto
Schema
Example (from schema)
Schema
details object
result object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-03-27T10:05:52.891Z"
},
"result": [
{
"userId": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-03-27T10:05:52.891Z",
"changeDate": "2024-03-27T10:05:52.891Z",
"resourceOwner": "69629023906488334"
},
"roles": [
"IAM_OWNER"
],
"preferredLoginName": "gigi@zitadel.com",
"email": "gigi@zitadel.com",
"firstName": "Gigi",
"lastName": "Giraffe",
"displayName": "Gigi Giraffe",
"avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32",
"userType": "TYPE_UNSPECIFIED"
}
]
}
Schema
Example (from schema)
Schema
details object
result object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-03-27T10:05:52.891Z"
},
"result": [
{
"userId": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-03-27T10:05:52.891Z",
"changeDate": "2024-03-27T10:05:52.891Z",
"resourceOwner": "69629023906488334"
},
"roles": [
"IAM_OWNER"
],
"preferredLoginName": "gigi@zitadel.com",
"email": "gigi@zitadel.com",
"firstName": "Gigi",
"lastName": "Giraffe",
"displayName": "Gigi Giraffe",
"avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32",
"userType": "TYPE_UNSPECIFIED"
}
]
}
Schema
Example (from schema)
Schema
details object
result object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-03-27T10:05:52.891Z"
},
"result": [
{
"userId": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-03-27T10:05:52.892Z",
"changeDate": "2024-03-27T10:05:52.892Z",
"resourceOwner": "69629023906488334"
},
"roles": [
"IAM_OWNER"
],
"preferredLoginName": "gigi@zitadel.com",
"email": "gigi@zitadel.com",
"firstName": "Gigi",
"lastName": "Giraffe",
"displayName": "Gigi Giraffe",
"avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32",
"userType": "TYPE_UNSPECIFIED"
}
]
}
Returned when the user does not have permission to access the resource.
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"
}
]
}
Returned when the resource does not exist.
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 /members/_search
Authorization
name: OAuth2type: oauth2scopes:openid,urn:zitadel:iam:org:project:id:zitadel:aud
flows: { "authorizationCode": { "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize", "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token", "scopes": { "openid": "openid", "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud" } } }
Request
Request
curl / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/members/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"firstNameQuery": {
"firstName": "Gigi",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"lastNameQuery": {
"lastName": "Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"emailQuery": {
"email": "gigi@zitadel.com",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"userIdQuery": {
"userId": "69629023906488334"
}
}
]
}'
python / requests
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/members/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"firstNameQuery": {
"firstName": "Gigi",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"lastNameQuery": {
"lastName": "Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"emailQuery": {
"email": "gigi@zitadel.com",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"userIdQuery": {
"userId": "69629023906488334"
}
}
]
}'
go / native
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/members/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"firstNameQuery": {
"firstName": "Gigi",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"lastNameQuery": {
"lastName": "Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"emailQuery": {
"email": "gigi@zitadel.com",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"userIdQuery": {
"userId": "69629023906488334"
}
}
]
}'
nodejs / axios
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/members/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"firstNameQuery": {
"firstName": "Gigi",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"lastNameQuery": {
"lastName": "Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"emailQuery": {
"email": "gigi@zitadel.com",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"userIdQuery": {
"userId": "69629023906488334"
}
}
]
}'
ruby / Net::HTTP
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/members/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"firstNameQuery": {
"firstName": "Gigi",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"lastNameQuery": {
"lastName": "Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"emailQuery": {
"email": "gigi@zitadel.com",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"userIdQuery": {
"userId": "69629023906488334"
}
}
]
}'
csharp / RestSharp
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/members/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"firstNameQuery": {
"firstName": "Gigi",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"lastNameQuery": {
"lastName": "Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"emailQuery": {
"email": "gigi@zitadel.com",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"userIdQuery": {
"userId": "69629023906488334"
}
}
]
}'
php / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/members/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"firstNameQuery": {
"firstName": "Gigi",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"lastNameQuery": {
"lastName": "Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"emailQuery": {
"email": "gigi@zitadel.com",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"userIdQuery": {
"userId": "69629023906488334"
}
}
]
}'
java / OkHttp
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/members/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"firstNameQuery": {
"firstName": "Gigi",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"lastNameQuery": {
"lastName": "Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"emailQuery": {
"email": "gigi@zitadel.com",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"userIdQuery": {
"userId": "69629023906488334"
}
}
]
}'
powershell / RestMethod
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/members/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"queries": [
{
"firstNameQuery": {
"firstName": "Gigi",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"lastNameQuery": {
"lastName": "Giraffe",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"emailQuery": {
"email": "gigi@zitadel.com",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"userIdQuery": {
"userId": "69629023906488334"
}
}
]
}'