Skip to content

Commit 093b23d

Browse files
committed
[DOCS] Merges duplicate pages for Active Directory realms (#49205)
1 parent 2bb9227 commit 093b23d

File tree

6 files changed

+33
-40
lines changed

6 files changed

+33
-40
lines changed

docs/reference/redirects.asciidoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -996,3 +996,17 @@ See <<pki-realm>>.
996996

997997
See <<ref-pki-settings>>.
998998

999+
[role="exclude",id="configuring-ad-realm"]
1000+
=== Configuring an Active Directory realm
1001+
1002+
See <<ad-realm-configuration>>.
1003+
1004+
[role="exclude",id="ad-settings"]
1005+
=== Active Directory realm settings
1006+
1007+
See <<ref-ad-settings>>.
1008+
1009+
[role="exclude",id="mapping-roles-ad"]
1010+
=== Mapping Active Directory users and groups to roles
1011+
1012+
See <<ad-realm-configuration>>.

x-pack/docs/en/security/authentication/active-directory-realm.asciidoc

Lines changed: 15 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,7 @@
33
=== Active Directory user authentication
44

55
You can configure {stack} {security-features} to communicate with Active
6-
Directory to authenticate users. To integrate with Active Directory, you
7-
configure an `active_directory` realm and map Active Directory users and groups
8-
to roles in the <<mapping-roles, role mapping file>>.
9-
10-
See {ref}/configuring-ad-realm.html[Configuring an active directory realm].
6+
Directory to authenticate users. See <<ad-realm-configuration>>.
117

128
The {security-features} use LDAP to communicate with Active Directory, so
139
`active_directory` realms are similar to <<ldap-realm, `ldap` realms>>. Like
@@ -33,25 +29,10 @@ Active Directory. Once the user has been found, the Active Directory realm then
3329
retrieves the user's group memberships from the `tokenGroups` attribute on the
3430
user's entry in Active Directory.
3531

36-
[[ad-load-balancing]]
37-
==== Load balancing and failover
38-
The `load_balance.type` setting can be used at the realm level to configure how
39-
the {security-features} should interact with multiple Active Directory servers.
40-
Two modes of operation are supported: failover and load balancing.
41-
42-
See
43-
{ref}/security-settings.html#load-balancing[Load balancing and failover settings].
44-
45-
[[ad-settings]]
46-
==== Active Directory realm settings
47-
48-
See
49-
{ref}/security-settings.html#ref-ad-settings[Active Directory realm settings].
50-
51-
[[mapping-roles-ad]]
52-
==== Mapping Active Directory users and groups to roles
32+
[[ad-realm-configuration]]
33+
==== Configuring an Active Directory realm
5334

54-
See {ref}/configuring-ad-realm.html[Configuring an Active Directory realm].
35+
include::configuring-active-directory-realm.asciidoc[]
5536

5637
[[ad-user-metadata]]
5738
==== User metadata in Active Directory realms
@@ -67,14 +48,22 @@ properties are populated in the user's _metadata_:
6748
|=======================
6849

6950
This metadata is returned in the
70-
{ref}/security-api-authenticate.html[authenticate API] and can be used with
51+
<<security-api-authenticate,authenticate API>> and can be used with
7152
<<templating-role-query, templated queries>> in roles.
7253

7354
Additional metadata can be extracted from the Active Directory server by configuring
7455
the `metadata` setting on the Active Directory realm.
7556

57+
[[ad-load-balancing]]
58+
==== Load balancing and failover
59+
The `load_balance.type` setting can be used at the realm level to configure how
60+
the {security-features} should interact with multiple Active Directory servers.
61+
Two modes of operation are supported: failover and load balancing.
62+
63+
See
64+
<<load-balancing>>.
65+
7666
[[active-directory-ssl]]
7767
==== Setting up SSL between Elasticsearch and Active Directory
7868

79-
See
80-
{ref}/configuring-tls.html#tls-active-directory[Encrypting communications between {es} and Active Directory].
69+
See <<tls-active-directory>>.

x-pack/docs/en/security/authentication/configuring-active-directory-realm.asciidoc

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
1-
[role="xpack"]
2-
[[configuring-ad-realm]]
3-
=== Configuring an Active Directory realm
4-
5-
You can configure {es} to communicate with Active Directory to authenticate
6-
users. To integrate with Active Directory, you configure an `active_directory`
1+
To integrate with Active Directory, you configure an `active_directory`
72
realm and map Active Directory users and groups to roles in the role mapping file.
83

9-
For more information about Active Directory realms, see
10-
<<active-directory-realm>>.
11-
124
. Add a realm configuration of type `active_directory` to `elasticsearch.yml`
135
under the `xpack.security.authc.realms.active_directory` namespace.
146
At a minimum, you must specify the Active Directory `domain_name`.

x-pack/docs/en/security/authorization/run-as-privilege.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ To "run as" (impersonate) another user, you must be able to retrieve the user fr
1212
the realm you use to authenticate. Both the internal `native` and `file` realms
1313
support this out of the box. The LDAP realm must be configured to run in
1414
<<ldap-realm-configuration,_user search_ mode>>. The Active Directory realm must be
15-
<<ad-settings,configured with a `bind_dn` and `secure_bind_password`>> to support
15+
<<ref-ad-settings,configured with a `bind_dn` and `secure_bind_password`>> to support
1616
_run as_. The PKI, Kerberos, and SAML realms do not support _run as_.
1717

1818
To submit requests on behalf of other users, you need to have the `run_as`

x-pack/docs/en/security/configuring-es.asciidoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ TIP: The types of authentication realms that you can enable varies according to
7272
your subscription. For more information, see https://www.elastic.co/subscriptions.
7373

7474
--
75-
** <<configuring-ad-realm,Active Directory realms>>
75+
** <<active-directory-realm,Active Directory realms>>
7676
** <<file-realm,File realms>>
7777
** <<kerberos-realm,Kerberos realms>>
7878
** <<ldap-realm,LDAP realms>>
@@ -139,8 +139,6 @@ To walk through the configuration of {security-features} in {es}, {kib}, {ls}, a
139139

140140

141141
include::securing-communications/separating-node-client-traffic.asciidoc[]
142-
include::authentication/configuring-active-directory-realm.asciidoc[]
143-
144142
include::reference/files.asciidoc[]
145143
include::fips-140-compliance.asciidoc[]
146144

x-pack/docs/en/security/securing-communications/tls-ad.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ to have the Active Directory server's certificate or the server's root CA
1313
certificate installed in their keystore or truststore.
1414

1515
. Create the realm configuration for the `xpack.security.authc.realms` namespace
16-
in the `elasticsearch.yml` file. See <<configuring-ad-realm>>.
16+
in the `elasticsearch.yml` file. See <<ad-realm-configuration>>.
1717

1818
. Set the `url` attribute in the realm configuration to specify the LDAPS protocol
1919
and the secure port number. For example, `url: ldaps://ad.example.com:636`.

0 commit comments

Comments
 (0)