› › ›

API аутентификации SAML

Отправляет сообщение SAML Response в Elasticsearch для обработки.

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

Запрос

POST /_security/saml/authenticate

Описание

Сообщению SAML, которое отправляется, может быть:

ответом на запрос аутентификации SAML, который был ранее создан с помощью API подготовки аутентификации SAML.
самопроизвольным сообщением SAML в случае потока однократного входа (SSO) инициируемого IdP.

В любом случае, сообщение SAML должно быть XML-документом, закодированным в base64, с корневым элементом <Response>

После успешной валидации Elasticsearch отвечает внутренним токеном доступа и токеном обновления Elasticsearch, которые впоследствии могут использоваться для аутентификации. Этот конечный пункт API фактически обменивает ответы SAML, указывающие на успешную аутентификацию в IdP, на токены доступа и обновления Elasticsearch, которые могут использоваться для аутентификации в Elasticsearch.

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

Тело запроса

content: (Обязательно, строка) Ответ SAML, как он был отправлен браузером пользователя, обычно XML-документ, закодированный в Base64.
ids: (Обязательно, массив) JSON-массив со всеми допустимыми идентификаторами запросов SAML, которые у вызывающего API для текущего пользователя.
realm: (Необязательно, строка) Название домена, которое должно аутентифицировать ответ SAML. Полезно в случаях, когда определены многие домены SAML.

Тело ответа

access_token: (строка) Токен доступа, сгенерированный Elasticsearch.
username: (строка) Имя аутентифицированного пользователя.
expires_in: (целое число) Количество времени (в секундах) до истечения срока действия токена.
refresh_token: (строка) Токен обновления, сгенерированный Elasticsearch.
realm: (строка) Название домена, по которому был аутентифицирован пользователь.

Примеры

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

resp = client.security.saml_authenticate(
    content="PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIHhtbG5zOnNhbWw9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMD.....",
    ids=[
        "4fee3b046395c4e751011e97f8900b5273d56685"
    ],
)
print(resp)

const response = await client.security.samlAuthenticate({
  content:
    "PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIHhtbG5zOnNhbWw9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMD.....",
  ids: ["4fee3b046395c4e751011e97f8900b5273d56685"],
});
console.log(response);

POST /_security/saml/authenticate
{
  "content" : "PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIHhtbG5zOnNhbWw9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMD.....",
  "ids" : ["4fee3b046395c4e751011e97f8900b5273d56685"]
}

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

{
  "access_token" : "46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3",
  "username" : "Bearer",
  "expires_in" : 1200,
  "refresh_token": "mJdXLtmvTUSpoLwMvdBt_w",
  "realm": "saml1"
}

© 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-authenticate.html