Security APIs

edit

To use the security APIs, you must set xpack.security.enabled to true in the elasticsearch.yml file.

Use the following APIs to perform security activities.

Application privileges

edit

Use the following APIs to add, update, retrieve, and remove application privileges:

Role mappings

edit

Use the following APIs to add, remove, update, and retrieve role mappings:

Roles

edit

Use the following APIs to add, remove, update, and retrieve roles in the native realm:

Tokens

edit

Use the following APIs to create and invalidate bearer tokens for access without requiring basic authentication:

API Keys

edit

Use the following APIs to create, retrieve and invalidate API keys for access without requiring basic authentication:

Users

edit

Use the following APIs to add, remove, update, or retrieve users in the native realm:

Service Accounts

edit

Use the following APIs to list service accounts and manage the service tokens:

OpenID Connect

edit

Use the following APIs to authenticate users against an OpenID Connect authentication realm when using a custom web application other than Kibana

SAML

edit

Use the following APIs to authenticate users against a SAML authentication realm when using a custom web application other than Kibana

Enrollment

edit

Use the following APIs to enable new nodes to join an existing cluster with security enabled, or to enable a Kibana instance to configure itself to communicate with a secured Elasticsearch cluster.

User Profile

edit

Use the following APIs to retrieve and manage user profiles.