Update a user's roles

POST

https://api.astronomer.io/v1/organizations/:organizationId/users/:userId/roles

POST

/v1/organizations/:organizationId/users/:userId/roles

$ curl -X POST https://api.astronomer.io/v1/organizations/organizationId/users/userId/roles \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

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 Organization and Workspace roles for a user.

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 user belongs.

userIdstringRequired

The user's ID

Request

This endpoint expects an object.

dagRoleslist of objectsOptional

The user's updated DAG roles.

deploymentRoleslist of objectsOptional

The user’s updated Deployment roles. Requires also specifying an OrganizationRole.

organizationRolestringOptional

The user's updated Organization role.

workspaceRoleslist of objectsOptional

The user’s updated Workspace roles. Requires also specifying an OrganizationRole.

Response

The response body containing the user's roles

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 User Roles Body Bad Request Error

401

Update User Roles Body Unauthorized Error

403

Update User Roles Body Forbidden Error

404

Update User Roles Body Not Found Error

500

Update User Roles Body Internal Server Error