Update an Organization

POST

organizations

{organizationId}

curl --request POST \
  --url https://api.astronomer.io/platform/v1beta1/organizations/{organizationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billingEmail": "billing@company.com",
  "isScimEnabled": false,
  "name": "My Organization",
  "allowEnhancedSupportAccess": false,
  "shouldEnforceDedicatedClusters": false
}
'

import requests

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

payload = {
    "billingEmail": "billing@company.com",
    "isScimEnabled": False,
    "name": "My Organization",
    "allowEnhancedSupportAccess": False,
    "shouldEnforceDedicatedClusters": False
}
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({
    billingEmail: 'billing@company.com',
    isScimEnabled: false,
    name: 'My Organization',
    allowEnhancedSupportAccess: false,
    shouldEnforceDedicatedClusters: false
  })
};

fetch('https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}', 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/platform/v1beta1/organizations/{organizationId}",
  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([
    'billingEmail' => 'billing@company.com',
    'isScimEnabled' => false,
    'name' => 'My Organization',
    'allowEnhancedSupportAccess' => false,
    'shouldEnforceDedicatedClusters' => false
  ]),
  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/platform/v1beta1/organizations/{organizationId}"

	payload := strings.NewReader("{\n  \"billingEmail\": \"billing@company.com\",\n  \"isScimEnabled\": false,\n  \"name\": \"My Organization\",\n  \"allowEnhancedSupportAccess\": false,\n  \"shouldEnforceDedicatedClusters\": false\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/platform/v1beta1/organizations/{organizationId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billingEmail\": \"billing@company.com\",\n  \"isScimEnabled\": false,\n  \"name\": \"My Organization\",\n  \"allowEnhancedSupportAccess\": false,\n  \"shouldEnforceDedicatedClusters\": false\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"billingEmail\": \"billing@company.com\",\n  \"isScimEnabled\": false,\n  \"name\": \"My Organization\",\n  \"allowEnhancedSupportAccess\": false,\n  \"shouldEnforceDedicatedClusters\": false\n}"

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

{
  "allowEnhancedSupportAccess": true,
  "createdAt": "2022-11-22T04:37:12Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "id": "clmaxoarx000008l2c5ayb9pt",
  "isScimEnabled": false,
  "name": "My organization",
  "shouldEnforceDedicatedClusters": true,
  "supportPlan": "BUSINESS_CRITICAL",
  "updatedAt": "2022-11-22T04:37:12Z",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "billingEmail": "billing@company.com",
  "managedDomains": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "cln203mz7000008jv0jyz9m3y",
      "name": "mycompany.com",
      "organizationId": "cln204xr2000008mu3hhe3zwe",
      "status": "PENDING",
      "updatedAt": "2023-11-07T05:31:56Z",
      "enforcedLogins": [
        "password"
      ]
    }
  ],
  "paymentMethod": "CREDIT_CARD",
  "product": "HOSTED",
  "productPlans": [
    {
      "astronomerProduct": "ASTRO",
      "organizationId": "<string>",
      "productPlanId": "<string>",
      "productPlanName": "<string>"
    }
  ],
  "status": "ACTIVE",
  "trialExpiresAt": "2022-11-22T04:37:12Z"
}

{
  "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 Organization's ID.

Body

application/json

The request body for updating the Organization.

billingEmail

string

required

The Organization's billing email.

Example:

"billing@company.com"

isScimEnabled

boolean

required

Whether SCIM is enabled for the Organization.

Example:

false

name

string

required

The name of the Organization.

Maximum string length: 50

Example:

"My Organization"

allowEnhancedSupportAccess

boolean

Example:

false

shouldEnforceDedicatedClusters

boolean

When true, only dedicated cluster deployments can be created. Requires Team tier or higher.

Example:

false

Response

allowEnhancedSupportAccess

boolean

required

Whether the organization allows CRE to have view access to their entities

createdAt

string<date-time>

required

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

Example:

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

createdBy

object

required

Show child attributes

string

required

The Organization's ID.

Example:

"clmaxoarx000008l2c5ayb9pt"

isScimEnabled

boolean

required

Whether SCIM is enabled for the Organization.

Example:

false

name

string

required

The Organization's name.

Example:

"My organization"

shouldEnforceDedicatedClusters

boolean

required

When true, only dedicated cluster deployments can be created.

supportPlan

enum<string>

required

The Organization's support plan.

Available options:

INACTIVE,

INTERNAL,

POV,

TRIAL,

BASIC,

BASIC_PAYGO,

TEAM_PAYGO,

STANDARD,

PREMIUM,

BUSINESS_CRITICAL,

BUSINESS,

TEAM,

ENTERPRISE,

DEVELOPER,

DEVELOPER_PAYGO,

TEAM_V2,

BUSINESS_V2,

ENTERPRISE_V2,

TRIAL_V2,

ENTERPRISE_BUSINESS_CRITICAL,

IBM_ENTERPRISE

Example:

"BUSINESS_CRITICAL"

updatedAt

string<date-time>

required

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

Example:

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

updatedBy

object

required

Show child attributes

billingEmail

string

The Organization's billing email.

Example:

"billing@company.com"

managedDomains

object[]

The list of managed domains configured in the Organization.

Show child attributes

paymentMethod

enum<string>

The Organization's payment method.

Available options:

CREDIT_CARD,

INVOICE,

AWS_MARKETPLACE,

AZURE_MARKETPLACE,

GCP_MARKETPLACE,

SNOWFLAKE_MARKETPLACE

Example:

"CREDIT_CARD"

product

enum<string>

The Organization's product type.

Available options:

HOSTED,

HYBRID

Example:

"HOSTED"

productPlans

object[]

Show child attributes

status

enum<string>

The Organization's status.

Available options:

ACTIVE,

INACTIVE,

SUSPENDED

Example:

"ACTIVE"

trialExpiresAt

string<date-time>

The time when the Organization's trial expires in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ. Organizations that are no longer in Trial will not have a expiry date.

Example:

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

⌘I

Update an Organization

curl --request POST \
  --url https://api.astronomer.io/platform/v1beta1/organizations/{organizationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billingEmail": "billing@company.com",
  "isScimEnabled": false,
  "name": "My Organization",
  "allowEnhancedSupportAccess": false,
  "shouldEnforceDedicatedClusters": false
}
'

import requests

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

payload = {
    "billingEmail": "billing@company.com",
    "isScimEnabled": False,
    "name": "My Organization",
    "allowEnhancedSupportAccess": False,
    "shouldEnforceDedicatedClusters": False
}
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({
    billingEmail: 'billing@company.com',
    isScimEnabled: false,
    name: 'My Organization',
    allowEnhancedSupportAccess: false,
    shouldEnforceDedicatedClusters: false
  })
};

fetch('https://api.astronomer.io/platform/v1beta1/organizations/{organizationId}', 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/platform/v1beta1/organizations/{organizationId}",
  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([
    'billingEmail' => 'billing@company.com',
    'isScimEnabled' => false,
    'name' => 'My Organization',
    'allowEnhancedSupportAccess' => false,
    'shouldEnforceDedicatedClusters' => false
  ]),
  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/platform/v1beta1/organizations/{organizationId}"

	payload := strings.NewReader("{\n  \"billingEmail\": \"billing@company.com\",\n  \"isScimEnabled\": false,\n  \"name\": \"My Organization\",\n  \"allowEnhancedSupportAccess\": false,\n  \"shouldEnforceDedicatedClusters\": false\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/platform/v1beta1/organizations/{organizationId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billingEmail\": \"billing@company.com\",\n  \"isScimEnabled\": false,\n  \"name\": \"My Organization\",\n  \"allowEnhancedSupportAccess\": false,\n  \"shouldEnforceDedicatedClusters\": false\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"billingEmail\": \"billing@company.com\",\n  \"isScimEnabled\": false,\n  \"name\": \"My Organization\",\n  \"allowEnhancedSupportAccess\": false,\n  \"shouldEnforceDedicatedClusters\": false\n}"

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

{
  "allowEnhancedSupportAccess": true,
  "createdAt": "2022-11-22T04:37:12Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "id": "clmaxoarx000008l2c5ayb9pt",
  "isScimEnabled": false,
  "name": "My organization",
  "shouldEnforceDedicatedClusters": true,
  "supportPlan": "BUSINESS_CRITICAL",
  "updatedAt": "2022-11-22T04:37:12Z",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "billingEmail": "billing@company.com",
  "managedDomains": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "cln203mz7000008jv0jyz9m3y",
      "name": "mycompany.com",
      "organizationId": "cln204xr2000008mu3hhe3zwe",
      "status": "PENDING",
      "updatedAt": "2023-11-07T05:31:56Z",
      "enforcedLogins": [
        "password"
      ]
    }
  ],
  "paymentMethod": "CREDIT_CARD",
  "product": "HOSTED",
  "productPlans": [
    {
      "astronomerProduct": "ASTRO",
      "organizationId": "<string>",
      "productPlanId": "<string>",
      "productPlanName": "<string>"
    }
  ],
  "status": "ACTIVE",
  "trialExpiresAt": "2022-11-22T04:37:12Z"
}

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