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 参数值; 但是，该模块在处理签入请求或sign-in反应时不使用它。 您可以将其设置为任何值。 它不必是唯一的。

returnUrl

String

模块应返回在身份验证的 URL。

rememberMeSet

Boolean

WSFAM 保存请求中的 WS-Federation 标志 wctx 参数值; 但是，该模块在处理签入请求或sign-in反应时不使用它。 可以设置该 true 或 false。

返回

SignInRequestMessage

WS-Federation 登录请求消息。

例外

InvalidOperationException

Issuer 属性为 null 或空字符串。

- 或 -

Realm 属性为 null 或空字符串。

注解

创建由 SignInRequestMessage 对象表示的 WS-Federation 登录请求。 新 SignInRequestMessage 对象的属性设置如下：

• wctx Context 参数) (属性设置为使用 方法参数创建的值。

• CurrentTime wct 参数) (属性设置为当前时间。

• 所有其他属性都是使用当前实例的等效属性设置的。

传递给 方法的参数用于创建 wctx 消息参数。 这是具有以下格式的字符串： ru=returnUrl&cx=SignInContext&rm=rememberMeSet&id=uniqueId。

• 该值 ru 设置为传递给 方法的参数 returnUrl 的值，并指定模块应在成功身份验证后将浏览器定向到的 URL。 这是存储在 WSFAM 使用的 wctx 字符串中的唯一值。 模块调用 GetReturnUrlFromResponse 方法以在处理 WS-Federation 登录响应时从 wctx 参数中提取此值。 不应将其与 wreply 消息参数混淆，该参数由 Reply 属性指定，后者在 RP 上提供安全令牌服务 (STS) 应将其响应定向到的地址。

• 参数 cx 设置为 属性的值 SignInContext 。 公开此属性用于设置应存储在 wctx 字符串中的任何应用程序定义的上下文;但是，WSFAM 不会公开在响应中提取此值的方法。 如果应用程序需要该值，则必须提供代码来分析 wctx 字符串，并在处理响应时读取此值。 可以通过重写 GetReturnUrlFromResponse 方法来实现此目的。

• rm WSFAM 既不使用设置为参数值的值rememberMeSet，也不id使用设置为参数值的参数uniqueId。 这些值可以设置为任何值。

方法 CreateSignInRequest 从 RedirectToIdentityProvider 方法调用。

另请参阅

• RedirectToIdentityProvider(String, String, Boolean)