Skip to content

Commit

Permalink
[DOCS] Creates redirects for role management APIs page
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Aug 18, 2018
1 parent 595516e commit fdc8ece
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 13 deletions.
9 changes: 9 additions & 0 deletions docs/reference/redirects.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -498,3 +498,12 @@ guide to the {painless}/index.html[Painless Scripting Language].

See the {painless}/painless-api-reference.html[Painless API Reference] in
the guide to the {painless}/index.html[Painless Scripting Language].

[role="exclude", id="security-api-roles"]
=== Role management APIs

You can use the following APIs to add, remove, and retrieve roles in the native realm:

* <<security-api-put-role,Create role>>, <<security-api-delete-role,Delete role>>
* <<security-api-clear-role-cache,Clear roles cache>>
* <<security-api-get-role,Get roles>>
10 changes: 9 additions & 1 deletion x-pack/docs/en/rest-api/security.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,15 @@ You can use the following APIs to perform {security} activities.
* <<security-api-tokens>>
* <<security-api-users>>

include::security/roles.asciidoc[]
[float]
[[security-role-apis]]
=== Roles

You can use the following APIs to add, remove, and retrieve roles in the native realm:

* <<security-api-put-role,Create role>>, <<security-api-delete-role,Delete role>>
* <<security-api-clear-role-cache,Clear roles cache>>
* <<security-api-get-role,Get roles>>

include::security/authenticate.asciidoc[]
include::security/change-password.asciidoc[]
Expand Down
2 changes: 1 addition & 1 deletion x-pack/docs/en/rest-api/security/role-mapping.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Role mappings have _rules_ that identify users and a list of _roles_ that are
granted to those users.

NOTE: This API does not create roles. Rather, it maps users to existing roles.
Roles can be created by using <<security-api-roles, Role Management APIs>> or
Roles can be created by using <<security-role-apis,role management APIs>> or
{xpack-ref}/defining-roles.html#roles-management-file[roles files].

The role mapping rule is a logical condition that is expressed using a JSON DSL.
Expand Down
9 changes: 0 additions & 9 deletions x-pack/docs/en/rest-api/security/roles.asciidoc

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ manage roles, log in to {kib} and go to *Management / Elasticsearch / Roles*.
The _Role Management APIs_ enable you to add, update, remove and retrieve roles
dynamically. When you use the APIs to manage roles in the `native` realm, the
roles are stored in an internal {es} index. For more information and examples,
see {ref}/security-api.html#security-api-roles[role management APIs].
see {ref}/security-api.html#security-role-apis[role management APIs].

[float]
[[roles-management-file]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ the API, and other roles that are mapped through files.

When you use role-mappings, you assign existing roles to users.
The available roles should either be added using the
{ref}/security-api.html#security-api-roles[role management APIs] or defined in the
{ref}/security-api.html#security-role-apis[role management APIs] or defined in the
<<roles-management-file, roles file>>. Either role-mapping method can use
either role management method. For example, when you use the role mapping API,
you are able to map users to both API-managed roles and file-managed roles
Expand Down

0 comments on commit fdc8ece

Please sign in to comment.