IdentityProviderInitiatedSignonPage.SignIn Method

Signs the user in to the specified relying party (RP) application.

Namespace: Microsoft.IdentityServer.Web.UI
Assembly: Microsoft.IdentityServer (in Microsoft.IdentityServer)

Usage

'Usage
Dim relyingPartyIdentifier As String
Dim parameters As SignOnRequestParameters

Me.SignIn(relyingPartyIdentifier, parameters)

Syntax

'Declaration
Protected Sub SignIn ( _
    relyingPartyIdentifier As String, _
    parameters As SignOnRequestParameters _
)
protected void SignIn (
    string relyingPartyIdentifier,
    SignOnRequestParameters parameters
)
protected:
void SignIn (
    String^ relyingPartyIdentifier, 
    SignOnRequestParameters^ parameters
)
protected void SignIn (
    String relyingPartyIdentifier, 
    SignOnRequestParameters parameters
)
protected function SignIn (
    relyingPartyIdentifier : String, 
    parameters : SignOnRequestParameters
)

Parameters

  • relyingPartyIdentifier
    Identifier of the relying party (RP) to which to sign in. The RP must be SAML Web SSO compatible. null or an empty string specifies the IdP itself.
  • parameters
    A SignOnRequestParameters object that specifies the parameters to be used when signing the user in to the specified relying party.

Remarks

Call this method to sign on to an RP application or to the IdP. You can specify null or an empty string for the relyingPartyIdentifier to sign on to the IdP. To sign on to an RP pass the SAML EntityId for the desired RP. This identifier can be read from the Id column of the DataTable exposed by the RelyingParties property. It can also be found from the RP’s metadata. You can also find the identifier on the AD FS 2.0 Management Console by expanding the Trust Relationships node, selecting Relying Party Trusts and noting the identifier in the Identifier column for the RP.

This method is called from the Page_Init and SignInButton_Click events in the default code-behind for the IdpInitiatedSignOn.aspx page. You can pass sign on parameters to support passive login, forced authentication, as well as preferred methods for authentication. For more information, including code samples, see IdpInitiatedSignOnPage Class Overview.

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

Development Platforms

Windows Server 2008, Windows Server 2008 R2

Target Platforms

Windows Server 2008, Windows Server 2008 R2

See Also

Reference

IdentityProviderInitiatedSignonPage Class
IdentityProviderInitiatedSignonPage Members
Microsoft.IdentityServer.Web.UI Namespace
SignOnRequestParameters Class

Other Resources

IdpInitiatedSignOnPage Class Overview