Get specific role 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 a specific role.

Prerequisite

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

Request

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

Response code

200

Indicates a successful call.

Example

The API returns the following:

  1. {
  2.   "name": "my_restricted_kibana_role",
  3.   "metadata" : {
  4.     "version" : 1
  5.   },
  6.   "transient_metadata": {
  7.     "enabled": true
  8.   },
  9.   "elasticsearch": {
  10.     "cluster": [ ],
  11.     "indices": [ ],
  12.     "run_as": [ ]
  13.   },
  14.    "kibana": [
  15.     {
  16.       "base": [
  17.         "read"
  18.       ],
  19.       "feature": {},
  20.       "spaces": [
  21.         "marketing"
  22.       ]
  23.     },
  24.     {
  25.       "base": [],
  26.       "feature": {
  27.         "discover": [
  28.           "all"
  29.         ],
  30.         "visualize": [
  31.           "all"
  32.         ],
  33.         "dashboard": [
  34.           "all"
  35.         ],
  36.         "dev_tools": [
  37.           "read"
  38.         ],
  39.         "advancedSettings": [
  40.           "read"
  41.         ],
  42.         "indexPatterns": [
  43.           "read"
  44.         ],
  45.         "timelion": [
  46.           "all"
  47.         ],
  48.         "graph": [
  49.           "all"
  50.         ],
  51.         "apm": [
  52.           "read"
  53.         ],
  54.         "maps": [
  55.           "read"
  56.         ],
  57.         "canvas": [
  58.           "read"
  59.         ],
  60.         "infrastructure": [
  61.           "all"
  62.         ],
  63.         "logs": [
  64.           "all"
  65.         ],
  66.         "uptime": [
  67.           "all"
  68.         ]
  69.       },
  70.       "spaces": [
  71.         "sales",
  72.         "default"
  73.       ]
  74.     }
  75.   ]
  76. }

Most Popular