ZITADEL Docs
APIsCore ResourcesV2Authorizations

ListAuthorizations

List Authorizations

ListAuthorizations returns all authorizations matching the request and necessary permissions.

Required permissions:

  • "user.grant.read"
  • no permissions required for listing own authorizations
POST
/zitadel.authorization.v2.AuthorizationService/ListAuthorizations

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?

Paginate through the results using a limit, offset and sorting.

sortingColumn?string

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"AUTHORIZATION_FIELD_NAME_UNSPECIFIED" | "AUTHORIZATION_FIELD_NAME_CREATED_DATE" | "AUTHORIZATION_FIELD_NAME_CHANGED_DATE" | "AUTHORIZATION_FIELD_NAME_ID" | "AUTHORIZATION_FIELD_NAME_USER_ID" | "AUTHORIZATION_FIELD_NAME_PROJECT_ID" | "AUTHORIZATION_FIELD_NAME_ORGANIZATION_ID" | "AUTHORIZATION_FIELD_NAME_USER_ORGANIZATION_ID"
filters?

Define the criteria to query for.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/zitadel.authorization.v2.AuthorizationService/ListAuthorizations" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{}'
{
  "pagination": {
    "totalResult": 0,
    "appliedLimit": 0
  },
  "authorizations": [
    {
      "id": "string",
      "creationDate": "1s",
      "changeDate": "1s",
      "project": {
        "id": "string",
        "name": "string",
        "organizationId": "string"
      },
      "organization": {
        "id": "string",
        "name": "string"
      },
      "user": {
        "id": "string",
        "preferredLoginName": "string",
        "displayName": "string",
        "avatarUrl": "string",
        "organizationId": "string"
      },
      "state": "STATE_UNSPECIFIED",
      "roles": [
        {
          "key": "string",
          "displayName": "string",
          "group": "string"
        }
      ]
    }
  ]
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?