curl --request POST \
--url https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams/{teamId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "My Team",
"description": "My Team Description"
}
'import requests
url = "https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams/{teamId}"
payload = {
"name": "My Team",
"description": "My Team Description"
}
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'})
};
fetch('https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams/{teamId}', 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/{teamId}",
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'
]),
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/{teamId}"
payload := strings.NewReader("{\n \"name\": \"My Team\",\n \"description\": \"My Team Description\"\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/{teamId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Team\",\n \"description\": \"My Team Description\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams/{teamId}")
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}"
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>"
}
]
}Update a Team
Update a Team’s details.
curl --request POST \
--url https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams/{teamId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "My Team",
"description": "My Team Description"
}
'import requests
url = "https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams/{teamId}"
payload = {
"name": "My Team",
"description": "My Team Description"
}
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'})
};
fetch('https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams/{teamId}', 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/{teamId}",
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'
]),
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/{teamId}"
payload := strings.NewReader("{\n \"name\": \"My Team\",\n \"description\": \"My Team Description\"\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/{teamId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Team\",\n \"description\": \"My Team Description\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.astronomer.io/iam/v1beta1/organizations/{organizationId}/teams/{teamId}")
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}"
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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the Organization to which the Team belongs.
The ID of the Team to update.
Body
The request body for updating the Team.
Response
OK
The time when the Team was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.
"2022-11-22T04:37:12Z"
The Team's ID.
"clma5ftgk000008mhgev00k7d"
Whether the Team is managed by an identity provider (IdP).
false
The Team's name.
"My Team"
The ID of the Organization to which the Team belongs.
"clma5g8q6000108mh88g27k1y"
The Team's Organization role.
ORGANIZATION_OWNER, ORGANIZATION_OBSERVE_ADMIN, ORGANIZATION_OBSERVE_MEMBER, ORGANIZATION_BILLING_ADMIN, ORGANIZATION_MEMBER "ORGANIZATION_MEMBER"
The time when the Team was last updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.
"2022-11-22T04:37:12Z"
Show child attributes
Show child attributes
The Team's role in each DAG it belongs to.
Show child attributes
Show child attributes
The Team's role in each Deployment it belongs to.
Show child attributes
Show child attributes
The Team's description.
"My Team description"
The number of roles the Team has.
1
Show child attributes
Show child attributes
The Team's role in each Workspace it belongs to.
Show child attributes
Show child attributes
Was this page helpful?