Class SSOOptions

Specifies single sign-on options.

Inheritance

object

SSOOptions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: ComponentSpace.SAML2

Assembly: ComponentSpace.Saml2.dll

Syntax

public class SSOOptions

Constructors

SSOOptions()

Initializes a new instance of the SSOOptions class.

Declaration

public SSOOptions()

SSOOptions(string, bool, bool, bool, string, string, IList<string>)

Initializes a new instance of the SSOOptions class.

Declaration

public SSOOptions(string requestedUserName, bool forceAuthn, bool isPassive, bool allowCreate, string providerName, string spNameQualifier, IList<string> requestedAuthnContexts)

Parameters

Type	Name	Description
string	requestedUserName	The requested user name.
bool	forceAuthn	The force authentication flag.
bool	isPassive	The is passive flag.
bool	allowCreate	The allow create flag.
string	providerName	The provider name.
string	spNameQualifier	The service provider name qualifier.
IList<string>	requestedAuthnContexts	The requested authentication contexts.

SSOOptions(string, bool, bool, bool, string, string, IList<string>, string)

Initializes a new instance of the SSOOptions class.

Declaration

public SSOOptions(string requestedUserName, bool forceAuthn, bool isPassive, bool allowCreate, string providerName, string spNameQualifier, IList<string> requestedAuthnContexts, string requestedAuthnContextComparison)

Parameters

Type	Name	Description
string	requestedUserName	The requested user name.
bool	forceAuthn	The force authentication flag.
bool	isPassive	The is passive flag.
bool	allowCreate	The allow create flag.
string	providerName	The provider name.
string	spNameQualifier	The service provider name qualifier.
IList<string>	requestedAuthnContexts	The requested authentication contexts.
string	requestedAuthnContextComparison	The requested authentication context comparison.

SSOOptions(string, bool, bool, bool, string, string, string)

Initializes a new instance of the SSOOptions class.

Declaration

public SSOOptions(string requestedUserName, bool forceAuthn, bool isPassive, bool allowCreate, string providerName, string spNameQualifier, string requestedAuthnContext)

Parameters

Type	Name	Description
string	requestedUserName	The requested user name.
bool	forceAuthn	The force authentication flag.
bool	isPassive	The is passive flag.
bool	allowCreate	The allow create flag.
string	providerName	The provider name.
string	spNameQualifier	The service provider name qualifier.
string	requestedAuthnContext	The requested authentication context.

Properties

AllowCreate

Gets or sets the optional allow create flag. If true the identity provider is allowed to create a new identifier for the user.

Declaration

public bool AllowCreate { get; set; }

Property Value

Type	Description
bool	The allow create flag.

AssertionConsumerServiceIndex

Gets or sets the assertion consumer service index.

Declaration

public int AssertionConsumerServiceIndex { get; set; }

Property Value

Type	Description
int	The assertion consumer service index or negative if none.

Conditions

Gets or sets the optional conditions.

Declaration

public Conditions Conditions { get; set; }

Property Value

Type	Description
Conditions	The conditions.

Destination

Gets or sets the optional destination.

Declaration

public string Destination { get; set; }

Property Value

Type	Description
string	The destination.

Extensions

Gets or sets the optional extensions.

Declaration

public XmlNodeList Extensions { get; set; }

Property Value

Type	Description
XmlNodeList	The extensions.

ForceAuthn

Gets or sets the optional force authentication flag. If true the identity provider should discard any existing user authentication session and establish a new user authentication session.

Declaration

public bool ForceAuthn { get; set; }

Property Value

Type	Description
bool	The force authentication flag.

IsPassive

Gets or sets the optional is passive flag. If true the identity provider must not visibly take control of the user interface.

Declaration

public bool IsPassive { get; set; }

Property Value

Type	Description
bool	The is passive flag.

ProviderName

Gets or sets the optional provider name.

Declaration

public string ProviderName { get; set; }

Property Value

Type	Description
string	The provider name.

RequestedAuthnContextComparison

Gets or sets the optional requested authentication context comparison.

Declaration

public string RequestedAuthnContextComparison { get; set; }

Property Value

Type	Description
string	The requested authentication context comparison.

RequestedAuthnContexts

Gets or sets the optional requested authentication contexts.

Declaration

public IList<string> RequestedAuthnContexts { get; set; }

Property Value

Type	Description
IList<string>	The requested authentication contexts.

RequestedUserName

Gets or sets the optional requested user name.

Declaration

public string RequestedUserName { get; set; }

Property Value

Type	Description
string	The requested user name.

SPNameQualifier

Gets or sets the optional service provider name qualifier.

Declaration

public string SPNameQualifier { get; set; }

Property Value

Type	Description
string	The service provider name qualifier.

Subject

Gets or sets the optional subject.

Declaration

public Subject Subject { get; set; }

Property Value

Type	Description
Subject	The subject.

TrustedIdentityProviders

Gets or sets the optional trusted identity providers to include as scoping.

Declaration

public IList<SSOOptions.TrustedIdentityProvider> TrustedIdentityProviders { get; set; }

Property Value

Type	Description
IList<SSOOptions.TrustedIdentityProvider>	The trusted identity providers to include as scoping.