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.
Application privileges
Use the following APIs to add, update, retrieve, and remove application privileges:
Role mappings
Use the following APIs to add, remove, update, and retrieve role mappings:
Roles
Use the following APIs to add, remove, update, and retrieve roles in the native realm:
Tokens
Use the following APIs to create and invalidate bearer tokens for access without requiring basic authentication:
API Keys
Use the following APIs to create and update API keys for access via the REST interface without requiring basic authentication:
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:
Users
Use the following APIs to add, remove, update, or retrieve users in the native realm:
Service Accounts
Use the following APIs to list service accounts and manage the service tokens:
OpenID Connect
Use the following APIs to authenticate users against an OpenID Connect authentication realm when using a custom web application other than Kibana
SAML
Use the following APIs to authenticate users against a SAML authentication realm when using a custom web application other than Kibana
Enrollment
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
Use the following APIs to retrieve and manage user profiles.
© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api.html