Skip to content
This repository was archived by the owner on Aug 16, 2022. It is now read-only.

Commit 46e9658

Browse files
committed
Editorial cleanup
1 parent b9e8107 commit 46e9658

File tree

14 files changed

+351
-349
lines changed

14 files changed

+351
-349
lines changed

docs/security-access-control/default-action-groups.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,24 +23,24 @@ Name | Description
2323
:---| :---
2424
CLUSTER_ALL | Grants all cluster permissions. Equates to `cluster:*`.
2525
CLUSTER_MONITOR | Grants all cluster monitoring permissions. Equates to `cluster:monitor/*`.
26-
CLUSTER\_COMPOSITE\_OPS\_RO | Grants read-only permissions to execute requests like `mget`, `msearch`, or `mtv`, plus permissions to query for aliases.
27-
CLUSTER\_COMPOSITE\_OPS | Same as `CLUSTER_COMPOSITE_OPS_RO`, but also grants `bulk` permissions and all aliases permissions.
26+
CLUSTER_COMPOSITE_OPS_RO | Grants read-only permissions to execute requests like `mget`, `msearch`, or `mtv`, plus permissions to query for aliases.
27+
CLUSTER_COMPOSITE_OPS | Same as `CLUSTER_COMPOSITE_OPS_RO`, but also grants `bulk` permissions and all aliases permissions.
2828
MANAGE_SNAPSHOTS | Grants permissions to manage snapshots and repositories.
2929

3030

3131
## Index-level
3232

3333
Name | Description
3434
:--- | :---
35-
INDICES\_ALL | Grants all permissions on the index. Equates to `indices:*`.
35+
INDICES_ALL | Grants all permissions on the index. Equates to `indices:*`.
3636
GET | Grants permissions to use `get` and `mget` actions only.
3737
READ | Grants read permissions such as search, get field mappings, `get`, and `mget`.
3838
WRITE | Grants write permissions to documents.
3939
DELETE | Grants permissions to delete documents.
4040
CRUD | Combines the READ, WRITE and DELETE action groups.
4141
SEARCH | Grants permissions to search documents. Includes SUGGEST.
4242
SUGGEST | Grants permissions to use the suggest API. Included in the READ action group.
43-
CREATE\_INDEX | Grants permissions to create indices and mappings.
44-
INDICES\_MONITOR | Grants permissions to execute all index monitoring actions (e.g. recovery, segments info, index stats, and status).
45-
MANAGE\_ALIASES | Grants permissions to manage aliases.
43+
CREATE_INDEX | Grants permissions to create indices and mappings.
44+
INDICES_MONITOR | Grants permissions to execute all index monitoring actions (e.g. recovery, segments info, index stats, and status).
45+
MANAGE_ALIASES | Grants permissions to manage aliases.
4646
MANAGE | Grants all monitoring and administration permissions for indices.

docs/security-configuration/concepts.md

100644100755
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,18 @@ nav_order: 1
99

1010
Understanding the authentication flow is the best way to get started with configuring the Security plugin for Open Distro for Elasticsearch.
1111

12-
1. In order to identify the user who wants to access the cluster, the Security plugin needs the user's credentials.
12+
1. To identify a user who wants to access the cluster, the Security plugin needs the user's credentials.
1313

14-
These credentials differ depending on how you've configured the plugin. For example, if you use basic authentication, these credentials are a username and password. If you use a JSON web token, these credentials are stored within the token itself. If you use TLS certificates, the credentials are the distinguished name (DN) of the certificate.
14+
These credentials differ depending on how you've configured the plugin. For example, if you use basic authentication, the credentials are a user name and password. If you use a JSON web token, the credentials are stored within the token itself. If you use TLS certificates, the credentials are the distinguished name (DN) of the certificate.
1515

1616
2. The Security plugin authenticates the user's credentials against a backend: the internal user database, Lightweight Directory Access Protocol (LDAP), Active Directory, Kerberos, or JSON web tokens.
1717

18-
The plugin supports chaining backends. If more than one backend is configured, the plugin tries to authenticate the user against all backends until one succeeds. A common use case is to combine the Security plugin's internal user database with LDAP/Active Directory.
18+
The plugin supports chaining backends. If more than one backend is configured, the plugin tries to authenticate the user against all backends until one succeeds. A common use case is to combine the internal user database of the Security plugin with LDAP/Active Directory.
1919

2020
3. (Optional) After an authenticator verifies the user's credentials, the plugin collects any backend roles. In most cases, this backend is LDAP/Active Directory.
2121

22-
4. Now that the user has authenticated and any backend roles have been retrieved, the Security plugin uses the role mapping to map security roles to the user (or to the user's backend roles).
22+
4. After the user is authenticated and any backend roles are retrieved, the Security plugin uses role mapping to map security roles to the user (or to the user's backend roles).
2323

24-
If the role mapping doesn't include the user (or the user's backend roles), the user successfully authenticates, but has no permissions.
24+
If the role mapping doesn't include the user (or the user's backend roles), the user is successfully authenticated but has no permissions.
2525

2626
5. The user can now perform actions as defined by the mapped security roles. For example, a user might map to the `kibana_user` role and thus have permissions to access Kibana.

0 commit comments

Comments
 (0)