Skip to main content
GET
Get role templates

Authorizations

Authorization
string
header
required

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

Path Parameters

organizationId
string
required

The Organization's ID.

Query Parameters

scopeTypes
enum<string>[]

Filter role templates based on the scope of permissions they include.

Available options:
DEPLOYMENT,
WORKSPACE,
ORGANIZATION,
DAG

Response

OK

name
string
required

The role's name.

Example:

"Deployment_Viewer"

permissions
string[]
required

The role's permissions.

Example:
scopeType
enum<string>
required

The role's scope.

Available options:
DEPLOYMENT,
WORKSPACE,
ORGANIZATION,
SYSTEM,
DAG
Example:

"DEPLOYMENT"

description
string

The role's description.

Example:

"Subject can only view deployments."