SignOnRequestParameters Class

 

Contains sign-on parameters used for SAML-based IdP-initiated single sign-on (SSO).

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

Inheritance Hierarchy

System.Object
  Microsoft.IdentityServer.Web.SignOnRequestParameters

Syntax

public class SignOnRequestParameters
public ref class SignOnRequestParameters 
type SignOnRequestParameters = class end
Public Class SignOnRequestParameters

Constructors

Name Description
System_CAPS_pubmethod SignOnRequestParameters()

Initializes a new instance of the SignOnRequestParameters class.

Properties

Name Description
System_CAPS_pubproperty Consent

Gets or sets the consent identifier for an authentication request.

System_CAPS_pubproperty ForceAuthentication

Gets or sets a value that specifies whether the principal must be authenticated directly by the IdP for this request.

System_CAPS_pubproperty IsPassive

Gets or sets a value that specifies whether the sign-on request should be performed passively; that is, without noticeable interaction required by the user.

System_CAPS_pubproperty RequestedAuthenticationContext

Gets or sets the request authentication context.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Remarks

A SignOnRequestParameters object is passed to the IdentityProviderInitiatedSignonPage.SignIn(String, SignOnRequestParameters) method, which is called to perform IdP-initiated sign-on. By setting the properties of the SignOnRequestParameters object, sign-on behavior and requirements can be specified.

The default implementation of the Sign-In Pages contains support only for specifying a consent identifier through a drop-down list that can be enabled from the web.config file. You can modify the IdpInitiatedSignOn.aspx.cs code-behind file and the IdpInitiatedSignOn.aspx file to provide support for specifying additional sign-on parameters using query string parameters or UI elements. 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.

See Also

SignIn(String, SignOnRequestParameters)
Microsoft.IdentityServer.Web Namespace
IdpInitiatedSignOnPage Class Overview

Return to top