Skip to content

Commit b40ac52

Browse files
authored
File based role definition documentation additions (#46304) (#47193)
This commit clarifies and points out that the Role management UI and the Role management API cannot be used to manage roles that are defined in roles.yml and that file based role management is intended to have a small administrative scope and not handle all possible RBAC use cases.
1 parent 5bcb4e6 commit b40ac52

File tree

4 files changed

+18
-11
lines changed

4 files changed

+18
-11
lines changed

x-pack/docs/en/rest-api/security/create-roles.asciidoc

+3-4
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,9 @@ Adds and updates roles in the native realm.
1616

1717
==== Description
1818

19-
The role API is generally the preferred way to manage roles, rather than using
20-
file-based role management. For more information about the native realm, see
21-
{stack-ov}/realms.html[Realms] and <<configuring-native-realm>>.
22-
19+
The role management APIs are generally the preferred way to manage roles, rather than using
20+
{stack-ov}/defining-roles.html#roles-management-file[file-based role management]. The create
21+
or update roles API cannot update roles that are defined in roles files.
2322

2423
==== Path Parameters
2524

x-pack/docs/en/rest-api/security/delete-roles.asciidoc

+2-4
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,8 @@ Removes roles in the native realm.
1414

1515
==== Description
1616

17-
The Roles API is generally the preferred way to manage roles, rather than using
18-
file-based role management. For more information about the native realm, see
19-
{stack-ov}/realms.html[Realms] and <<configuring-native-realm>>.
20-
17+
The role management APIs are generally the preferred way to manage roles, rather than using
18+
{stack-ov}/defining-roles.html#roles-management-file[file-based role management]. The delete roles API cannot remove roles that are defined in roles files.
2119

2220
==== Path Parameters
2321

x-pack/docs/en/rest-api/security/get-roles.asciidoc

+3-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ Retrieves roles in the native realm.
1515

1616
==== Description
1717

18-
For more information about the native realm, see
19-
{stack-ov}/realms.html[Realms] and <<configuring-native-realm>>.
18+
The role management APIs are generally the preferred way to manage roles, rather than using
19+
{stack-ov}/defining-roles.html#roles-management-file[file-based role management]. The get roles
20+
API cannot retrieve roles that are defined in roles files.
2021

2122
==== Path Parameters
2223

x-pack/docs/en/security/authorization/managing-roles.asciidoc

+10-1
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,16 @@ _Role Management APIs_, the role found in the file will be used.
214214
While the _Role Management APIs_ is the preferred mechanism to define roles,
215215
using the `roles.yml` file becomes useful if you want to define fixed roles that
216216
no one (beside an administrator having physical access to the {es} nodes)
217-
would be able to change.
217+
would be able to change. Please note however, that the `roles.yml` file is provided as a
218+
minimal administrative function and is not intended to cover and be used
219+
to define roles for all use cases.
220+
221+
[IMPORTANT]
222+
==============================
223+
You cannot view, edit, or remove any roles that are defined in `roles.yml` by
224+
using the <<roles-management-ui,role management UI>> or the
225+
<<roles-management-api,role management APIs>>.
226+
==============================
218227

219228
[IMPORTANT]
220229
==============================

0 commit comments

Comments
 (0)