IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elasticsearch Guide [7.7] » REST APIs » Security APIs » Get roles API
« Get role mappings API Get token API »

Get roles APIedit

Retrieves roles in the native realm.

Requestedit

GET /_security/role

GET /_security/role/<name>

Prerequisitesedit

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

Descriptionedit

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 parametersedit

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 bodyedit

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

Response codesedit

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

Examplesedit

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 »