It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Delete Active Directory configuration
editDelete Active Directory configuration
editDeletes a single Active Directory configuration.
Request
editDELETE /api/v1/platform/configuration/security/realms/active-directory/{realm_id}
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The Elasticsearch Security realm identifier. |
Query parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
When specified, checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request) |
Responses
edit-
200 -
(
EmptyResponse) The Active Directory configuration was successfully deleted -
404 -
(
BasicFailedReply) The realm specified by {realm_id} cannot be found. (code:security_realm.not_found)Headers
-
x-cloud-error-codes(string; allowed values: [security_realm.not_found]) - The error codes associated with the response
-
-
409 -
(
BasicFailedReply) There is a version conflict. (code:security_realm.version_conflict)Headers
-
x-cloud-error-codes(string; allowed values: [security_realm.version_conflict]) - The error codes associated with the response
-
-
449 -
(
BasicFailedReply) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required)Headers
-
x-cloud-error-codes(string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]) - The error codes associated with the response
-
Request example
editcurl -XDELETE https://{{hostname}}/api/v1/platform/configuration/security/realms/active-directory/{realm_id} \
-H "Authorization: ApiKey $ECE_API_KEY"