Create a custom role | Astronomer Documentation

curl -X POST https://api.astronomer.io/v1/organizations/organizationId/roles \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Deployment_Viewer",
  "permissions": [
    "deployment.get"
  ],
  "scopeType": "DEPLOYMENT"
}'

{
  "createdAt": "2022-11-22T04:37:12Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "id": "cluc9tapx000901qn2xrgqdmn",
  "name": "Deployment_Viewer",
  "permissions": [
    "deployment.get"
  ],
  "restrictedWorkspaceIds": [
    "cldbvzoi20182g8odxt8ehi5i"
  ],
  "scopeType": "DEPLOYMENT",
  "updatedAt": "2022-11-22T04:37:12Z",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "description": "Subject can only view deployments."
}

Create a custom role that you can assign to users, Teams, and API tokens.

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

The ID of the Organization where you want to create the custom role.

Request

This endpoint expects an object.

namestringRequired

The role's name.

permissionslist of stringsRequired

The permissions included in the role.

scopeTypeenumRequired

The scope of the role.

Allowed values:

descriptionstringOptional

The role's description.

restrictedWorkspaceIdslist of stringsOptional

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

Response

createdAtdatetime

The time the role was created.

createdByobject

idstring

The role's ID.

namestring

The role's name.

permissionslist of strings

The role's permissions.

restrictedWorkspaceIdslist of strings

The IDs of Workspaces that the role is restricted to.

scopeTypeenum

The role's scope.

updatedAtdatetime

The time the role was last updated.

updatedByobject

descriptionstring

The role's description.

Errors

400

Create Custom Role Body Bad Request Error

401

Create Custom Role Body Unauthorized Error

403

Create Custom Role Body Forbidden Error

404

Create Custom Role Body Not Found Error

500

Create Custom Role Body Internal Server Error