Get a custom role | Astronomer Documentation

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

{
  "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."
}

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

{
  "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."
}

Get details about a custom role.

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

The ID of the Organization to which the role belongs.

roleIdstringRequired

The role's ID.

Response

createdAtstringformat: "date-time"

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:

updatedAtstringformat: "date-time"

The time the role was last updated.

updatedByobject

descriptionstring

The role's description.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

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

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