Get user privileges

GET /_security/user/_privileges

Get the security privileges for the logged in user. 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. To check whether a user has a specific list of privileges, use the has privileges API.

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Response

application/json

applications object[] required
cluster string[] required
remote_cluster object[]
global object[] required
indices object[] required
remote_indices object[]
run_as string[] required

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_security/user/_privileges

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

resp = client.security.get_user_privileges()

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_security/user/_privileges" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.security().getUserPrivileges(g -> g);

C# Elasticsearch .NET Client

var response = await client.Security.GetUserPrivilegesAsync();

PHP Elasticsearch PHP Client

$resp = $client->security()->getUserPrivileges();

Ruby Elasticsearch Ruby Client

response = client.security.get_user_privileges

Response

A successful response from GET /_security/user/_privileges.

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