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
Header Parameters
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.
Request Body required
- 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
queries object[]
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
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
userIdQuery object
Possible values: <= 200 characters
the id of the user
Request Body required
- 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
queries object[]
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
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
userIdQuery object
Possible values: <= 200 characters
the id of the user
Request Body required
- 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
queries object[]
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
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
userIdQuery object
Possible values: <= 200 characters
the id of the user
- 200
- default
A successful response.
Schema
- Array [
- ]
details object
the last time the view got updated
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
the role keys granted to the user
preferred login name of the user
preferred login name of the user
the first name of the user
last name of the user
display name of the user
avatar URL of the user
Possible values: [TYPE_UNSPECIFIED
, TYPE_HUMAN
, TYPE_MACHINE
]
Default value: TYPE_UNSPECIFIED
type of the user (human / machine)
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-06-13T06:44:37.540Z"
},
"result": [
{
"userId": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.540Z",
"changeDate": "2024-06-13T06:44:37.540Z",
"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
- Array [
- ]
details object
the last time the view got updated
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
the role keys granted to the user
preferred login name of the user
preferred login name of the user
the first name of the user
last name of the user
display name of the user
avatar URL of the user
Possible values: [TYPE_UNSPECIFIED
, TYPE_HUMAN
, TYPE_MACHINE
]
Default value: TYPE_UNSPECIFIED
type of the user (human / machine)
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-06-13T06:44:37.540Z"
},
"result": [
{
"userId": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.540Z",
"changeDate": "2024-06-13T06:44:37.540Z",
"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
- Array [
- ]
details object
the last time the view got updated
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
the role keys granted to the user
preferred login name of the user
preferred login name of the user
the first name of the user
last name of the user
display name of the user
avatar URL of the user
Possible values: [TYPE_UNSPECIFIED
, TYPE_HUMAN
, TYPE_MACHINE
]
Default value: TYPE_UNSPECIFIED
type of the user (human / machine)
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-06-13T06:44:37.541Z"
},
"result": [
{
"userId": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.541Z",
"changeDate": "2024-06-13T06:44:37.541Z",
"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.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}