@@ -10,13 +10,18 @@ For other types of realms, you must create _role-mappings_ that define which
1010roles should be assigned to each user based on their username, groups, or
1111other metadata.
1212
13+ NOTE: When <<anonymous-access,anonymous access>> is enabled, the roles
14+ of the anonymous user are assigned to all the other users as well.
15+
1316You can define role-mappings via an
1417<<mapping-roles-api, API>> or manage them through <<mapping-roles-file, files>>.
1518These two sources of role-mapping are combined inside of the {es}
1619{security-features}, so it is
1720possible for a single user to have some roles that have been mapped through
1821the API, and other roles that are mapped through files.
1922
23+ NOTE: Users with no roles assigned will be unauthorized for any action.
24+
2025When you use role-mappings, you assign existing roles to users.
2126The available roles should either be added using the
2227{ref}/security-api.html#security-role-apis[role management APIs] or defined in the
@@ -25,13 +30,8 @@ either role management method. For example, when you use the role mapping API,
2530you are able to map users to both API-managed roles and file-managed roles
2631(and likewise for file-based role-mappings).
2732
28- NOTE: The PKI, LDAP, Kerberos and SAML realms support using
29- <<authorization_realms, authorization realms>> as an alternative to role mapping.
30-
31- NOTE: When <<anonymous-access, anonymous access>> is enabled, the roles
32- of the anonymous user are assigned to all the other users as well.
33-
34- NOTE: Users with no roles assigned will be unauthorized for any action.
33+ TIP: The PKI, LDAP, Kerberos, OpenID Connect, and SAML realms support using
34+ <<authorization_realms,authorization realms>> as an alternative to role mapping.
3535
3636[[mapping-roles-api]]
3737==== Using the role mapping API
@@ -49,10 +49,10 @@ this.
4949By default, role mappings are stored in `ES_PATH_CONF/role_mapping.yml`,
5050where `ES_PATH_CONF` is `ES_HOME/config` (zip/tar installations) or
5151`/etc/elasticsearch` (package installations). To specify a different location,
52- you configure the `files.role_mapping` setting in the
53- { ref}/security-settings.html#ref- ad-settings[ Active Directory],
54- { ref}/security-settings.html#ref- ldap-settings[ LDAP] , and
55- { ref}/security-settings.html#ref- pki-settings[ PKI] realm settings in
52+ you configure the `files.role_mapping` setting in the
53+ << ref- ad-settings, Active Directory>>,
54+ << ref- ldap-settings, LDAP>> , and
55+ << ref- pki-settings, PKI>> realm settings in
5656`elasticsearch.yml`.
5757
5858Within the role mapping file, the security roles are keys and groups and users
@@ -67,9 +67,9 @@ this is a common setting in Elasticsearch, changing its value might effect other
6767schedules in the system.
6868
6969While the _role mapping APIs_ is the preferred way to manage role mappings, using
70- the `role_mappings.yml` file becomes useful in a couple of use cases:
70+ the `role_mappings.yml` file becomes useful in a couple of use cases:
7171
72- . If you want to define fixed role mappings that no one (besides an administrator
72+ . If you want to define fixed role mappings that no one (besides an administrator
7373with physical access to the {es} nodes) would be able to change.
7474
7575. If cluster administration depends on users from external realms and these users
@@ -82,7 +82,7 @@ as a minimal administrative function and is not intended to cover and be used to
8282define roles for all use cases.
8383
8484IMPORTANT: You cannot view, edit, or remove any roles that are defined in the role
85- mapping files by using the role mapping APIs.
85+ mapping files by using the role mapping APIs.
8686
8787==== Realm specific details
8888[discrete]
0 commit comments