› › ›

Полный API выхода из системы SAML

Проверяет ответ о выходе из системы, отправленный SAML IdP.

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

Запрос

POST /_security/saml/complete_logout

Описание

SAML IdP может отправить ответ о выходе из системы обратно в SP после обработки инициированного SP выхода SAML Single Logout. Этот API проверяет ответ, убеждаясь, что содержимое актуально и его подпись валидна. Если процесс проверки успешен, возвращается пустой ответ. Ответ может быть отправлен IdP с помощью привязки HTTP-Redirect или HTTP-Post. Вызывающий API должен подготовить запрос соответствующим образом, чтобы этот API мог обработать любой из них.

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

Тело запроса

realm: (Обязательно, строка) Название SAML области в Elasticsearch, для которой используется конфигурация для проверки ответа о выходе из системы.
ids: (Обязательно, массив) Массив JSON со всеми допустимыми идентификаторами запросов SAML, имеющимися у вызывающего API для текущего пользователя.
query_string: (Необязательно, строка) Если SAML IdP отправляет ответ о выходе из системы с помощью привязки HTTP-Redirect, это поле должно быть установлено в строку запроса URI перенаправления.
queryString: [7.14.0] Устарело в 7.14.0. Используйте query_string вместо этого См. query_string
content: (Необязательно, строка) Если SAML IdP отправляет ответ о выходе из системы с помощью привязки HTTP-Post, это поле должно быть установлено в значение параметра формы SAMLResponse из ответа о выходе из системы.

Примеры

В следующем примере проверяется ответ о выходе из системы, отправленный SAML IdP с помощью привязки HTTP-Redirect:

resp = client.security.saml_complete_logout(
    realm="saml1",
    ids=[
        "_1c368075e0b3..."
    ],
    query_string="SAMLResponse=fZHLasMwEEVbfb1bf...&SigAlg=http%3A%2F%2Fwww.w3.org%2F2000%2F09%2Fxmldsig%23rsa-sha1&Signature=CuCmFn%2BLqnaZGZJqK...",
)
print(resp)

const response = await client.security.samlCompleteLogout({
  realm: "saml1",
  ids: ["_1c368075e0b3..."],
  query_string:
    "SAMLResponse=fZHLasMwEEVbfb1bf...&SigAlg=http%3A%2F%2Fwww.w3.org%2F2000%2F09%2Fxmldsig%23rsa-sha1&Signature=CuCmFn%2BLqnaZGZJqK...",
});
console.log(response);

POST /_security/saml/complete_logout
{
  "realm": "saml1",
  "ids": [ "_1c368075e0b3..." ],
  "query_string": "SAMLResponse=fZHLasMwEEVbfb1bf...&SigAlg=http%3A%2F%2Fwww.w3.org%2F2000%2F09%2Fxmldsig%23rsa-sha1&Signature=CuCmFn%2BLqnaZGZJqK..."
}

Если ответ о выходе из системы отправляется с помощью привязки HTTP-Post, его можно проверить следующим образом:

resp = client.security.saml_complete_logout(
    realm="saml1",
    ids=[
        "_1c368075e0b3..."
    ],
    content="PHNhbWxwOkxvZ291dFJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46...",
)
print(resp)

const response = await client.security.samlCompleteLogout({
  realm: "saml1",
  ids: ["_1c368075e0b3..."],
  content: "PHNhbWxwOkxvZ291dFJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46...",
});
console.log(response);

POST /_security/saml/complete_logout
{
  "realm": "saml1",
  "ids": [ "_1c368075e0b3..." ],
  "content": "PHNhbWxwOkxvZ291dFJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46..."
}

API возвращает пустой ответ при успехе.

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