Update API token roles | Astronomer Documentation

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": "WORKSPACE",
      "role": "WORKSPACE_MEMBER"
    }
  ]
}'

{
  "dagRoles": [
    {
      "deploymentId": "clm8t5u4q000008jq4qoc3031",
      "role": "DAG_VIEWER",
      "dagId": "my_dag",
      "dagTag": "team-a"
    }
  ],
  "deploymentRoles": [
    {
      "deploymentId": "clm8t5u4q000008jq4qoc3031",
      "role": "DEPLOYMENT_ADMIN"
    }
  ],
  "organizationRole": "ORGANIZATION_OWNER,ORGANIZATION_OBSERVE_ADMIN,ORGANIZATION_OBSERVE_MEMBER,ORGANIZATION_BILLING_ADMIN,ORGANIZATION_MEMBER",
  "workspaceRoles": [
    {
      "role": "WORKSPACE_MEMBER",
      "workspaceId": "clm8t5u4q000008jq4qoc3036"
    }
  ]
}

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

The request body for updating a token.

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

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error