SSO EAPHost API 概述
本主题概述了支持单一登录的 EAPHost API (SSO) 。 有关特定 SSO 方案，请参阅 SSO EAPHost 方案。
EAPHost 枚举
以下枚举支持 SSO。
| 名称 | 目的 |
|---|---|
| EAP_CONFIG_INPUT_FIELD_TYPE | 定义查询用户凭据时可用的一组可能的输入字段类型。 |
| EAP_INTERACTIVE_UI_DATA_TYPE | 指定提供给某些请求 API 调用的交互式 UI 上下文数据的类型。 |
EAPHost 结构
以下数据结构支持 SSO。
| 名称 | 目的 |
|---|---|
| EAP_CONFIG_INPUT_FIELD_DATA | 包含与单个输入字段关联的数据。 |
| EAP_CONFIG_INPUT_FIELD_ARRAY | 包含一组 EAP_CONFIG_INPUT_FIELD_DATA 结构，这些结构共同包含从用户获取的用户输入字段数据。 |
| EAP_INTERACTIVE_UI_DATA | 包含 EAP 请求方上引发的交互式 UI 组件的配置信息。 |
| EAP_CRED_REQ | 包含用于凭据更改操作的旧 EAP 凭据和新凭据。 |
| EAP_CRED_RESP | 包含用于凭据更改操作的旧 EAP 凭据和新凭据。 |
| EAP_CRED_EXPIRY_REQ | 包含用于凭据过期操作的旧 EAP 凭据和新凭据。 |
| EAP_CRED_EXPIRY_RESP | 包含用于凭据过期操作的旧 EAP 凭据和新凭据。 |
EAPHost 对等 (请求) API
以下请求函数支持 SSO。
EapHostPeerQueryCredentialInputFields 和 EapHostPeerQueryUserBlobFromCredentialInputFields 函数专用于 SSO。
| 名称 | 目的 | 订单调用 |
|---|---|---|
| EapHostPeerQueryInteractiveUIInputFields | 获取要对请求者引发的交互式 UI 组件的输入字段。 | 4 |
| EapHostPeerQueryCredentialInputFields | 允许用户确定在 SSO 方案中执行身份验证的方法需要哪种类型的凭据。 | 1 |
| EapHostPeerQueryUIBlobFromInteractiveUIInputFields | 将用户信息转换为可由 EAPHost 运行时函数使用的用户 BLOB。 | 5 |
| EapHostPeerQueryUserBlobFromCredentialInputFields | 获取可用于从 SSO UI 接收的用户输入开始身份验证的凭据 BLOB。 | 2 |
| EapHostPeerBeginSession | 请求方使用 EAP_FLAG_PRE_LOGON 标志来指示 EAPHost 应提供 SSO。 如果返回 EapHostPeerResponseInvokeUI 操作代码，则 EAPHost 调用 EapPeerQueryInteractiveUIInputFields，然后调用 EapHostPeerQueryUIBlobFromInteractiveUIInputFields 如果未返回 EapHostPeerResponseInvokeUI 操作代码，则 EAPHost 将继续执行常规的非 SSO 调用序列。 有关详细信息，请参阅 请求 API 调用序列。 |
3 |
EAPHost 对等方法 API
以下对等函数支持 SSO。
EapPeerQueryCredentialInputFields 和 EapPeerQueryUserBlobFromCredentialInputFields 函数专用于 SSO。
| 名称 | 目的 | 订单调用 |
|---|---|---|
| EapPeerQueryInteractiveUIInputFields | 定义 EAP 方法 API 的实现，该 API 为要在请求方上引发的交互式 UI 组件提供输入字段。 | 4 |
| EapPeerQueryCredentialInputFields | 定义 EAP 方法特定函数的实现，该函数获取该 EAP 方法的 EAP SSO 凭据输入字段。 | 1 |
| EapPeerQueryUIBlobFromInteractiveUIInputFields | 将用户信息转换为可由 EAPHost 运行时函数使用的用户 BLOB。 | 5 |
| EapPeerQueryUserBlobFromCredentialInputFields | 定义 EAP 方法函数的实现，该函数获取请求方上引发的交互式 SSO UI 提供的用户 BLOB 数据。 | 2 |
| EapPeerBeginSession |
EAP_FLAG_PRE_LOGON标志指示 EAPHost 应提供 SSO。 在 SSO 方案中，如果返回 EapPeerResponseInvokeUI 操作代码，则 EAPHost 调用 EapPeerQueryInteractiveUIInputFields，然后调用 EapPeerQueryUserBlobFromCredentialInputFields 如果未返回 EapPeerResponseInvokeUI 操作代码，则 EAPHost 将继续执行常规的非 SSO 调用序列。 有关详细信息，请参阅 对等方法 API 调用序列。 |
3 |