Update an Organization | Astronomer Documentation

curl -X POST https://api.astronomer.io/platform/v1beta1/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"
  },
  "id": "clmaxoarx000008l2c5ayb9pt",
  "isScimEnabled": false,
  "name": "My organization",
  "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": "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",
  "productPlans": [
    {
      "astronomerProduct": "ASTRO",
      "organizationId": "string",
      "productPlanId": "string",
      "productPlanName": "string"
    }
  ],
  "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

The request body for updating the Organization.

billingEmailstringRequired

The Organization's billing email.

isScimEnabledbooleanRequired

Whether SCIM is enabled for the Organization.

namestringRequired<=50 characters

The name of the Organization.

allowEnhancedSupportAccessbooleanOptional

Response

allowEnhancedSupportAccessboolean

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

createdAtstringformat: "date-time"

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

createdByobject

idstring

The Organization's ID.

isScimEnabledboolean

Whether SCIM is enabled for the Organization.

namestring

The Organization's name.

supportPlanenum

The Organization's support plan.

updatedAtstringformat: "date-time"

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

updatedByobject

billingEmailstring

The Organization's billing email.

managedDomainslist of objects

The list of managed domains configured in the Organization.

paymentMethodenum

The Organization's payment method.

productenum

The Organization's product type.

Allowed values:

productPlanslist of objects

statusenum

The Organization's status.

Allowed values:

trialExpiresAtstringformat: "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.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error