Skip to content

[7.2] File based role definition documentation additions (#46304) #47193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 27, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions x-pack/docs/en/rest-api/security/create-roles.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,9 @@ Adds and updates roles in the native realm.

==== Description

The role API is generally the preferred way to manage roles, rather than using
file-based role management. For more information about the native realm, see
{stack-ov}/realms.html[Realms] and <<configuring-native-realm>>.

The role management APIs are generally the preferred way to manage roles, rather than using
{stack-ov}/defining-roles.html#roles-management-file[file-based role management]. The create
or update roles API cannot update roles that are defined in roles files.

==== Path Parameters

Expand Down
6 changes: 2 additions & 4 deletions x-pack/docs/en/rest-api/security/delete-roles.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,8 @@ Removes roles in the native realm.

==== Description

The Roles API is generally the preferred way to manage roles, rather than using
file-based role management. For more information about the native realm, see
{stack-ov}/realms.html[Realms] and <<configuring-native-realm>>.

The role management APIs are generally the preferred way to manage roles, rather than using
{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.

==== Path Parameters

Expand Down
5 changes: 3 additions & 2 deletions x-pack/docs/en/rest-api/security/get-roles.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@ Retrieves roles in the native realm.

==== Description

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

==== Path Parameters

Expand Down
11 changes: 10 additions & 1 deletion x-pack/docs/en/security/authorization/managing-roles.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,16 @@ _Role Management APIs_, the role found in the file will be used.
While the _Role Management APIs_ is the preferred mechanism to define roles,
using the `roles.yml` file becomes useful if you want to define fixed roles that
no one (beside an administrator having physical access to the {es} nodes)
would be able to change.
would be able to change. Please note however, that the `roles.yml` file is provided as a
minimal administrative function and is not intended to cover and be used
to define roles for all use cases.

[IMPORTANT]
==============================
You cannot view, edit, or remove any roles that are defined in `roles.yml` by
using the <<roles-management-ui,role management UI>> or the
<<roles-management-api,role management APIs>>.
==============================

[IMPORTANT]
==============================
Expand Down