Team

Update a Team

POST
Update a Team's details.

Path parameters

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

Request

This endpoint expects an object.
name
stringRequired
The Team's name.
description
stringOptional
The Team's description.

Response

This endpoint returns an object
createdAt
datetime

The time when the Team was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

id
string
The Team's ID.
isIdpManaged
boolean
Whether the Team is managed by an identity provider (IdP).
name
string
The Team's name.
organizationId
string
The ID of the Organization to which the Team belongs.
organizationRole
enum
The Team's Organization role.
Allowed values: ORGANIZATION_OWNERORGANIZATION_BILLING_ADMINORGANIZATION_MEMBER
updatedAt
datetime

The time when the Team was last updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

createdBy
objectOptional
deploymentRoles
list of objectsOptional
The Team's role in each Deployment it belongs to.
description
stringOptional
The Team's description.
rolesCount
integerOptional
The number of roles the Team has.
updatedBy
objectOptional
workspaceRoles
list of objectsOptional
The Team's role in each Workspace it belongs to.
POST
1curl -X POST https://api.astronomer.io/iam/v1beta1/organizations/organizationId/teams/teamId \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "name": "My Team",
6  "description": "My Team Description"
7}'
Response
1{
2  "createdAt": "2022-11-22T04:37:12Z",
3  "id": "clma5ftgk000008mhgev00k7d",
4  "isIdpManaged": false,
5  "name": "My Team",
6  "organizationId": "clma5g8q6000108mh88g27k1y",
7  "organizationRole": "ORGANIZATION_OWNER",
8  "updatedAt": "2022-11-22T04:37:12Z",
9  "createdBy": {
10    "id": "clm8qv74h000008mlf08scq7k",
11    "apiTokenName": "my-token",
12    "avatarUrl": "https://avatar.url",
13    "fullName": "Jane Doe",
14    "subjectType": "USER",
15    "username": "user1@company.com"
16  },
17  "deploymentRoles": [
18    {
19      "deploymentId": "clm8t5u4q000008jq4qoc3031",
20      "role": "DEPLOYMENT_ADMIN"
21    }
22  ],
23  "description": "My Team description",
24  "rolesCount": 1,
25  "updatedBy": {
26    "id": "clm8qv74h000008mlf08scq7k",
27    "apiTokenName": "my-token",
28    "avatarUrl": "https://avatar.url",
29    "fullName": "Jane Doe",
30    "subjectType": "USER",
31    "username": "user1@company.com"
32  },
33  "workspaceRoles": [
34    {
35      "role": "WORKSPACE_OWNER",
36      "workspaceId": "clm8t5u4q000008jq4qoc3036"
37    }
38  ]
39}
Built with