Create a Team | Astronomer Documentation

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

{
  "createdAt": "2022-11-22T04:37:12Z",
  "id": "clma5ftgk000008mhgev00k7d",
  "isIdpManaged": false,
  "name": "My Team",
  "organizationId": "clma5g8q6000108mh88g27k1y",
  "organizationRole": "ORGANIZATION_MEMBER",
  "updatedAt": "2022-11-22T04:37:12Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "dagRoles": [
    {
      "deploymentId": "clm8t5u4q000008jq4qoc3031",
      "role": "DAG_VIEWER",
      "dagId": "my_dag",
      "dagTag": "team-a"
    }
  ],
  "deploymentRoles": [
    {
      "deploymentId": "clm8t5u4q000008jq4qoc3031",
      "role": "DEPLOYMENT_ADMIN"
    }
  ],
  "description": "My Team description",
  "rolesCount": 1,
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "workspaceRoles": [
    {
      "role": "WORKSPACE_MEMBER",
      "workspaceId": "clm8t5u4q000008jq4qoc3036"
    }
  ]
}

Create a Team in an Organization. A Team is a group of users that have the same set of permissions in an Organization or Workspace.

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

The ID of the Organization where the Team is created.

Request

The request body for creating a Team.

namestringRequired

The Team's name.

descriptionstringOptional

The Team's description.

memberIdslist of stringsOptional

The list of IDs for users to add to the Team.

organizationRoleenumOptional

The Team's Organization role.

Allowed values:

Response

createdAtstringformat: "date-time"

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

idstring

The Team's ID.

isIdpManagedboolean

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

namestring

The Team's name.

organizationIdstring

The ID of the Organization to which the Team belongs.

organizationRoleenum

The Team's Organization role.

Allowed values:

updatedAtstringformat: "date-time"

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

createdByobject

dagRoleslist of objects

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

deploymentRoleslist of objects

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

descriptionstring

The Team's description.

rolesCountinteger

The number of roles the Team has.

updatedByobject

workspaceRoleslist of objects

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

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error