2018-08-13 18:06:25 +02:00
|
|
|
[role="xpack"]
|
|
|
|
[[role-management-api]]
|
2019-10-16 22:10:40 +02:00
|
|
|
== {kib} role management APIs
|
2018-08-13 18:06:25 +02:00
|
|
|
|
2019-09-06 18:09:57 +02:00
|
|
|
Manage the roles that grant <<kibana-privileges, Kibana privileges>>.
|
2018-08-13 18:06:25 +02:00
|
|
|
|
2019-09-06 18:09:57 +02:00
|
|
|
WARNING: Do not use the {ref}/security-api.html#security-role-apis[{es} role management APIs] to manage {kib} roles.
|
2018-08-13 18:06:25 +02:00
|
|
|
|
2019-10-16 22:10:40 +02:00
|
|
|
The following {kib} role management APIs are available:
|
|
|
|
|
|
|
|
* <<role-management-api-put, Create or update role API>> to create a new {kib} role, or update the attributes of an existing role
|
|
|
|
|
|
|
|
* <<role-management-api-get, Get all {kib} roles API>> to retrieve all {kib} roles
|
|
|
|
|
|
|
|
* <<role-management-specific-api-get, Get specific role API>> to retrieve a specific role
|
|
|
|
|
|
|
|
* <<role-management-api-delete, Delete role API>> to delete a {kib} role
|
2018-08-13 18:06:25 +02:00
|
|
|
|
|
|
|
include::role-management/put.asciidoc[]
|
|
|
|
include::role-management/get.asciidoc[]
|
2019-09-06 18:09:57 +02:00
|
|
|
include::role-management/get-all.asciidoc[]
|
2018-08-13 18:06:25 +02:00
|
|
|
include::role-management/delete.asciidoc[]
|