List Project Members
Members are users with permission to administrate ZITADEL on different levels. This request returns all users with memberships on the project level, matching the search queries. The search queries will be AND linked.
Path Parameters
- projectId string required
Header Parameters
- x-zitadel-orgid string
The default is always the organization of the requesting user. If you like to get/set a result 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
queries object[]
Request Body required
query object
queries object[]
Request Body required
query object
queries object[]
Responses
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details object
result object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-12"
},
"result": [
{
"userId": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2023-05-12",
"changeDate": "2023-05-12",
"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": "2023-05-12"
},
"result": [
{
"userId": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2023-05-12",
"changeDate": "2023-05-12",
"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": "2023-05-12"
},
"result": [
{
"userId": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2023-05-12",
"changeDate": "2023-05-12",
"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"
}
]
}
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 /projects/:projectId/members/_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/projects/:projectId/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"
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/management/v1/projects/:projectId/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"
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/management/v1/projects/:projectId/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"
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/management/v1/projects/:projectId/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"
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/management/v1/projects/:projectId/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"
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/management/v1/projects/:projectId/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"
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/management/v1/projects/:projectId/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"
}
}
]
}'