Search Granted Project
Lists projects my organization got granted from another organization. A Project is a vessel for different applications sharing the same role context.
Header Parameters
- x-zitadel-orgid string
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.
 
- 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_EQUALSdefines which text equality method is used
projectResourceOwnerQuery object
resourceOwner string]
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_EQUALSdefines which text equality method is used
projectResourceOwnerQuery object
resourceOwner string]
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_EQUALSdefines which text equality method is used
projectResourceOwnerQuery object
resourceOwner string]
- 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 [grantId stringgrantedOrgId stringgrantedOrgName stringgrantedRoleKeys string[]state stringPossible values: [
PROJECT_GRANT_STATE_UNSPECIFIED,PROJECT_GRANT_STATE_ACTIVE,PROJECT_GRANT_STATE_INACTIVE]Default value:
PROJECT_GRANT_STATE_UNSPECIFIEDcurrent state of the project grant
projectId stringprojectName stringprojectOwnerId stringprojectOwnerName 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 to]
{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2023-05-12"
  },
  "result": [
    {
      "grantId": "69629023906488334",
      "grantedOrgId": "69629023906488334",
      "grantedOrgName": "Some Organisation",
      "grantedRoleKeys": [
        "role.super.man"
      ],
      "state": "PROJECT_GRANT_STATE_UNSPECIFIED",
      "projectId": "69629023906488334",
      "projectName": "ZITADEL",
      "projectOwnerId": "69629023906488334",
      "projectOwnerName": "ZITADEL",
      "details": {
        "sequence": "2",
        "creationDate": "2023-05-12",
        "changeDate": "2023-05-12",
        "resourceOwner": "69629023906488334"
      }
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
details object
totalResult uint64processedSequence uint64viewTimestamp date-timethe last time the view got updated
result object[]
Array [grantId stringgrantedOrgId stringgrantedOrgName stringgrantedRoleKeys string[]state stringPossible values: [
PROJECT_GRANT_STATE_UNSPECIFIED,PROJECT_GRANT_STATE_ACTIVE,PROJECT_GRANT_STATE_INACTIVE]Default value:
PROJECT_GRANT_STATE_UNSPECIFIEDcurrent state of the project grant
projectId stringprojectName stringprojectOwnerId stringprojectOwnerName 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 to]
{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2023-05-12"
  },
  "result": [
    {
      "grantId": "69629023906488334",
      "grantedOrgId": "69629023906488334",
      "grantedOrgName": "Some Organisation",
      "grantedRoleKeys": [
        "role.super.man"
      ],
      "state": "PROJECT_GRANT_STATE_UNSPECIFIED",
      "projectId": "69629023906488334",
      "projectName": "ZITADEL",
      "projectOwnerId": "69629023906488334",
      "projectOwnerName": "ZITADEL",
      "details": {
        "sequence": "2",
        "creationDate": "2023-05-12",
        "changeDate": "2023-05-12",
        "resourceOwner": "69629023906488334"
      }
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
details object
totalResult uint64processedSequence uint64viewTimestamp date-timethe last time the view got updated
result object[]
Array [grantId stringgrantedOrgId stringgrantedOrgName stringgrantedRoleKeys string[]state stringPossible values: [
PROJECT_GRANT_STATE_UNSPECIFIED,PROJECT_GRANT_STATE_ACTIVE,PROJECT_GRANT_STATE_INACTIVE]Default value:
PROJECT_GRANT_STATE_UNSPECIFIEDcurrent state of the project grant
projectId stringprojectName stringprojectOwnerId stringprojectOwnerName 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 to]
{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2023-05-12"
  },
  "result": [
    {
      "grantId": "69629023906488334",
      "grantedOrgId": "69629023906488334",
      "grantedOrgName": "Some Organisation",
      "grantedRoleKeys": [
        "role.super.man"
      ],
      "state": "PROJECT_GRANT_STATE_UNSPECIFIED",
      "projectId": "69629023906488334",
      "projectName": "ZITADEL",
      "projectOwnerId": "69629023906488334",
      "projectOwnerName": "ZITADEL",
      "details": {
        "sequence": "2",
        "creationDate": "2023-05-12",
        "changeDate": "2023-05-12",
        "resourceOwner": "69629023906488334"
      }
    }
  ]
}
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"
    }
  ]
}