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.
Get Active Directory configuration
editGet Active Directory configuration
editRetrieves a single Active Directory security realm configuration.
Request
editGET /api/v1/platform/configuration/security/realms/active-directory/{realm_id}
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The Elasticsearch Security realm identifier. |
Responses
edit-
200 -
(
ActiveDirectorySettings) The Active Directory configuration was successfully retrievedHeaders
-
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
editcurl -XGET https://{{hostname}}/api/v1/platform/configuration/security/realms/active-directory/{realm_id} \
-H "Authorization: ApiKey $ECE_API_KEY"