Create a Team - Astronomer

POST

organizations

{organizationId}

teams

Create a Team

curl --request POST \
  --url https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Team",
  "description": "My Team description",
  "memberIds": [
    "clma67byh000008md1gr995ez"
  ],
  "organizationRole": "ORGANIZATION_MEMBER"
}
'

import requests

url = "https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams"

payload = {
    "name": "My Team",
    "description": "My Team description",
    "memberIds": ["clma67byh000008md1gr995ez"],
    "organizationRole": "ORGANIZATION_MEMBER"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'My Team',
    description: 'My Team description',
    memberIds: ['clma67byh000008md1gr995ez'],
    organizationRole: 'ORGANIZATION_MEMBER'
  })
};

fetch('https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'My Team',
    'description' => 'My Team description',
    'memberIds' => [
        'clma67byh000008md1gr995ez'
    ],
    'organizationRole' => 'ORGANIZATION_MEMBER'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams"

	payload := strings.NewReader("{\n  \"name\": \"My Team\",\n  \"description\": \"My Team description\",\n  \"memberIds\": [\n    \"clma67byh000008md1gr995ez\"\n  ],\n  \"organizationRole\": \"ORGANIZATION_MEMBER\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My Team\",\n  \"description\": \"My Team description\",\n  \"memberIds\": [\n    \"clma67byh000008md1gr995ez\"\n  ],\n  \"organizationRole\": \"ORGANIZATION_MEMBER\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My Team\",\n  \"description\": \"My Team description\",\n  \"memberIds\": [\n    \"clma67byh000008md1gr995ez\"\n  ],\n  \"organizationRole\": \"ORGANIZATION_MEMBER\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

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 where the Team is created.

Body

application/json

The request body for creating a Team.

name

string

required

The Team's name.

Example:

"My Team"

description

string

The Team's description.

Example:

"My Team description"

memberIds

string[]

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

Example:

["clma67byh000008md1gr995ez"]

organizationRole

enum<string>

The Team's Organization role.

Available options:

ORGANIZATION_OWNER,

ORGANIZATION_OBSERVE_ADMIN,

ORGANIZATION_OBSERVE_MEMBER,

ORGANIZATION_BILLING_ADMIN,

ORGANIZATION_MEMBER

Example:

"ORGANIZATION_MEMBER"

Response

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"

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

Show child attributes

dagRoles

object[]

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

Show child attributes

deploymentRoles

object[]

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

Show child attributes

description

string

The Team's description.

Example:

"My Team description"

rolesCount

integer

The number of roles the Team has.

Example:

1

updatedBy

object

Show child attributes

workspaceRoles

object[]

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

Show child attributes

⌘I

Create a Team

curl --request POST \
  --url https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Team",
  "description": "My Team description",
  "memberIds": [
    "clma67byh000008md1gr995ez"
  ],
  "organizationRole": "ORGANIZATION_MEMBER"
}
'

import requests

url = "https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams"

payload = {
    "name": "My Team",
    "description": "My Team description",
    "memberIds": ["clma67byh000008md1gr995ez"],
    "organizationRole": "ORGANIZATION_MEMBER"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'My Team',
    description: 'My Team description',
    memberIds: ['clma67byh000008md1gr995ez'],
    organizationRole: 'ORGANIZATION_MEMBER'
  })
};

fetch('https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'My Team',
    'description' => 'My Team description',
    'memberIds' => [
        'clma67byh000008md1gr995ez'
    ],
    'organizationRole' => 'ORGANIZATION_MEMBER'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams"

	payload := strings.NewReader("{\n  \"name\": \"My Team\",\n  \"description\": \"My Team description\",\n  \"memberIds\": [\n    \"clma67byh000008md1gr995ez\"\n  ],\n  \"organizationRole\": \"ORGANIZATION_MEMBER\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My Team\",\n  \"description\": \"My Team description\",\n  \"memberIds\": [\n    \"clma67byh000008md1gr995ez\"\n  ],\n  \"organizationRole\": \"ORGANIZATION_MEMBER\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My Team\",\n  \"description\": \"My Team description\",\n  \"memberIds\": [\n    \"clma67byh000008md1gr995ez\"\n  ],\n  \"organizationRole\": \"ORGANIZATION_MEMBER\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}