Security APIs
To use the security APIs, you must set xpack.security.enabled to true in the elasticsearch.yml file.
You can use the following APIs to perform security activities.
Application privileges
You can use the following APIs to add, update, retrieve, and remove application privileges:
Role mappings
You can use the following APIs to add, remove, update, and retrieve role mappings:
Roles
You can use the following APIs to add, remove, update, and retrieve roles in the native realm:
Tokens
You can use the following APIs to create and invalidate bearer tokens for access without requiring basic authentication:
API Keys
You can use the following APIs to create, retrieve and invalidate API keys for access without requiring basic authentication:
Users
You can use the following APIs to add, remove, update, or retrieve users in the native realm:
Service Accounts
You can use the following APIs to list service accounts and manage the service tokens:
OpenID Connect
You can use the following APIs to authenticate users against an OpenID Connect authentication realm when using a custom web application other than Kibana
SAML
You can use the following APIs to authenticate users against a SAML authentication realm when using a custom web application other than Kibana
© 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/7.17/security-api.html