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
Object unspecific list filters like offset, limit and asc/desc.
offset uint64limit int64Maximum 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.
asc booleandefault is descending
queries object[]
Array [firstNameQuery object
firstName stringPossible values:
<= 200 characters
method stringPossible 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
lastName stringPossible values:
<= 200 characters
method stringPossible 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
email stringPossible values:
<= 200 characters
email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)
method stringPossible 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
userIdQuery object
userId stringPossible values:
<= 200 characters
the id of the user
]
Request Body required
query object
Object unspecific list filters like offset, limit and asc/desc.
offset uint64limit int64Maximum 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.
asc booleandefault is descending
queries object[]
Array [firstNameQuery object
firstName stringPossible values:
<= 200 characters
method stringPossible 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
lastName stringPossible values:
<= 200 characters
method stringPossible 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
email stringPossible values:
<= 200 characters
email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)
method stringPossible 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
userIdQuery object
userId stringPossible values:
<= 200 characters
the id of the user
]
Request Body required
query object
Object unspecific list filters like offset, limit and asc/desc.
offset uint64limit int64Maximum 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.
asc booleandefault is descending
queries object[]
Array [firstNameQuery object
firstName stringPossible values:
<= 200 characters
method stringPossible 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
lastName stringPossible values:
<= 200 characters
method stringPossible 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
email stringPossible values:
<= 200 characters
email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)
method stringPossible 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
userIdQuery object
userId stringPossible values:
<= 200 characters
the id of the user
]
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details object
totalResult uint64processedSequence uint64viewTimestamp date-timethe last time the view got updated
result object[]
Array [userId stringdetails object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs toroles string[]the role keys granted to the user
preferredLoginName stringpreferred login name of the user
email stringpreferred login name of the user
firstName stringthe first name of the user
lastName stringlast name of the user
displayName stringdisplay name of the user
avatarUrl stringavatar URL of the user
userType stringPossible values: [
TYPE_UNSPECIFIED
,TYPE_HUMAN
,TYPE_MACHINE
]Default value:
TYPE_UNSPECIFIED
type of the user (human / machine)
]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-02"
},
"result": [
{
"userId": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"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
totalResult uint64processedSequence uint64viewTimestamp date-timethe last time the view got updated
result object[]
Array [userId stringdetails object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs toroles string[]the role keys granted to the user
preferredLoginName stringpreferred login name of the user
email stringpreferred login name of the user
firstName stringthe first name of the user
lastName stringlast name of the user
displayName stringdisplay name of the user
avatarUrl stringavatar URL of the user
userType stringPossible values: [
TYPE_UNSPECIFIED
,TYPE_HUMAN
,TYPE_MACHINE
]Default value:
TYPE_UNSPECIFIED
type of the user (human / machine)
]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-02"
},
"result": [
{
"userId": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"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
totalResult uint64processedSequence uint64viewTimestamp date-timethe last time the view got updated
result object[]
Array [userId stringdetails object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs toroles string[]the role keys granted to the user
preferredLoginName stringpreferred login name of the user
email stringpreferred login name of the user
firstName stringthe first name of the user
lastName stringlast name of the user
displayName stringdisplay name of the user
avatarUrl stringavatar URL of the user
userType stringPossible values: [
TYPE_UNSPECIFIED
,TYPE_HUMAN
,TYPE_MACHINE
]Default value:
TYPE_UNSPECIFIED
type of the user (human / machine)
]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-02"
},
"result": [
{
"userId": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"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[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}