Update API token roles

POST

https://api.astronomer.io/v1/organizations/:organizationId/tokens/:tokenId/roles

POST

/v1/organizations/:organizationId/tokens/:tokenId/roles

$ curl -X POST https://api.astronomer.io/v1/organizations/organizationId/tokens/tokenId/roles \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "roles": [
>     {
>       "entityId": "clm8sgvai000008l794psbkdv",
>       "entityType": "DEPLOYMENT",
>       "role": "WORKSPACE_MEMBER"
>     }
>   ]
> }'

1 {
2   "dagRoles": [
3     {
4       "deploymentId": "clm8t5u4q000008jq4qoc3031",
5       "role": "DAG_VIEWER",
6       "dagId": "my_dag",
7       "dagTag": "team-a"
8     }
9   ],
10   "deploymentRoles": [
11     {
12       "deploymentId": "clm8t5u4q000008jq4qoc3031",
13       "role": "DEPLOYMENT_ADMIN"
14     }
15   ],
16   "organizationRole": "ORGANIZATION_OWNER,ORGANIZATION_OBSERVE_ADMIN,ORGANIZATION_OBSERVE_MEMBER,ORGANIZATION_BILLING_ADMIN,ORGANIZATION_MEMBER",
17   "workspaceRoles": [
18     {
19       "role": "WORKSPACE_OWNER",
20       "workspaceId": "clm8t5u4q000008jq4qoc3036"
21     }
22   ]
23 }

Update Workspace and Organization roles for an API token.

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 update an API token.

tokenIdstringRequired

The API token you want to update.

Request

This endpoint expects an object.

roleslist of objectsRequired

The roles of the API token, including DAG roles.

Response

dagRoleslist of objects

A list of the subject's DAG roles.

deploymentRoleslist of objects

A list of the subject's Deployment roles. Currently only for API tokens.

organizationRolestring

The subject's Organization role.

workspaceRoleslist of objects

A list of the subject's Workspace roles.

Errors

400

Update API Token Roles Body Bad Request Error

401

Update API Token Roles Body Unauthorized Error

403

Update API Token Roles Body Forbidden Error

404

Update API Token Roles Body Not Found Error

500

Update API Token Roles Body Internal Server Error