Update Active Directory configuration
- PUT /platform/configuration/security/realms/active-directory/{realm_id}
Updates an existing Active Directory configuration.
Request body
The Active Directory configuration
-
urlsstringrequired -
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_namestringrequired -
Specifies the domain name of the Active Directory (the forest root domain name).
-
group_searchobject -
Elasticsearch Security Active Directory realm group search configuration
-
scope -
Specifies whether the group search should be sub_tree, one_level or base. one_level only searches objects directly contained within the base_dn. The default sub_tree searches all objects contained under base_dn. base specifies that the base_dn is a group object, and that it is the only group considered.
-
Values:
sub_treeone_levelbase -
user_searchobject -
Elasticsearch Security Active Directory realm user search configuration
-
scope -
The scope of the user search. Valid values are sub_tree, one_level, or base. one_level only searches objects directly contained in the base_dn. sub_tree searches all objects contained in base_dn. base specifies that the base_dn is the user object, and that it is the only user considered. Defaults to sub_tree.
-
Values:
sub_treeone_levelbase -
bind_dnstring -
The distinguished name of the user that is used to bind to the Active Directory and perform searches.
-
certificate_urlstring -
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_type -
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:
jksPKCS12 -
override_yamlstring -
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
Response Type: object
Response headers
- 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)
The realm specified by {realm_id} cannot be found. (code: security_realm.not_found)
There is a version conflict. (code: security_realm.version_conflict)