Skip to content

Commit 3692ee0

Browse files
committed
Reconciles the Roles page
The Roles page is duplicated and exists in both the Deploy and manage and the Reference sections. The content is starting to drift, so I'm editing the page in the Reference section to reconcile the information. Refers to [#2738](elastic/docs-content#2738)
1 parent 4311844 commit 3692ee0

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

docs/reference/elasticsearch/roles.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,28 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/built-in-roles.html
4+
applies_to:
5+
stack: all
46
---
57

68
# Roles [built-in-roles]
79

8-
:::{note}
910
This section provides detailed **reference information** for Elasticsearch privileges.
1011

11-
Refer to [User roles](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/user-roles.md) in the **Deploy and manage** section for overview, getting started and conceptual information.
12-
:::
12+
If you're using a stack-versioned deployment such as a self-managed cluster, {{ech}}, {{eck}}, or {{ece}}, then refer to [User roles](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/user-roles.md) for more information on how role-based access control works.
1313

1414
The {{stack-security-features}} apply a default role to all users, including [anonymous users](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/anonymous-access.md). The default role enables users to access the authenticate endpoint, change their own passwords, and get information about themselves.
1515

1616
There is also a set of built-in roles you can explicitly assign to users. These roles have a fixed set of privileges and cannot be updated.
1717

18+
When you assign a user multiple roles, the user receives a union of the roles’ privileges.
19+
20+
If the built-in roles do not address your use case, then you can create additional [custom roles](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles.md).
21+
22+
[Learn how to assign roles to users](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/user-roles.md#assign-roles-to-users).
23+
24+
## Roles
25+
1826
$$$built-in-roles-apm-system$$$ `apm_system`
1927
: Grants access necessary for the APM system user to send system-level data (such as monitoring) to {{es}}.
2028

@@ -71,10 +79,12 @@ $$$built-in-roles-kibana-system$$$ `kibana_system`
7179

7280

7381
$$$built-in-roles-kibana-admin$$$ `kibana_admin`
74-
: Grants access to all features in {{kib}}. For more information on {{kib}} authorization, see [Kibana authorization](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md).
82+
: Grants access to all {{kib}} features in all spaces. For more information on {{kib}} authorization, see [Kibana authorization](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md).
83+
84+
$$$built-in-roles-kibana-user$$$ `kibana_user` {applies_to}`stack: deprecated`
85+
: This role is deprecated, use the [`kibana_admin`](#built-in-roles-kibana-admin) role instead. Grants access to all features in {{kib}}.
7586

76-
$$$built-in-roles-kibana-user$$$ `kibana_user`
77-
: (This role is deprecated, please use the [`kibana_admin`](#built-in-roles-kibana-admin) role instead.) Grants access to all features in {{kib}}. For more information on {{kib}} authorization, see [Kibana authorization](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md).
87+
For more information on {{kib}} authorization, see [Kibana authorization](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md).
7888

7989
$$$built-in-roles-logstash-admin$$$ `logstash_admin`
8090
: Grants access to the `.logstash*` indices for managing configurations, and grants necessary access for logstash-specific APIs exposed by the logstash x-pack plugin.
@@ -104,8 +114,10 @@ $$$built-in-roles-remote-monitoring-agent$$$ `remote_monitoring_agent`
104114
$$$built-in-roles-remote-monitoring-collector$$$ `remote_monitoring_collector`
105115
: Grants the minimum privileges required to collect monitoring data for the {{stack}}.
106116

107-
$$$built-in-roles-reporting-user$$$ `reporting_user`
108-
: Grants the necessary privileges required to use {{report-features}} in {{kib}}, including generating and downloading reports. This role implicitly grants access to all Kibana reporting features, with each user having access only to their own reports. Note that reporting users should also be assigned additional roles that grant read access to the [indices](https://www.elastic.co/guide/en/elasticsearch/reference/current/defining-roles.html#roles-indices-priv) that will be used to generate reports.
117+
$$$built-in-roles-reporting-user$$$ `reporting_user` {applies_to}`stack: deprecated 9.0`
118+
: This role is deprecated. Use [{{kib}} feature privileges](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/kibana-privileges.md#kibana-feature-privileges) instead.
119+
120+
Grants the necessary privileges required to use {{report-features}} in {{kib}}, including generating and downloading reports. This role implicitly grants access to all {{kib}} reporting features, with each user having access only to their own reports. Note that reporting users should also be assigned additional roles that grant read access to the [indices](https://www.elastic.co/guide/en/elasticsearch/reference/current/defining-roles.html#roles-indices-priv) that will be used to generate reports.
109121

110122
$$$built-in-roles-rollup-admin$$$ `rollup_admin`
111123
: Grants `manage_rollup` cluster privileges, which enable you to manage and execute all rollup actions.

0 commit comments

Comments
 (0)