Get LDAP configuration

Retrieves a single LDAP security realm configuration.

Request

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

Path parameters

Name Type Required Description

realm_id

string

Y

The Elasticsearch Security realm identifier.

Responses

200

(LdapSettings) The LDAP configuration was successfully retrieved

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

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