› › ›

API выхода из системы SAML

Отправляет запрос для аннулирования токена доступа и токена обновления.

Этот API предназначен для использования сторонними веб-приложениями, отличными от Kibana. Если вы используете Kibana, см. Настройка однократного входа SAML.

Запрос

POST /_security/saml/logout

Описание

Этот API аннулирует токены, сгенерированные для пользователя API аутентификации SAML.

Если область SAML в Elasticsearch настроена соответствующим образом, и SAML IdP поддерживает эту функцию, ответ Elasticsearch содержит URL-адрес для перенаправления пользователя в IdP, содержащий запрос на выход SAML (начало SP-инициализированного однократного выхода SAML).

Elasticsearch предоставляет всю необходимую функциональность SAML через API SAML. Эти API используются внутри Kibana для обеспечения аутентификации на основе SAML, но также могут использоваться другими сторонними веб-приложениями или другими клиентами. См. также API аутентификации SAML, API подготовки аутентификации SAML, API аннулирования SAML и API завершения выхода SAML.

Тело запроса

token: (Обязательно, строка) Токен доступа, который был возвращен в ответ на вызов API аутентификации SAML. В качестве альтернативы, самый последний токен, полученный после обновления исходного с помощью refresh_token.
refresh_token: (Необязательно, строка) Токен обновления, который был возвращен в ответ на вызов API аутентификации SAML. В качестве альтернативы, самый последний токен обновления, полученный после обновления исходного токена доступа.

Тело ответа

redirect: (строка) URL, который содержит запрос на выход SAML в качестве параметра. Пользователь может использовать этот URL для перенаправления обратно в SAML IdP и для инициирования однократного выхода.

Примеры

Следующий пример аннулирует пару токенов, сгенерированных при успешном вызове API аутентификации SAML:

POST /_security/saml/logout
{
  "token" : "46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3",
  "refresh_token" : "mJdXLtmvTUSpoLwMvdBt_w"
}

API возвращает следующий ответ:

{
  "redirect" : "https://my-idp.org/logout/SAMLRequest=...."
}

© 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-saml-logout.html