Skip to main content
POST
Update a Team

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId
string
required

The ID of the Organization to which the Team belongs.

teamId
string
required

The ID of the Team to update.

Body

application/json

The request body for updating the Team.

name
string
required

The Team's name.

Example:

"My Team"

description
string

The Team's description.

Example:

"My Team Description"

Response

OK

createdAt
string<date-time>
required

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

Example:

"2022-11-22T04:37:12Z"

id
string
required

The Team's ID.

Example:

"clma5ftgk000008mhgev00k7d"

isIdpManaged
boolean
required

Whether the Team is managed by an identity provider (IdP).

Example:

false

name
string
required

The Team's name.

Example:

"My Team"

organizationId
string
required

The ID of the Organization to which the Team belongs.

Example:

"clma5g8q6000108mh88g27k1y"

organizationRole
enum<string>
required

The Team's Organization role.

Available options:
ORGANIZATION_OWNER,
ORGANIZATION_OBSERVE_ADMIN,
ORGANIZATION_OBSERVE_MEMBER,
ORGANIZATION_BILLING_ADMIN,
ORGANIZATION_MEMBER
Example:

"ORGANIZATION_MEMBER"

updatedAt
string<date-time>
required

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

Example:

"2022-11-22T04:37:12Z"

createdBy
object
dagRoles
object[]

The Team's role in each DAG it belongs to.

deploymentRoles
object[]

The Team's role in each Deployment it belongs to.

description
string

The Team's description.

Example:

"My Team description"

rolesCount
integer

The number of roles the Team has.

Example:

1

updatedBy
object
workspaceRoles
object[]

The Team's role in each Workspace it belongs to.