Skip to content

Commit 949d096

Browse files
committed
fix code comments
1 parent 80f1bcf commit 949d096

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

deploy-manage/users-roles/cluster-or-deployment-auth/active-directory.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ If your Active Directory domain supports authentication with user-provided crede
6565
1. The order in which the `active_directory` realm is consulted during an authentication attempt.
6666
2. The primary domain in Active Directory. Binding to Active Directory fails if the domain name is not mapped in DNS.
6767
3. The LDAP URL pointing to the Active Directory Domain Controller that should handle authentication. If you don’t specify the URL, it defaults to `ldap:<domain_name>:389`.
68+
6869
:::
6970

7071
:::{tab-item} Forest
@@ -86,18 +87,18 @@ If your Active Directory domain supports authentication with user-provided crede
8687
url: ldaps://dc1.ad.example.com:3269, ldaps://dc2.ad.example.com:3269 <2>
8788
load_balance:
8889
type: "round_robin" <3>
89-
```
90+
```
9091

91-
1. The `domain_name` is set to the name of the root domain in the forest.
92-
2. The `url` value used in this example has URLs for two different Domain Controllers, which are also Global Catalog servers. Port 3268 is the default port for unencrypted communication with the Global Catalog; port 3269 is the default port for SSL connections. The servers that are being connected to can be in any domain of the forest as long as they are also Global Catalog servers.
93-
3. A load balancing setting is provided to indicate the desired behavior when choosing the server to connect to.
92+
1. The `domain_name` is set to the name of the root domain in the forest.
93+
2. The URLs for two different Domain Controllers, which are also Global Catalog servers. Port 3268 is the default port for unencrypted communication with the Global Catalog. Port 3269 is the default port for SSL connections. The servers that are being connected to can be in any domain of the forest as long as they are also Global Catalog servers.
94+
3. A load balancing setting is provided to indicate the desired behavior when choosing the server to connect to.
9495

9596

96-
In this configuration, users will need to use either their full User Principal Name (UPN) or their down-level logon name:
97-
* A UPN is typically a concatenation of the username with `@<DOMAIN_NAME` such as `[email protected]`.
98-
* The down-level logon name is the NetBIOS domain name, followed by a `\` and the username, such as `AD\johndoe`.
99-
100-
Use of down-level logon name requires a connection to the regular LDAP ports (389 or 636) in order to query the configuration container to retrieve the domain name from the NetBIOS name.
97+
In this configuration, users will need to use either their full User Principal Name (UPN) or their down-level logon name:
98+
* A UPN is typically a concatenation of the username with `@<DOMAIN_NAME` such as `[email protected]`.
99+
* The down-level logon name is the NetBIOS domain name, followed by a `\` and the username, such as `AD\johndoe`.
100+
101+
Use of down-level logon name requires a connection to the regular LDAP ports (389 or 636) in order to query the configuration container to retrieve the domain name from the NetBIOS name.
101102
:::
102103

103104
::::
@@ -155,11 +156,11 @@ To configure a bind user:
155156

156157
1. Configure the password for the `bind_dn` user by adding the appropriate `xpack.security.authc.realms.active_directory.<my_ad>.secure_bind_password` setting [to the {{es}} keystore](/deploy-manage/security/secure-settings.md).
157158

158-
In self-managed deployments, when a bind user is configured, connection pooling is enabled by default. Connection pooling can be disabled using the `user_search.pool.enabled` setting.
159+
In self-managed deployments, when a bind user is configured, connection pooling is enabled by default. Connection pooling can be disabled using the `user_search.pool.enabled` setting.
159160

160-
:::{warning}
161-
In {{ech}} and {{ece}}, after you configure `secure_bind_password`, any attempt to restart the deployment will fail until you complete the rest of the configuration steps. If you want to rollback the Active Directory realm configurations, you need to remove the `xpack.security.authc.realms.active_directory.<my_ad>.secure_bind_password` that was just added.
162-
:::
161+
:::{warning}
162+
In {{ech}} and {{ece}}, after you configure `secure_bind_password`, any attempt to restart the deployment will fail until you complete the rest of the configuration steps. If you want to rollback the Active Directory realm configurations, you need to remove the `xpack.security.authc.realms.active_directory.<my_ad>.secure_bind_password` that was just added.
163+
:::
163164

164165
## Step 3: Map Active Directory users and groups to roles
165166

@@ -183,25 +184,24 @@ Only Active Directory security groups are supported. You can't map distribution
183184

184185
### Example: using the role mapping API
185186

186-
```sh
187-
POST /_security/role_mapping/ldap-superuser <1>
187+
```console
188+
POST /_security/role_mapping/ldap-superuser
188189
{
189190
"enabled": true,
190-
"roles": [ "superuser" ], <2>
191+
"roles": [ "superuser" ], <1>
191192
"rules": {
192193
"all" : [
193-
{ "field": { "realm.name": "my_ad" } },<3>
194-
{ "field": { "groups": "cn=administrators, dc=example, dc=com" } }<4>
194+
{ "field": { "realm.name": "my_ad" } }, <2>
195+
{ "field": { "groups": "cn=administrators, dc=example, dc=com" } } <3>
195196
]
196197
},
197198
"metadata": { "version": 1 }
198199
}
199200
```
200201

201-
1. The name of the role mapping.
202-
2. The name of the role we want to assign, in this case `superuser`.
203-
3. The name of our active_directory realm.
204-
4. The Distinguished Name of the Active Directory group whose members should get the `superuser` role in the deployment.
202+
1. The name of the role we want to assign, in this case `superuser`.
203+
2. The name of our active_directory realm.
204+
3. The Distinguished Name of the Active Directory group whose members should get the `superuser` role in the deployment.
205205

206206
### Example: Using a role mapping file [ece_using_the_role_mapping_files_2]
207207

0 commit comments

Comments
 (0)