Spec-Zone.ru › Elasticsearch 7
›Elasticsearch Guide [7.17] ›REST APIs

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.

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

Application privileges

You can 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

You can use the following APIs to add, remove, update, and retrieve role mappings:

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

Roles

You can use the following APIs to add, remove, update, and retrieve roles in the native realm:

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

Tokens

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

  • Get token
  • Invalidate token

API Keys

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

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

Users

You can 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

Service Accounts

You can 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

You can 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

You can 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

© 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

Spec-Zone.ru

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