WSFederationAuthenticationModule.CreateSignInRequest 方法
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
使用模組上設定的 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-同盟登入要求中的 wctx 參數,但是模組不會在處理登入要求或登入回應時使用該值。 您可以將它設定為任何值。 這不需要是唯一的。
- returnUrl
- String
在驗證時模組應該傳回的 URL。
- rememberMeSet
- Boolean
WSFAM 會將這個值儲存在 WS-同盟登入要求中的 wctx 參數,但是模組不會在處理登入要求或登入回應時使用該值。 您可以將它設定為 true
或 false
。
傳回
WS-Federation 登入要求訊息。
例外狀況
備註
建立由物件表示 SignInRequestMessage 的 WS-Federation 登入要求。 新 SignInRequestMessage 物件的屬性會設定如下:
Context) wctx 參數 (屬性會設定為使用 方法參數所建立的值。
CurrentTime) wct 參數 (屬性會設定為目前時間。
所有其他屬性都是使用目前實例的對等屬性來設定。
傳遞至 方法的參數可用來建立 wctx 訊息參數。 這是具有下列格式的字串: ru=returnUrl&cx=SignInContext&rm=rememberMeSet&id=uniqueId
。
此值
ru
會設定為傳入 方法的參數returnUrl
值,並指定模組應該引導瀏覽器遵循成功驗證的 URL。 這是儲存在 WSFAM 使用的 wctx 字串中的唯一值。 模組會呼叫 方法, GetReturnUrlFromResponse 以在處理 WS-Federation 登入回應時,從 wctx 參數擷取此值。 它不應該與 屬性所 Reply 指定的 wreply 訊息參數混淆,該參數會提供安全性令牌服務 (STS) 的 RP 位址。參數
cx
會設定為 屬性的值 SignInContext 。 此屬性會公開為可讓您設定應該儲存在 wctx 字串中的任何應用程式定義內容;不過,WSFAM 不會公開方法,以在回應中擷取此值。 如果您的應用程式需要此值,您必須提供程式碼來剖析 wctx 字串,並在處理回應時讀取此值。 您可以覆寫 GetReturnUrlFromResponse 方法來完成此作業。未將
rm
值設定為 參數的值rememberMeSet
,也不會id
將 參數設定為 參數的值,WSFAM 會使用參數的值uniqueId
。 這些可以設定為任何值。
方法 CreateSignInRequest 會從 RedirectToIdentityProvider 方法呼叫。