ZITADEL Docs
APIsCore ResourcesV2Project

ListProjectGrants

List Project Grants

Returns a list of project grants. A project grant is when the organization grants its project to another organization.

Required permission:

  • project.grant.read
POST
/zitadel.project.v2.ProjectService/ListProjectGrants

Header Parameters

Connect-Protocol-Version*number

Define the version of the Connect protocol

Value in1
Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

pagination?

Pagination can be used to list limitations and ordering.

sortingColumn?string

SortingColumn is the field the result is sorted by. The default is the creation date. Beware that if you change this, your result pagination might be inconsistent.

Value in"PROJECT_GRANT_FIELD_NAME_UNSPECIFIED" | "PROJECT_GRANT_FIELD_NAME_PROJECT_ID" | "PROJECT_GRANT_FIELD_NAME_CREATION_DATE" | "PROJECT_GRANT_FIELD_NAME_CHANGE_DATE"
filters?

Filters define the criteria to query for.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/zitadel.project.v2.ProjectService/ListProjectGrants" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{}'
{
  "pagination": {
    "totalResult": 0,
    "appliedLimit": 0
  },
  "projectGrants": [
    {
      "organizationId": "string",
      "creationDate": "1s",
      "changeDate": "1s",
      "grantedOrganizationId": "string",
      "grantedOrganizationName": "string",
      "grantedRoleKeys": [
        "string"
      ],
      "projectId": "string",
      "projectName": "string",
      "state": "PROJECT_GRANT_STATE_UNSPECIFIED"
    }
  ]
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?