List roles

GET

https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles

GET

/iam/v1beta1/organizations/:organizationId/roles

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

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

List available user roles in an Organization.

List roles

GET

https://api.astronomer.io/iam/v1beta1/organizations/:organizationId/roles

GET

/iam/v1beta1/organizations/:organizationId/roles

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

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

List available user roles in an Organization.

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

The Organization's ID.

Query parameters

includeDefaultRolesbooleanOptional

Whether to include default Astro roles in the returned list.

scopeTypeslist of enumsOptional

Filter the list of roles based on the scope of each role.

Allowed values:

offsetintegerOptional>=0Defaults to 0

Offset for pagination.

limitintegerOptional>=0Defaults to 20

Limit for pagination.

sortslist of enumsOptional

Sorting criteria, each criterion should conform to format ‘fieldName:asc’ or ‘fieldName:desc’.

Response

limitinteger

The number of custom roles returned.

offsetinteger

The offset of the custom roles.

roleslist of objects

The list of custom roles.

totalCountinteger

The total number of custom roles.

defaultRoleslist of objects

The list of default roles.

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 \
>	-H "Authorization: Bearer <token>"

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