Update a user's roles | Astronomer Documentation

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

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

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

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

The request body for updating the user's roles

dagRoleslist of objectsOptional

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

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl -X POST https://api.astronomer.io/iam/v1beta1/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_MEMBER",
20	"workspaceId": "clm8t5u4q000008jq4qoc3036"
21	}
22	]
23	}