Get application privileges

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

Auth

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.

The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, the API returns information about all privileges for all applications.

Leave it out to use /_security/privilege.

name union string | string[] optional

The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application.

Leave it out to use /_security/privilege.

Response

application/json

Response Type: map string to string to object

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"
      }
    }
  }
}

Get application privileges

Required authorization

Path parameters

Response