Create or update application privileges

POST also PUT /_security/privilege

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

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

Application names are formed from a prefix, with an optional suffix that conform to the following rules:

The prefix must begin with a lowercase ASCII letter.
The prefix must contain only ASCII letters or digits.
The prefix must be at least 3 characters long.
If the suffix exists, it must begin with either a dash - or _.
The suffix cannot contain any of the following characters: \, /, *, ?, ", <, >, |, ,, *.
No part of the name can contain whitespace.

Privilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters _, -, and ..

Action names can contain any number of printable ASCII characters and must contain at least one of the following characters: /, *, :.

About Elasticsearch privileges

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

Query parameters

Request body

Response

application/json

Examples

Request Console 1 / 8 languages

Run POST /_security/privilege to add a single application privilege. The wildcard (*) means that this privilege grants access to all actions that start with data:read/. Elasticsearch does not assign any meaning to these actions. However, if the request includes an application privilege such as data:read/users or data:read/settings, the has privileges API respects the use of a wildcard and returns true.

Console Kibana Dev Tools

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

JavaScript Elasticsearch JavaScript Client

const response = await client.security.putPrivileges({
  privileges: {
    myapp: {
      read: {
        actions: ["data:read/*", "action:login"],
        metadata: {
          description: "Read access to myapp",
        },
      },
    },
  },
});

Python Elasticsearch Python Client

resp = client.security.put_privileges(
    privileges={
        "myapp": {
            "read": {
                "actions": [
                    "data:read/*",
                    "action:login"
                ],
                "metadata": {
                    "description": "Read access to myapp"
                }
            }
        }
    },
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_security/privilege" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "myapp": {
      "read": {
        "actions": [
          "data:read/*",
          "action:login"
        ],
        "metadata": {
          "description": "Read access to myapp"
        }
      }
    }
  }'

Java Elasticsearch Java Client

client.security().putPrivileges(p -> p
    .privileges("myapp", Map.of("read", Actions.of(a -> a
            .actions(List.of("data:read/*","action:login"))
            .metadata("description", JsonData.fromJson("\"Read access to myapp\""))
        )))
);

C# Elasticsearch .NET Client

var response = await client.Security
    .PutPrivilegesAsync(d1 => d1
        .Privileges(new Dictionary<string, IDictionary<string,PrivilegeActions>>()
        {
            { "myapp", new Dictionary<string, PrivilegeActions>()
            {
                { "read", new()
                {
                    Actions = ["data:read/*", "action:login"],
                    Metadata = new Dictionary<string, object>()
                    {
                        { "description", "Read access to myapp" }
                    }
                } }
            } }
        })
    );

PHP Elasticsearch PHP Client

$resp = $client->security()->putPrivileges([
    "body" => [
        "myapp" => [
            "read" => [
                "actions" => array(
                    "data:read/*",
                    "action:login",
                ),
                "metadata" => [
                    "description" => "Read access to myapp",
                ],
            ],
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.security.put_privileges(
  body: {
    "myapp": {
      "read": {
        "actions": [
          "data:read/*",
          "action:login"
        ],
        "metadata": {
          "description": "Read access to myapp"
        }
      }
    }
  }
)

Response

A successful response from PUT /_security/privilege.

{
  "myapp": {
    "read": {
      "created": true 
    }
  }
}

Request Console 1 / 2 languages

Run POST /_security/privilege to add multiple application privileges.

Console Kibana Dev Tools

POST /_security/privilege
{
  "app01": {
    "read": {
      "actions": [ "action:login", "data:read/*" ]
    },
    "write": {
      "actions": [ "action:login", "data:write/*" ]
    }
  },
  "app02": {
    "all": {
      "actions": [ "*" ]
    }
  }
}

Generated from the API spec

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_security/privilege" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "app01": {
      "read": {
        "actions": [ "action:login", "data:read/*" ]
      },
      "write": {
        "actions": [ "action:login", "data:write/*" ]
      }
    },
    "app02": {
      "all": {
        "actions": [ "*" ]
      }
    }
  }'

Generated from the API spec

Response

A successful response from PUT /_security/privilege.

{
  "myapp": {
    "read": {
      "created": true 
    }
  }
}