List My Authorizations/Grants
Returns a list of the organizations where the authenticated user has any authorizations/user grants. The request is made in the context of the requested project. This request can be used in multi-tenancy applications to show the user a tenant switcher.
- 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 [nameQuery object
name stringmethod 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
domainQuery object
domain stringmethod 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
stateQuery object
state stringPossible values: [
ORG_STATE_UNSPECIFIED
,ORG_STATE_ACTIVE
,ORG_STATE_INACTIVE
,ORG_STATE_REMOVED
]Default value:
ORG_STATE_UNSPECIFIED
current state of the organization
]
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 [nameQuery object
name stringmethod 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
domainQuery object
domain stringmethod 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
stateQuery object
state stringPossible values: [
ORG_STATE_UNSPECIFIED
,ORG_STATE_ACTIVE
,ORG_STATE_INACTIVE
,ORG_STATE_REMOVED
]Default value:
ORG_STATE_UNSPECIFIED
current state of the organization
]
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 [nameQuery object
name stringmethod 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
domainQuery object
domain stringmethod 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
stateQuery object
state stringPossible values: [
ORG_STATE_UNSPECIFIED
,ORG_STATE_ACTIVE
,ORG_STATE_INACTIVE
,ORG_STATE_REMOVED
]Default value:
ORG_STATE_UNSPECIFIED
current state of the organization
]
- 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 [id 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 tostate stringPossible values: [
ORG_STATE_UNSPECIFIED
,ORG_STATE_ACTIVE
,ORG_STATE_INACTIVE
,ORG_STATE_REMOVED
]Default value:
ORG_STATE_UNSPECIFIED
current state of the organization
name stringprimaryDomain string]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-10"
},
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2023-05-10",
"changeDate": "2023-05-10",
"resourceOwner": "69629023906488334"
},
"state": "ORG_STATE_UNSPECIFIED",
"name": "ZITADEL",
"primaryDomain": "zitadel.cloud"
}
]
}
- Schema
- Example (from schema)
Schema
details object
totalResult uint64processedSequence uint64viewTimestamp date-timethe last time the view got updated
result object[]
Array [id 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 tostate stringPossible values: [
ORG_STATE_UNSPECIFIED
,ORG_STATE_ACTIVE
,ORG_STATE_INACTIVE
,ORG_STATE_REMOVED
]Default value:
ORG_STATE_UNSPECIFIED
current state of the organization
name stringprimaryDomain string]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-10"
},
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2023-05-10",
"changeDate": "2023-05-10",
"resourceOwner": "69629023906488334"
},
"state": "ORG_STATE_UNSPECIFIED",
"name": "ZITADEL",
"primaryDomain": "zitadel.cloud"
}
]
}
- Schema
- Example (from schema)
Schema
details object
totalResult uint64processedSequence uint64viewTimestamp date-timethe last time the view got updated
result object[]
Array [id 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 tostate stringPossible values: [
ORG_STATE_UNSPECIFIED
,ORG_STATE_ACTIVE
,ORG_STATE_INACTIVE
,ORG_STATE_REMOVED
]Default value:
ORG_STATE_UNSPECIFIED
current state of the organization
name stringprimaryDomain string]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-10"
},
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2023-05-10",
"changeDate": "2023-05-10",
"resourceOwner": "69629023906488334"
},
"state": "ORG_STATE_UNSPECIFIED",
"name": "ZITADEL",
"primaryDomain": "zitadel.cloud"
}
]
}
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"
}
]
}