Security APIs

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.

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

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

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

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

Use the following APIs to create and update API keys for access via the REST interface without requiring basic authentication:

[beta] This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features. Use the following APIs to create and update cross-cluster API keys for API key based remote cluster access:

Use the following APIs to retrieve and invalidate API keys of all types:

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

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

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

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

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.

Use the following APIs to retrieve and manage user profiles.