› › ›

API ключа API для аннулирования

Аннулирует один или несколько API-ключей.

Запрос

DELETE /_security/api_key

Предварительные условия

Для использования этого API необходимо иметь как минимум право manage_api_key кластера.

Описание

API-ключи, созданные с помощью API создания API-ключей, могут быть аннулированы с помощью этого API.

Тело запроса

В теле запроса DELETE можно указать следующие параметры, относящиеся к аннулированию API-ключей:

id: [7.12.0] Устарело в 7.12.0. Используйте вместо этого ids (Необязательно, строка) Идентификатор API-ключа. Этот параметр нельзя использовать, если используется любой из параметров ids, name, realm_name или username.
ids: (Необязательно, массив строк) Список идентификаторов API-ключей. Этот параметр нельзя использовать, если используется любой из параметров id, name, realm_name, username
name: (Необязательно, строка) Название API-ключа. Этот параметр нельзя использовать с любым из параметров id, ids, realm_name или username.
realm_name: (Необязательно, строка) Название области аутентификации. Этот параметр нельзя использовать ни с id, ids, ни с name, а также когда флаг owner установлен в значение true.
username: (Необязательно, строка) Имя пользователя. Этот параметр нельзя использовать ни с id, ids, ни с name, а также когда флаг owner установлен в значение true.
owner: (Необязательно, булево) Булевый флаг, который можно использовать для запроса API-ключей, принадлежащих текущему аутентифицированному пользователю. По умолчанию равен false. Параметры realm_name или username нельзя указать, когда этот параметр установлен в true, так как предполагается, что они относятся к текущему аутентифицированному пользователю.

Если "owner" равен "false" (по умолчанию), необходимо указать хотя бы один из параметров "id", "ids", "name", "username" и "realm_name".

Тело ответа

При успешном вызове возвращается JSON-структура, содержащая идентификаторы аннулированных API-ключей, идентификаторы API-ключей, которые уже были аннулированы, и потенциально список ошибок, возникших при аннулировании конкретных API-ключей.

Примеры

Если вы создаете API-ключ следующим образом:

POST /_security/api_key
{
  "name": "my-api-key"
}

При успешном вызове возвращается JSON-структура, содержащая информацию об API-ключе. Например:

{
  "id": "VuaCfGcBCdbkQm-e5aOx",
  "name": "my-api-key",
  "api_key": "ui2lp2axTNmsyakw9tvNnw",
  "encoded": "VnVhQ2ZHY0JDZGJrUW0tZTVhT3g6dWkybHAyYXhUTm1zeWFrdzl0dk5udw=="
}

Следующий пример аннулирует API-ключ, идентифицированный указанным ids, немедленно:

DELETE /_security/api_key
{
  "ids" : [ "VuaCfGcBCdbkQm-e5aOx" ]
}

Следующий пример аннулирует API-ключ, идентифицированный указанным name, немедленно:

DELETE /_security/api_key
{
  "name" : "my-api-key"
}

Следующий пример аннулирует все API-ключи для области native1 немедленно:

DELETE /_security/api_key
{
  "realm_name" : "native1"
}

Следующий пример аннулирует все API-ключи для пользователя myuser во всех областях немедленно:

DELETE /_security/api_key
{
  "username" : "myuser"
}

Следующий пример аннулирует API-ключ, идентифицированный указанным ids, если он принадлежит текущему аутентифицированному пользователю немедленно:

DELETE /_security/api_key
{
  "ids" : ["VuaCfGcBCdbkQm-e5aOx"],
  "owner" : "true"
}

Следующий пример аннулирует все API-ключи, принадлежащие текущему аутентифицированному пользователю, немедленно:

DELETE /_security/api_key
{
  "owner" : "true"
}

И, наконец, следующий пример аннулирует все API-ключи для пользователя myuser в области native1 немедленно:

DELETE /_security/api_key
{
  "username" : "myuser",
  "realm_name" : "native1"
}

{
  "invalidated_api_keys": [ 
    "api-key-id-1"
  ],
  "previously_invalidated_api_keys": [ 
    "api-key-id-2",
    "api-key-id-3"
  ],
  "error_count": 2, 
  "error_details": [ 
    {
      "type": "exception",
      "reason": "error occurred while invalidating api keys",
      "caused_by": {
        "type": "illegal_argument_exception",
        "reason": "invalid api key id"
      }
    },
    {
      "type": "exception",
      "reason": "error occurred while invalidating api keys",
      "caused_by": {
        "type": "illegal_argument_exception",
        "reason": "invalid api key id"
      }
    }
  ]
}

	Идентификаторы API-ключей, которые были аннулированы в рамках этого запроса.
	Идентификаторы API-ключей, которые уже были аннулированы.
	Количество ошибок, возникших при аннулировании API-ключей.
	Подробная информация об этих ошибках. Этот параметр отсутствует в ответе, когда значение `error_count` равно 0.

© 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-invalidate-api-key.html