Update organization
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
-
Identifier for the Organization
Body Required
The organization to update
-
name string
The organization's friendly name
-
Whether the default disk alerts are enabled
-
notifications_allowed_email_domains array[string]
The list of allowed domains for notification-email recipients
-
billing_contacts array[string]
The list of contacts for billing notifications
-
operational_contacts array[string]
The list of contacts for operational notifications
Responses
-
Organization updated successfully
-
- Name must be between 2 and 30 characters. (code:
organization.invalid_name
) - User already has an organization. (code:
organization.user_organization_already_exists
)
- Name must be between 2 and 30 characters. (code:
-
You are not authorized to perform this action
-
The current user does not have access to the requested organization. (code:
organization.invalid_access
) -
Organization not found. (code:
organization.not_found
)
PUT /organizations/{organization_id}
curl \
-X PUT https://api.elastic-cloud.com/api/v1/organizations/{organization_id} \
-d '{"name":"string","default_disk_usage_alerts_enabled":true,"notifications_allowed_email_domains":["string"],"billing_contacts":["string"],"operational_contacts":["string"]}'
Request examples
{
"name": "string",
"default_disk_usage_alerts_enabled": true,
"notifications_allowed_email_domains": [
"string"
],
"billing_contacts": [
"string"
],
"operational_contacts": [
"string"
]
}
Response examples (200)
{
"id": "string",
"name": "string",
"default_disk_usage_alerts_enabled": true,
"notifications_allowed_email_domains": [
"string"
],
"billing_contacts": [
"string"
],
"operational_contacts": [
"string"
],
"sso_login_identifier": "string"
}
Response examples (400)
# Headers
x-cloud-error-codes: organization.invalid_name
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}
Response examples (401)
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}
Response examples (403)
# Headers
x-cloud-error-codes: organization.invalid_access
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}
Response examples (404)
# Headers
x-cloud-error-codes: organization.not_found
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}