Skip to content

Commit 16fb8b8

Browse files
authored
Reconciles the Roles page (#133831)
* 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) * Fixing more differences * Fix link structure * Adding note to serverless roles + minor fixes * Peer review feedback edits
1 parent 656a7a9 commit 16fb8b8

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

docs/reference/elasticsearch/roles.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,31 @@
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}
9-
This section provides detailed **reference information** for Elasticsearch privileges.
10+
This section provides detailed **reference information** for {{es}} roles.
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+
To learn how to apply roles for {{stack}}, and to learn how role-based access control works, refer to [User roles](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/user-roles.md).
13+
14+
15+
:::{tip}
16+
{{serverless-full}} uses a different set of predefined roles. To learn more about the roles available in {{serverless-short}} projects, refer to [Elastic Cloud Serverless predefined roles](docs-content://deploy-manage/users-roles/cloud-organization/user-roles.md#general-assign-user-roles-table).
1217
:::
1318

1419
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.
1520

1621
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.
1722

23+
When you assign a user multiple roles, the user receives a union of the roles’ privileges.
24+
25+
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).
26+
27+
## Available roles [available-roles]
28+
1829
$$$built-in-roles-apm-system$$$ `apm_system`
1930
: Grants access necessary for the APM system user to send system-level data (such as monitoring) to {{es}}.
2031

@@ -59,8 +70,8 @@ $$$built-in-roles-ingest-user$$$ `ingest_admin`
5970
::::
6071

6172

62-
$$$built-in-roles-kibana-dashboard$$$ `kibana_dashboard_only_user`
63-
: (This role is deprecated, please use [{{kib}} feature privileges](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/kibana-privileges.md#kibana-feature-privileges) instead). Grants read-only access to the {{kib}} Dashboard in every [space in {{kib}}](docs-content://deploy-manage/manage-spaces.md). This role does not have access to editing tools in {{kib}}.
73+
$$$built-in-roles-kibana-dashboard$$$ `kibana_dashboard_only_user` {applies_to}`stack: deprecated`
74+
: 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. Grants read-only access to the {{kib}} Dashboard in every [space in {{kib}}](docs-content://deploy-manage/manage-spaces.md). This role does not have access to editing tools in {{kib}}.
6475

6576
$$$built-in-roles-kibana-system$$$ `kibana_system`
6677
: Grants access necessary for the {{kib}} system user to read from and write to the {{kib}} indices, manage index templates and tokens, and check the availability of the {{es}} cluster. It also permits activating, searching, and retrieving user profiles, as well as updating user profile data for the `kibana-*` namespace. This role grants read access to the `.monitoring-*` indices and read and write access to the `.reporting-*` indices. For more information, see [Configuring Security in {{kib}}](docs-content://deploy-manage/security/secure-your-cluster-deployment.md).
@@ -71,10 +82,12 @@ $$$built-in-roles-kibana-system$$$ `kibana_system`
7182

7283

7384
$$$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).
85+
: 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).
86+
87+
$$$built-in-roles-kibana-user$$$ `kibana_user` {applies_to}`stack: deprecated`
88+
: This role is deprecated. Use the [`kibana_admin`](#built-in-roles-kibana-admin) role instead. Grants access to all features in {{kib}}.
7589

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).
90+
For more information on {{kib}} authorization, see [Kibana authorization](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md).
7891

7992
$$$built-in-roles-logstash-admin$$$ `logstash_admin`
8093
: 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 +117,10 @@ $$$built-in-roles-remote-monitoring-agent$$$ `remote_monitoring_agent`
104117
$$$built-in-roles-remote-monitoring-collector$$$ `remote_monitoring_collector`
105118
: Grants the minimum privileges required to collect monitoring data for the {{stack}}.
106119

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.
120+
$$$built-in-roles-reporting-user$$$ `reporting_user` {applies_to}`stack: deprecated 9.0`
121+
: 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.
122+
123+
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](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/role-structure.md#roles-indices-priv) that will be used to generate reports.
109124

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

0 commit comments

Comments
 (0)