Get all Kibana roles APIedit
Retrieve all Kibana roles.
The underlying mechanism of enforcing role-based access control is stable, but the APIs for managing the roles are experimental.
Prerequisiteedit
To use the get role API, you must have the manage_security cluster privilege.
Requestedit
GET /api/security/role
Response codeedit
-
200 - Indicates a successful call.
Exampleedit
The API returns the following:
[
{
"name": "my_kibana_role",
"metadata" : {
"version" : 1
},
"transient_metadata": {
"enabled": true
},
"elasticsearch": {
"indices": [ ],
"cluster": [ ],
"run_as": [ ]
},
"kibana": [{
"base": [
"all"
],
"feature": {},
"spaces": [
"*"
]
}]
},
{
"name": "my_admin_role",
"metadata" : {
"version" : 1
},
"transient_metadata": {
"enabled": true
},
"elasticsearch": {
"cluster" : [ "all" ],
"indices" : [ {
"names" : [ "index1", "index2" ],
"privileges" : [ "all" ],
"field_security" : {
"grant" : [ "title", "body" ]
},
"query" : "{\"match\": {\"title\": \"foo\"}}"
} ],
},
"kibana": [ ]
}
]