Search Project Grants from Project​
Returns a list of project grants for a specific project. A project grant is when the organization grants its project to another organization.
Path Parameters
Header Parameters
The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting 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[]
projectNameQuery object
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
roleKeyQuery object
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
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[]
projectNameQuery object
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
roleKeyQuery object
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
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[]
projectNameQuery object
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
roleKeyQuery object
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
- 200
- default
A successful response.
Schema
- Array [
- ]
details object
the last time the view got updated
result object[]
Possible values: [PROJECT_GRANT_STATE_UNSPECIFIED
, PROJECT_GRANT_STATE_ACTIVE
, PROJECT_GRANT_STATE_INACTIVE
]
Default value: PROJECT_GRANT_STATE_UNSPECIFIED
current state of the project grant
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
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-06-13T06:44:37.583Z"
},
"result": [
{
"grantId": "69629023906488334",
"grantedOrgId": "69629023906488334",
"grantedOrgName": "Some Organization",
"grantedRoleKeys": [
"role.super.man"
],
"state": "PROJECT_GRANT_STATE_UNSPECIFIED",
"projectId": "69629023906488334",
"projectName": "ZITADEL",
"projectOwnerId": "69629023906488334",
"projectOwnerName": "ZITADEL",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.583Z",
"changeDate": "2024-06-13T06:44:37.583Z",
"resourceOwner": "69629023906488334"
}
}
]
}
Schema
- Array [
- ]
details object
the last time the view got updated
result object[]
Possible values: [PROJECT_GRANT_STATE_UNSPECIFIED
, PROJECT_GRANT_STATE_ACTIVE
, PROJECT_GRANT_STATE_INACTIVE
]
Default value: PROJECT_GRANT_STATE_UNSPECIFIED
current state of the project grant
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
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-06-13T06:44:37.583Z"
},
"result": [
{
"grantId": "69629023906488334",
"grantedOrgId": "69629023906488334",
"grantedOrgName": "Some Organization",
"grantedRoleKeys": [
"role.super.man"
],
"state": "PROJECT_GRANT_STATE_UNSPECIFIED",
"projectId": "69629023906488334",
"projectName": "ZITADEL",
"projectOwnerId": "69629023906488334",
"projectOwnerName": "ZITADEL",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.583Z",
"changeDate": "2024-06-13T06:44:37.583Z",
"resourceOwner": "69629023906488334"
}
}
]
}
Schema
- Array [
- ]
details object
the last time the view got updated
result object[]
Possible values: [PROJECT_GRANT_STATE_UNSPECIFIED
, PROJECT_GRANT_STATE_ACTIVE
, PROJECT_GRANT_STATE_INACTIVE
]
Default value: PROJECT_GRANT_STATE_UNSPECIFIED
current state of the project grant
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
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-06-13T06:44:37.583Z"
},
"result": [
{
"grantId": "69629023906488334",
"grantedOrgId": "69629023906488334",
"grantedOrgName": "Some Organization",
"grantedRoleKeys": [
"role.super.man"
],
"state": "PROJECT_GRANT_STATE_UNSPECIFIED",
"projectId": "69629023906488334",
"projectName": "ZITADEL",
"projectOwnerId": "69629023906488334",
"projectOwnerName": "ZITADEL",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.583Z",
"changeDate": "2024-06-13T06:44:37.583Z",
"resourceOwner": "69629023906488334"
}
}
]
}
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"
}
]
}