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

› › ›

Get user privileges API

edit

Get user privileges API

edit

Retrieves the security privileges for the logged in user.

Request

edit

GET /_security/user/_privileges

Prerequisites

edit

All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature. For more information, see Submitting requests on behalf of other users.

Description

edit

To check whether a user has a specific list of privileges, use the has privileges API.

Examples

edit

resp = client.security.get_user_privileges()
print(resp)

const response = await client.security.getUserPrivileges();
console.log(response);

GET /_security/user/_privileges

{
  "cluster" : [
    "all"
  ],
  "global" : [ ],
  "indices" : [
    {
      "names" : [
        "*"
      ],
      "privileges" : [
        "all"
      ],
      "allow_restricted_indices" : true
    }
  ],
  "applications" : [
    {
      "application" : "*",
      "privileges" : [
        "*"
      ],
      "resources" : [
        "*"
      ]
    }
  ],
  "run_as" : [
    "*"
  ]
}

« Get token API Get users API »