New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Create or update role API Get all Kibana roles API »
Elastic Docs ›Kibana Guide [7.12] ›REST API ›Kibana role management APIs

Get specific role API

edit

Get specific role API

edit

[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Retrieve a specific role.

Prerequisite

edit

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

Request

edit

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

Response code

edit
200
Indicates a successful call.

Example

edit

The API returns the following:

{
  "name": "my_restricted_kibana_role",
  "metadata" : {
    "version" : 1
  },
  "transient_metadata": {
    "enabled": true
  },
  "elasticsearch": {
    "cluster": [ ],
    "indices": [ ],
    "run_as": [ ]
  },
   "kibana": [
    {
      "base": [
        "read"
      ],
      "feature": {},
      "spaces": [
        "marketing"
      ]
    },
    {
      "base": [],
      "feature": {
        "discover": [
          "all"
        ],
        "visualize": [
          "all"
        ],
        "dashboard": [
          "all"
        ],
        "dev_tools": [
          "read"
        ],
        "advancedSettings": [
          "read"
        ],
        "indexPatterns": [
          "read"
        ],
        "timelion": [
          "all"
        ],
        "graph": [
          "all"
        ],
        "apm": [
          "read"
        ],
        "maps": [
          "read"
        ],
        "canvas": [
          "read"
        ],
        "infrastructure": [
          "all"
        ],
        "logs": [
          "all"
        ],
        "uptime": [
          "all"
        ]
      },
      "spaces": [
        "sales",
        "default"
      ]
    }
  ]
}
« Create or update role API Get all Kibana roles API »

On this page

Was this helpful?
Feedback