Update organization

Auth
Warning

This endpoint is deprecated and scheduled to be removed in the next major version.

Updates an existing organization. Currently unavailable in self-hosted ECE.

Path parameters

organization_id string required

Identifier for the Organization

Request body

The organization to update

name string

The organization's friendly name

default_disk_usage_alerts_enabled boolean

Whether the default disk alerts are enabled

notifications_allowed_email_domains string[]

The list of allowed domains for notification-email recipients

billing_contacts string[]

The list of contacts for billing notifications

operational_contacts string[]

The list of contacts for operational notifications

Responses

Organization updated successfully

application/json
id string required

The organization's identifier

name string required

The organization's friendly name

default_disk_usage_alerts_enabled boolean

Whether the default disk alerts are enabled

notifications_allowed_email_domains string[]

The list of allowed domains for notification-email recipients

billing_contacts string[]

The list of contacts for billing notifications, if specified

operational_contacts string[]

The list of contacts for operational notifications, if specified

sso_login_identifier string

The login identifier for initiating SSO

  • Name must be between 2 and 30 characters. (code: organization.invalid_name)
  • User already has an organization. (code: organization.user_organization_already_exists)
application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

You are not authorized to perform this action

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

The current user does not have access to the requested organization. (code: organization.invalid_access)

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

Organization not found. (code: organization.not_found)

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response