Skip to main content
POST
Create a custom role

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 ID of the Organization where you want to create the custom role.

Body

application/json

The request body for creating the custom role.

name
string
required

The role's name.

Example:

"Deployment_Viewer"

permissions
string[]
required

The permissions included in the role.

Minimum array length: 1
Example:
scopeType
enum<string>
required

The scope of the role.

Available options:
DEPLOYMENT,
DAG
Example:

"DEPLOYMENT"

description
string

The role's description.

Example:

"Subject can only view deployments."

restrictedWorkspaceIds
string[]

The IDs of the Workspaces that the role is restricted to.

Example:

Response

OK

createdAt
string<date-time>
required

The time the role was created.

Example:

"2022-11-22T04:37:12Z"

createdBy
object
required
id
string
required

The role's ID.

Example:

"cluc9tapx000901qn2xrgqdmn"

name
string
required

The role's name.

Example:

"Deployment_Viewer"

permissions
string[]
required

The role's permissions.

Example:
restrictedWorkspaceIds
string[]
required

The IDs of Workspaces that the role is restricted to.

Example:
scopeType
enum<string>
required

The role's scope.

Available options:
DEPLOYMENT,
WORKSPACE,
ORGANIZATION
Example:

"DEPLOYMENT"

updatedAt
string<date-time>
required

The time the role was last updated.

Example:

"2022-11-22T04:37:12Z"

updatedBy
object
required
description
string

The role's description.

Example:

"Subject can only view deployments."