Update an Organization

POST

organizations

{organizationId}

Error

A valid request URL is required to generate request examples

{
  "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": "<string>",
      "productPlanId": "<string>",
      "productPlanName": "BUSINESS_CRITICAL"
    }
  ],
  "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": "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",
  "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

hasAiFeaturesDisabled

boolean

Example:

false

shouldEnforceDedicatedClusters

boolean

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

hasAllowedIpAddressRanges

boolean

required

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

Example:

false

string

required

The Organization's ID.

Example:

"clmaxoarx000008l2c5ayb9pt"

isBlockedEnableAiFeatures

boolean

required

Example:

false

isScimEnabled

boolean

required

Whether SCIM is enabled for the Organization.

Example:

false

name

string

required

The Organization's name.

Example:

"My organization"

productPlans

object[]

required

Show child attributes

shouldEnforceDedicatedClusters

boolean

required

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"

hasAiFeaturesDisabled

boolean

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"

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

Error

A valid request URL is required to generate request examples

{
  "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": "<string>",
      "productPlanId": "<string>",
      "productPlanName": "BUSINESS_CRITICAL"
    }
  ],
  "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": "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",
  "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>"
    }
  ]
}