Get all roles

Base URL: https://{kibana_url}

GET /api/security/role

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Query parameters

Response

200

Indicates a successful call.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/security/role

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/security/role" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

[
  {
    "name": "my_kibana_role",
    "description": "My kibana role description",
    "metadata": {
      "version": 1
    },
    "transient_metadata": {
      "enabled": true
    },
    "elasticsearch": {
      "indices": [],
      "cluster": [],
      "run_as": []
    },
    "kibana": [
      {
        "base": [
          "all"
        ],
        "feature": {},
        "spaces": [
          "*"
        ]
      }
    ]
  },
  {
    "name": "my_admin_role",
    "description": "My admin role description",
    "metadata": {
      "version": 1
    },
    "transient_metadata": {
      "enabled": true
    },
    "elasticsearch": {
      "cluster": [
        "all"
      ],
      "indices": [
        {
          "names": [
            "index1",
            "index2"
          ],
          "privileges": [
            "all"
          ],
          "field_security": {
            "grant": [
              "title",
              "body"
            ]
          },
          "query": "{\\\u0022match\\\u0022: {\\\u0022title\\\u0022: \\\u0022foo\\\u0022}}"
        }
      ]
    },
    "kibana": []
  }
]