Skip to content

Commit c79f553

Browse files
authored
File based role definition documentation additions (#46304)
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 7a0fdfa commit c79f553

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,9 @@ privilege.
2424
[[security-api-put-role-desc]]
2525
==== {api-description-title}
2626

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

3231
[[security-api-put-role-path-params]]
3332
==== {api-path-parms-title}

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,8 @@ Removes roles in the native realm.
2222
[[security-api-delete-role-desc]]
2323
==== {api-description-title}
2424

25-
The Roles API is generally the preferred way to manage roles, rather than using
26-
file-based role management. For more information about the native realm, see
27-
{stack-ov}/realms.html[Realms] and <<configuring-native-realm>>.
28-
25+
The role management APIs are generally the preferred way to manage roles, rather than using
26+
{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.
2927

3028
[[security-api-delete-role-path-params]]
3129
==== {api-path-parms-title}

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@ privilege.
2323
[[security-api-get-role-desc]]
2424
==== {api-description-title}
2525

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

2930
[[security-api-get-role-path-params]]
3031
==== {api-path-parms-title}

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

Lines changed: 10 additions & 1 deletion
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)