IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › ›

Get roles API

edit

Get roles API

edit

Retrieves roles in the native realm.

Request

edit

GET /_security/role

GET /_security/role/<name>

Prerequisites

edit

To use this API, you must have at least the manage_security cluster privilege.

Description

edit

The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files.

Path parameters

edit

name: (Optional, string) The name of the role. You can specify multiple roles as a comma-separated list. If you do not specify this parameter, the API returns information about all roles.

Response body

edit

A successful call returns an array of roles with the JSON representation of the role.

Response codes

edit

If the role is not defined in the native realm, the request returns 404.

Examples

edit

The following example retrieves information about the my_admin_role role in the native realm:

GET /_security/role/my_admin_role

{
  "my_admin_role": {
    "cluster" : [ "all" ],
    "indices" : [
      {
        "names" : [ "index1", "index2" ],
        "privileges" : [ "all" ],
        "allow_restricted_indices" : false,
        "field_security" : {
          "grant" : [ "title", "body" ]}
      }
    ],
    "applications" : [ ],
    "run_as" : [ "other_user" ],
    "metadata" : {
      "version" : 1
    },
    "transient_metadata": {
      "enabled": true
    }
  }
}

To retrieve all roles, omit the role name:

GET /_security/role

« Get role mappings API Get token API »