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.
« Get specific role API Delete role API »
Elastic Docs ›Kibana Guide [7.4] ›REST API ›Kibana role management APIs

Get all Kibana roles API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get all Kibana roles API

edit

Retrieves all Kibana roles.

The underlying mechanism of enforcing role-based access control is stable, but the APIs for managing the roles are experimental.

Prerequisite

edit

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

Request

edit

GET /api/security/role

Response code

edit
200
Indicates a successful call.

Example

edit

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": [ ]
  }
]
« Get specific role API Delete role API »
Was this helpful?
Feedback