Get application privileges

GET /_security/privilege/{application}/{name}
GET /_security/privilege/{application}
GET /_security/privilege

To use this API, you must have one of the following privileges:

The read_security cluster privilege (or a greater privilege such as manage_security or all).
The "Manage Application Privileges" global privilege for the application being referenced in the request.

Required authorization

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

Path parameters

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_security/privilege/myapp/read

JavaScript Elasticsearch JavaScript Client

const response = await client.security.getPrivileges({
  application: "myapp",
  name: "read",
});

Python Elasticsearch Python Client

resp = client.security.get_privileges(
    application="myapp",
    name="read",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_security/privilege/myapp/read" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.security().getPrivileges(g -> g
    .application("myapp")
    .name("read")
);

C# Elasticsearch .NET Client

var response = await client.Security
    .GetPrivilegesAsync(d1 => d1
        .Application("myapp")
        .Name(new[] { "read" })
    );

PHP Elasticsearch PHP Client

$resp = $client->security()->getPrivileges([
    "application" => "myapp",
    "name" => "read",
]);

Ruby Elasticsearch Ruby Client

response = client.security.get_privileges(
  application: "myapp",
  name: "read"
)

Response

A successful response from GET /_security/privilege/myapp/read. The response contains information about the read privilege for the app01 application.

{
  "myapp": {
    "read": {
      "application": "myapp",
      "name": "read",
      "actions": [
        "data:read/*",
        "action:login"
      ],
      "metadata": {
        "description": "Read access to myapp"
      }
    }
  }
}