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 configurationedit
Deletes a single Active Directory configuration.
Requestedit
DELETE /api/v1/platform/configuration/security/realms/active-directory/{realm_id}
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The Elasticsearch Security realm identifier. |
Query parametersedit
| 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) |
Responsesedit
-
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
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XDELETE {{hostname}}/api/v1/platform/configuration/security/realms/active-directory/{realm_id} \
-H "Authorization: ApiKey $ECE_API_KEY"