Get all Kibana roles API

[experimental] This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. Retrieve all Kibana roles.

Prerequisite

To use the get role API, you must have the manage_security cluster privilege.

Request

GET <kibana host>:<port>/api/security/role

Response code

200

Indicates a successful call.

Example

The API returns the following:

  1. [
  2.   {
  3.     "name": "my_kibana_role",
  4.     "metadata" : {
  5.       "version" : 1
  6.     },
  7.     "transient_metadata": {
  8.       "enabled": true
  9.     },
  10.     "elasticsearch": {
  11.       "indices": [ ],
  12.       "cluster": [ ],
  13.       "run_as": [ ]
  14.     },
  15.     "kibana": [{
  16.       "base": [
  17.         "all"
  18.       ],
  19.       "feature": {},
  20.       "spaces": [
  21.         "*"
  22.       ]
  23.     }]
  24.   },
  25.   {
  26.     "name": "my_admin_role",
  27.     "metadata" : {
  28.       "version" : 1
  29.     },
  30.     "transient_metadata": {
  31.       "enabled": true
  32.     },
  33.     "elasticsearch": {
  34.       "cluster" : [ "all" ],
  35.       "indices" : [ {
  36.         "names" : [ "index1", "index2" ],
  37.         "privileges" : [ "all" ],
  38.         "field_security" : {
  39.           "grant" : [ "title", "body" ]
  40.         },
  41.         "query" : "{\"match\": {\"title\": \"foo\"}}"
  42.       } ],
  43.     },
  44.     "kibana": [ ]
  45.   }
  46. ]

Most Popular