Team

Update Team roles

POST
Update Organization and Workspace roles for a Team.

Path parameters

organizationIdstringRequired
The ID of the Organization to which the Team belongs.
teamIdstringRequired
The ID of the Team to update roles for.

Request

This endpoint expects an object.
organizationRole
enumRequired
The Team's Organization roles.
Allowed values: ORGANIZATION_OWNERORGANIZATION_BILLING_ADMINORGANIZATION_MEMBER
deploymentRoles
list of objectsOptional
The user's updated Deployment roles. The Deployments you specify must belong to the Team's Organization.
workspaceRoles
list of objectsOptional
The Team's updated Workspace roles. The Workspaces you specify must belong to the Team's Organization.

Response

This endpoint returns an object
deploymentRoles
list of objectsOptional
A list of the subject's Deployment roles. Currently only for API tokens.
organizationRole
enumOptional
The subject's Organization role.
Allowed values: ORGANIZATION_OWNERORGANIZATION_BILLING_ADMINORGANIZATION_MEMBER
workspaceRoles
list of objectsOptional
A list of the subject's Workspace roles.
POST
1curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/organizationId/teams/teamId/roles \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "organizationRole": "ORGANIZATION_OWNER",
6  "deploymentRoles": [
7    {
8      "deploymentId": "clm8t5u4q000008jq4qoc3031",
9      "role": "DEPLOYMENT_ADMIN"
10    }
11  ],
12  "workspaceRoles": [
13    {
14      "role": "WORKSPACE_OWNER",
15      "workspaceId": "clm8t5u4q000008jq4qoc3036"
16    }
17  ]
18}'
Response
1{
2  "deploymentRoles": [
3    {
4      "deploymentId": "clm8t5u4q000008jq4qoc3031",
5      "role": "DEPLOYMENT_ADMIN"
6    }
7  ],
8  "organizationRole": "ORGANIZATION_OWNER",
9  "workspaceRoles": [
10    {
11      "role": "WORKSPACE_OWNER",
12      "workspaceId": "clm8t5u4q000008jq4qoc3036"
13    }
14  ]
15}
Built with