Get a custom role

1 curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/roles/roleId \ 2 -H "Authorization: Bearer <token>"

1 { 2 "createdAt": "createdAt", 3 "createdBy": { 4 "apiTokenName": "my-token", 5 "avatarUrl": "https://avatar.url", 6 "fullName": "Jane Doe", 7 "id": "clm8qv74h000008mlf08scq7k", 8 "subjectType": "USER", 9 "username": "user1@company.com" 10 }, 11 "description": "Subject can only view deployments.", 12 "id": "cluc9tapx000901qn2xrgqdmn", 13 "name": "Deployment_Viewer", 14 "permissions": [ 15 "deployment.get" 16 ], 17 "restrictedWorkspaceIds": [ 18 "cldbvzoi20182g8odxt8ehi5i" 19 ], 20 "scopeType": "DEPLOYMENT", 21 "updatedAt": "updatedAt", 22 "updatedBy": { 23 "apiTokenName": "my-token", 24 "avatarUrl": "https://avatar.url", 25 "fullName": "Jane Doe", 26 "id": "clm8qv74h000008mlf08scq7k", 27 "subjectType": "USER", 28 "username": "user1@company.com" 29 } 30 }

Get details about a custom role.

Path parameters

organizationIdstringRequired

The ID of the Organization to which the role belongs.

roleIdstringRequired

The role’s ID.

Response

createdAtstring

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.

Allowed values:

updatedAtstring

The time the role was last updated.

updatedByobject

descriptionstringOptional

The role’s description.

Path parameters

Headers

Response

Errors