SSO EAPHost API の概要
このトピックでは、シングル サインオン (SSO) をサポートする EAPHost API の概要について説明します。 特定の SSO シナリオについては、「 SSO EAPHost シナリオ」を参照してください。
EAPHost 列挙
次の列挙は SSO をサポートしています。
名前 | 目的 |
---|---|
EAP_CONFIG_INPUT_FIELD_TYPE | ユーザー資格情報のクエリを実行するときに使用できる一連の入力フィールド型を定義します。 |
EAP_INTERACTIVE_UI_DATA_TYPE | 特定のサプリカント API 呼び出しに提供される対話型 UI コンテキスト データの種類を指定します。 |
EAPHost 構造体
次のデータ構造では SSO がサポートされています。
名前 | 目的 |
---|---|
EAP_CONFIG_INPUT_FIELD_DATA | 1 つの入力フィールドに関連付けられたデータを格納します。 |
EAP_CONFIG_INPUT_FIELD_ARRAY | ユーザーから取得 したユーザー 入力フィールド データをまとめて格納する一連のEAP_CONFIG_INPUT_FIELD_DATA構造が含まれます。 |
EAP_INTERACTIVE_UI_DATA | EAP サプリカントで発生する対話型 UI コンポーネントの構成情報が含まれます。 |
EAP_CRED_REQ | 資格情報変更操作の古い EAP 資格情報と新しい EAP 資格情報の両方が含まれます。 |
EAP_CRED_RESP | 資格情報変更操作の古い EAP 資格情報と新しい EAP 資格情報の両方が含まれます。 |
EAP_CRED_EXPIRY_REQ | 資格情報の有効期限操作の古い EAP 資格情報と新しい EAP 資格情報の両方が含まれます。 |
EAP_CRED_EXPIRY_RESP | 資格情報の有効期限操作の古い EAP 資格情報と新しい 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 | サプリカントで発生する対話型 UI コンポーネントの入力フィールドを提供する EAP メソッド API の実装を定義します。 | 4 |
EapPeerQueryCredentialInputFields | その EAP メソッドの EAP SSO 資格情報入力フィールドを取得する EAP メソッド固有の関数の実装を定義します。 | 1 |
EapPeerQueryUIBlobFromInteractiveUIInputFields | ユーザー情報を、EAPHost ランタイム関数で使用できるユーザー BLOB に変換します。 | 5 |
EapPeerQueryUserBlobFromCredentialInputFields | サプリカントで発生する対話型 SSO UI によって提供されるユーザー BLOB データを取得する EAP メソッド関数の実装を定義します。 | 2 |
EapPeerBeginSession |
EAP_FLAG_PRE_LOGON フラグは、EAPHost が SSO を提供する必要があることを示します。 SSO シナリオで EapPeerResponseInvokeUI アクション コードが返された場合、EAPHost は EapPeerQueryInteractiveUIInputFields を呼び出し、EapPeerQueryUserBlobFromCredentialInputFields を呼び出します。 EapPeerResponseInvokeUI アクション コードが返されない場合、EAPHost は通常の非 SSO 呼び出しシーケンスを続行します。 詳細については、「 ピア メソッド API 呼び出しシーケンス」を参照してください。 |
3 |