List authorization permission groups

List the available permissions you can grant to a custom role.

GET /authorization/permission-groups

List authorization permission groups

cURL

curl --request GET \
  --url https://api.astronomer.io/platform/v1beta1/authorization/permission-groups \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "description": "Astro notification channel defines where alert messages can be sent. For example, alert messages issued via email or slack.",
    "name": "workspace.notificationChannels",
    "permissions": [
      {
        "action": "get",
        "description": "Subject is permitted to get the scope."
      }
    ],
    "scope": "Workspace NotificationChannels"
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

scopeType · enum<string>

Filter the returned permissions based on the scope they apply to. Note that currently, the only available permissions are in the DEPLOYMENT and DAG scopes.

Available options: DEPLOYMENT, WORKSPACE, ORGANIZATION, DAG

Response

200

application/json

OK

description · string · required

The permission group's description.

Example:

"Astro notification channel defines where alert messages can be sent. For example, alert messages issued via email or slack."

name · string · required

The permission group's name.

Example:

"workspace.notificationChannels"

permissions · object[] · required

The permission group's permissions.

Show child attributes

scope · string · required

The permission group's scope.

Example:

"Workspace NotificationChannels"