Update Active Directory configuration

PUT /platform/configuration/security/realms/active-directory/{realm_id}

Auth

Updates an existing Active Directory configuration.

Path parameters

realm_id string required: The Elasticsearch Security realm identifier.

Query parameters

version string: When specified, checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)

Request body

The Active Directory configuration

id string required: The identifier for the security realm
name string required: The friendly name of the security realm
urls string[] required: The Active Directory URLs used to authenticate against, in the format ldap[s]://server:port. Note that ldap and ldaps protocols cannot be mixed together.
domain_name string required: Specifies the domain name of the Active Directory (the forest root domain name).
bind_anonymously boolean required: When true, bindDb credentials are ignored
group_search object: Elasticsearch Security Active Directory realm group search configuration
user_search object: Elasticsearch Security Active Directory realm user search configuration
bind_dn string: The distinguished name of the user that is used to bind to the Active Directory and perform searches.
bind_password string: The user password that is used to bind to the Active Directory server.
load_balance object: Elasticsearch Security Active Directory load balancing configuration
certificate_url string: The SSL trusted CA certificate bundle URL. The bundle should be a zip file containing a single keystore file 'keystore.ks' in the directory '/active_directory/:id/truststore', where :id is the value of the [id] field.
certificate_url_truststore_password string: The password to the certificate bundle URL truststore
certificate_url_truststore_type enum: The format of the truststore file. Should be jks to use the Java Keystore format or PKCS12 to use PKCS#12 files. The default is jks.; Values: jks PKCS12
role_mappings object: Elasticsearch Security Active Directory role mapping rule set
enabled boolean: When true, enables the security realm
order integer · format: int32: The order that the security realm is evaluated
override_yaml string: Advanced configuration options in YAML format. Any settings defined here will override any configuration set via the API. Note that all keys should omit the 'xpack.security.authc.realms.active_directory.{realm_id}' prefix. For example, when the realm ID is set to 'ad1', the advanced configuration 'xpack.security.authc.realms.active_directory.ad1.ssl.verification_mode: full' should be added as 'ssl.verification_mode: full'.

Responses

The Active Directory configuration was successfully updated

application/json

Response Type: object

Response headers

x-cloud-resource-version string: The resource version, which is used to avoid update conflicts with concurrent operations
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)

The realm id is already in use. (code: security_realm.id_conflict)
The selected id is not valid. (code: security_realm.invalid_id)
Order must be greater than zero. (code: security_realm.invalid_order)
Invalid Elasticsearch Security realm type. (code: security_realm.invalid_type)
The realm order is already in use. (code: security_realm.order_conflict)
Advanced YAML format is invalid. (code: security_realm.invalid_yaml)
The url format is invalid. (code: security_realm.invalid_url)
Invalid Active Directory URL. (code: security_realm.active_directory.invalid_url)
Invalid certificate bundle URL. (code: security_realm.invalid_bundle_url)

application/json

The realm specified by {realm_id} cannot be found. (code: security_realm.not_found)

application/json

There is a version conflict. (code: security_realm.version_conflict)

application/json

Path parameters

Query parameters

Request body { }

Responses

Response headers

Response headers

Response headers

Response headers

Request body