Delete LDAP configuration

edit

Deletes a single LDAP configuration.

Request

edit

DELETE /api/v1/platform/configuration/security/realms/ldap/{realm_id}

Path parameters

edit
Name Type Required Description

realm_id

string

Y

The Elasticsearch Security realm identifier.

Query parameters

edit
Name Type Required Description

version

string

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 LDAP 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 example

edit
curl -XDELETE https://{{hostname}}/api/v1/platform/configuration/security/realms/ldap/{realm_id} \
-H "Authorization: ApiKey $ECE_API_KEY"