WSFederationAuthenticationModule.CreateSignInRequest Method

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Creates a WS-Federation Passive Protocol SignIn Request, using the WS-Federation parameters configured on the module.

Namespace: Microsoft.IdentityModel.Web
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As WSFederationAuthenticationModule
Dim uniqueId As String
Dim returnUrl As String
Dim rememberMeSet As Boolean
Dim returnValue As SignInRequestMessage

returnValue = instance.CreateSignInRequest(uniqueId, returnUrl, rememberMeSet)

Syntax

'Declaration
Public Function CreateSignInRequest ( _
    uniqueId As String, _
    returnUrl As String, _
    rememberMeSet As Boolean _
) As SignInRequestMessage
public SignInRequestMessage CreateSignInRequest (
    string uniqueId,
    string returnUrl,
    bool rememberMeSet
)
public:
SignInRequestMessage^ CreateSignInRequest (
    String^ uniqueId, 
    String^ returnUrl, 
    bool rememberMeSet
)
public SignInRequestMessage CreateSignInRequest (
    String uniqueId, 
    String returnUrl, 
    boolean rememberMeSet
)
public function CreateSignInRequest (
    uniqueId : String, 
    returnUrl : String, 
    rememberMeSet : boolean
) : SignInRequestMessage

Parameters

  • uniqueId
     
  • returnUrl
     
  • rememberMeSet
     

Return Value

Returns an instance of the SignInRequestMessage representing the WS-Federation Passive Protocol SignIn Request.

Remarks

If you need to create a new sign in request, for example to redirect to different issuers based on the web page being accessed you can use this method to create the sign in request. Before calling this method, set the appropriate parameters on the FederatedAuthenticationModule.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)

See Also

Reference

WSFederationAuthenticationModule Class
WSFederationAuthenticationModule Members
Microsoft.IdentityModel.Web Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.