WSFederationAuthenticationModule.CreateSignInRequest メソッド

定義

名前空間:

System.IdentityModel.Services

アセンブリ:

System.IdentityModel.Services.dll

モジュールで構成された WS-Federation パラメーターを使用して WS-Federation サインイン要求メッセージを作成します。

public:
 System::IdentityModel::Services::SignInRequestMessage ^ CreateSignInRequest(System::String ^ uniqueId, System::String ^ returnUrl, bool rememberMeSet);

public System.IdentityModel.Services.SignInRequestMessage CreateSignInRequest (string uniqueId, string returnUrl, bool rememberMeSet);

member this.CreateSignInRequest : string * string * bool -> System.IdentityModel.Services.SignInRequestMessage

Public Function CreateSignInRequest (uniqueId As String, returnUrl As String, rememberMeSet As Boolean) As SignInRequestMessage

パラメーター

uniqueId

String

WSFAM は、WS-Federation のサインイン要求の wctx パラメーターにこの値を保存します。ただし、モジュールは、サインイン要求またはサインイン応答を処理するときにこの値を使用しません。 任意の値に設定できます。 一意である必要はありません。

returnUrl

String

認証後にモジュールが戻る必要がある URL。

rememberMeSet

Boolean

WSFAM は、WS-Federation のサインイン要求の wctx パラメーターにこの値を保存します。ただし、モジュールは、サインイン要求またはサインイン応答を処理するときにこの値を使用しません。 true または false に設定できます。

戻り値

SignInRequestMessage

WS-Federation サインイン要求メッセージ。

例外

InvalidOperationException

Issuer プロパティが null または空の文字列です。

- または -

Realm プロパティが null または空の文字列です。

注釈

オブジェクトによって表される WS-Federation サインイン要求を SignInRequestMessage 作成します。 新しい SignInRequestMessage オブジェクトのプロパティは、次のように設定されます。

• Contextプロパティ (wctx パラメーター) は、 メソッド パラメーターを使用して作成された値に設定されます。

• CurrentTimeプロパティ (wct パラメーター) は現在の時刻に設定されます。

• その他のすべてのプロパティは、現在のインスタンスの同等のプロパティを使用して設定されます。

メソッドに渡されるパラメーターは、wctx メッセージ パラメーターの作成に使用されます。 これは、次の形式の文字列です。 ru=returnUrl&cx=SignInContext&rm=rememberMeSet&id=uniqueId

• 値は ru メソッドに渡されるパラメーターの returnUrl 値に設定され、モジュールが正常な認証に従ってブラウザーに指示する URL を指定します。 これは、WSFAM によって使用される wctx 文字列に格納されている唯一の値です。 モジュールは、 メソッドを GetReturnUrlFromResponse 呼び出して、WS-Federation サインイン応答を処理するときに wctx パラメーターからこの値を抽出します。 プロパティで指定され、セキュリティ トークン サービス (STS) が応答を Reply 送信する RP のアドレスを提供する wreply メッセージ パラメーターと混同しないでください。

• パラメーターは cx 、 プロパティの値に SignInContext 設定されます。 このプロパティは、wctx 文字列に格納する必要があるアプリケーション定義のコンテキストを設定できるようにするために公開されます。ただし、WSFAM では、応答でこの値を抽出するメソッドは公開されません。 アプリケーションで値が必要な場合は、wctx 文字列を解析し、応答の処理中にこの値を読み取るコードを指定する必要があります。 これを行うには、 メソッドをオーバーライドします GetReturnUrlFromResponse 。

• パラメーターのrm値に設定されている値も、パラメーターのrememberMeSet値uniqueIdに設定されているパラメーターもid、WSFAM では使用しません。 これらは任意の値に設定できます。

メソッドは CreateSignInRequest 、 メソッドから呼び出されます RedirectToIdentityProvider 。

こちらもご覧ください

• RedirectToIdentityProvider(String, String, Boolean)