Document level security

Document level security restricts the documents that users have read access to. In particular, it restricts which documents can be accessed from document-based read APIs.

To enable document level security, you use a query to specify the documents that each role can access. The document query is associated with a particular data stream, index, or wildcard (*) pattern and operates in conjunction with the privileges specified for the data streams and indices.

The following role definition grants read access only to documents that belong to the click category within all the events-* data streams and indices:

  1. POST /_security/role/click_role
  2. {
  3.   "indices": [
  4.     {
  5.       "names": [ "events-*" ],
  6.       "privileges": [ "read" ],
  7.       "query": "{\"match\": {\"category\": \"click\"}}"
  8.     }
  9.   ]
  10. }

Omitting the query entry entirely disables document level security for the respective indices permission entry.

The specified query expects the same format as if it was defined in the search request and supports the full Elasticsearch Query DSL.

For example, the following role grants read access only to the documents whose department_id equals 12:

  1. POST /_security/role/dept_role
  2. {
  3.   "indices" : [
  4.     {
  5.       "names" : [ "*" ],
  6.       "privileges" : [ "read" ],
  7.       "query" : {
  8.         "term" : { "department_id" : 12 }
  9.       }
  10.     }
  11.   ]
  12. }

query also accepts queries written as string values.

For more information, see Setting up field and document level security.