Authorization

List authorization permission groups

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

Query parameters

scopeTypeenumOptional

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

Allowed values: DEPLOYMENTWORKSPACEORGANIZATION

Response

This endpoint returns a list of objects
description
string
The permission group's description.
name
string
The permission group's name.
permissions
list of objects
The permission group's permissions.
scope
string
The permission group's scope.
GET
1curl https://api.astronomer.io/iam/v1beta1/authorization/permission-groups \
2     -H "Authorization: Bearer <token>"
Response
1[
2  {
3    "description": "Astro notification channel defines where alert messages can be sent. For example, alert messages issued via email or slack.",
4    "name": "workspace.notificationChannels",
5    "permissions": [
6      {
7        "action": "get",
8        "description": "Subject is permitted to get the scope."
9      }
10    ],
11    "scope": "Workspace NotificationChannels"
12  }
13]
Built with