Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Guide [8.17] ›REST APIs

Security APIs

New API reference

For the most up-to-date API details, refer to 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.

  • Authenticate
  • Clear cache
  • Delegate PKI authentication
  • Has privileges
  • SSL certificate
  • Get builtin privileges
  • Get Security settings
  • Update Security settings
  • Get user privileges

Application privileges

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

  • Create or update privileges
  • Clear privileges cache
  • Delete privileges
  • Get privileges

Role mappings

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

  • Create or update role mappings
  • Delete role mappings
  • Get role mappings

Roles

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

  • Create or update roles
  • Bulk create or update roles
  • Clear roles cache
  • Delete roles
  • Bulk delete roles
  • Get roles
  • Query roles

Tokens

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

  • Get token
  • Invalidate token

API Keys

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

  • Create REST API key
  • Grant REST API key
  • Update REST API key
  • Bulk update REST API keys

Use the following APIs to create and update cross-cluster API keys for API key based remote cluster access:

  • Create Cross-Cluster API key
  • Update Cross-Cluster API key

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

  • Get API key
  • Invalidate API key
  • Query API key
  • Clear API key cache

Users

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

  • Create or update users
  • Change passwords
  • Delete users
  • Disable users
  • Enable users
  • Get users
  • Query users

Service Accounts

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

  • Get service accounts
  • Create service account tokens
  • Delete service account token
  • Get service account credentials

OpenID Connect

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

  • Prepare an authentication request
  • Submit an authentication response
  • Logout an authenticated user

SAML

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

  • Prepare an authentication request
  • Submit an authentication response
  • Logout an authenticated user
  • Submit a logout request from the IdP
  • Verify a logout response from the IdP
  • Generate SAML metadata

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.

  • Enroll a new node
  • Enroll a new Kibana instance

User Profile

Use the following APIs to retrieve and manage user profiles.

  • Activate user profile
  • Get user profile
  • Update user profile data
  • Enable user profile
  • Disable user profile
  • Suggest user profile
  • Has Privileges user profile

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API