Update an Organization | Astronomer Documentation

curl -X POST https://api.astronomer.io/v1/organizations/organizationId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "billingEmail": "billing@company.com",
  "isScimEnabled": false,
  "name": "My Organization"
}'

{
  "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"
  },
  "hasAllowedIpAddressRanges": false,
  "id": "clmaxoarx000008l2c5ayb9pt",
  "isBlockedEnableAiFeatures": false,
  "isScimEnabled": false,
  "name": "My organization",
  "productPlans": [
    {
      "astronomerProduct": "ASTRO",
      "organizationId": "organizationId",
      "productPlanId": "productPlanId",
      "productPlanName": "INACTIVE"
    }
  ],
  "shouldEnforceDedicatedClusters": true,
  "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",
  "hasAiFeaturesDisabled": true,
  "managedDomains": [
    {
      "createdAt": "2024-01-15T09:30:00Z",
      "id": "cln203mz7000008jv0jyz9m3y",
      "name": "mycompany.com",
      "organizationId": "cln204xr2000008mu3hhe3zwe",
      "status": "PENDING",
      "updatedAt": "2024-01-15T09:30:00Z",
      "enforcedLogins": [
        "password"
      ]
    }
  ],
  "paymentMethod": "CREDIT_CARD",
  "product": "HOSTED",
  "status": "ACTIVE",
  "trialExpiresAt": "2022-11-22T04:37:12Z"
}

Update an Organization's details.

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

The Organization's ID.

Request

This endpoint expects an object.

billingEmailstringRequired

The Organization's billing email.

isScimEnabledbooleanRequired

Whether SCIM is enabled for the Organization.

namestringRequired<=50 characters

The name of the Organization.

allowEnhancedSupportAccessbooleanOptional

hasAiFeaturesDisabledbooleanOptional

shouldEnforceDedicatedClustersbooleanOptional

Response

allowEnhancedSupportAccessboolean

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

createdAtdatetime

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

createdByobject

hasAllowedIpAddressRangesboolean

Whether the Organization has at least one IP address range configured.

idstring

The Organization's ID.

isBlockedEnableAiFeaturesboolean

isScimEnabledboolean

Whether SCIM is enabled for the Organization.

namestring

The Organization's name.

productPlanslist of objects

shouldEnforceDedicatedClustersboolean

updatedAtdatetime

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

updatedByobject

billingEmailstring

The Organization's billing email.

hasAiFeaturesDisabledboolean

managedDomainslist of objects

The list of managed domains configured in the Organization.

paymentMethodenum

The Organization's payment method.

productenum

The Organization's product type.

statusenum

The Organization's status.

trialExpiresAtdatetime

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.

Errors

400

Update Organization Body Bad Request Error

401

Update Organization Body Unauthorized Error

403

Update Organization Body Forbidden Error

404

Update Organization Body Not Found Error

500

Update Organization Body Internal Server Error