› › ›

API выхода SAML

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

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

Запрос

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 с ответом SAML:

resp = client.security.saml_logout(
    token="46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3",
    refresh_token="mJdXLtmvTUSpoLwMvdBt_w",
)
print(resp)

const response = await client.security.samlLogout({
  token: "46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3",
  refresh_token: "mJdXLtmvTUSpoLwMvdBt_w",
});
console.log(response);

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/8.17/security-api-saml-logout.html