Role

Get role templates

GET
Get a list of available role templates in an Organization. A role template can be used as the basis for creating a new custom role.

Path parameters

organizationIdstringRequired
The Organization's ID.

Query parameters

scopeTypesenumOptional
Filter role templates based on the scope of permissions they include.
Allowed values: DEPLOYMENTWORKSPACEORGANIZATION

Response

This endpoint returns a list of objects
name
string
The role's name.
permissions
list of strings
The role's permissions.
scopeType
enum
The role's scope.
Allowed values: DEPLOYMENTWORKSPACEORGANIZATIONSYSTEM
description
stringOptional
The role's description.
GET
1curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/role-templates \
2     -H "Authorization: Bearer <token>"
Response
1[
2  {
3    "name": "Deployment_Viewer",
4    "permissions": [
5      "permissions"
6    ],
7    "scopeType": "DEPLOYMENT",
8    "description": "Subject can only view deployments."
9  }
10]
Built with