@@ -10,13 +10,18 @@ For other types of realms, you must create _role-mappings_ that define which
10
10
roles should be assigned to each user based on their username, groups, or
11
11
other metadata.
12
12
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
+
13
16
You can define role-mappings via an
14
17
<<mapping-roles-api, API>> or manage them through <<mapping-roles-file, files>>.
15
18
These two sources of role-mapping are combined inside of the {es}
16
19
{security-features}, so it is
17
20
possible for a single user to have some roles that have been mapped through
18
21
the API, and other roles that are mapped through files.
19
22
23
+ NOTE: Users with no roles assigned will be unauthorized for any action.
24
+
20
25
When you use role-mappings, you assign existing roles to users.
21
26
The available roles should either be added using the
22
27
{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,
25
30
you are able to map users to both API-managed roles and file-managed roles
26
31
(and likewise for file-based role-mappings).
27
32
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.
35
35
36
36
[[mapping-roles-api]]
37
37
==== Using the role mapping API
@@ -49,10 +49,10 @@ this.
49
49
By default, role mappings are stored in `ES_PATH_CONF/role_mapping.yml`,
50
50
where `ES_PATH_CONF` is `ES_HOME/config` (zip/tar installations) or
51
51
`/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
56
56
`elasticsearch.yml`.
57
57
58
58
Within 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
67
67
schedules in the system.
68
68
69
69
While 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:
71
71
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
73
73
with physical access to the {es} nodes) would be able to change.
74
74
75
75
. 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
82
82
define roles for all use cases.
83
83
84
84
IMPORTANT: 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.
86
86
87
87
==== Realm specific details
88
88
[discrete]
0 commit comments