Class SAMLConfiguration

The SAML configuration specifies the configuration for SAML single sign-on.

Inheritance

System.Object

Entity

SAMLConfiguration

Inherited Members

Entity.Id

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: ComponentSpace.SAML2.Configuration

Assembly: ComponentSpace.Saml2.dll

Syntax

public class SAMLConfiguration : Entity

Constructors

SAMLConfiguration()

Initializes a new instance of the SAMLConfiguration class.

Declaration

public SAMLConfiguration()

SAMLConfiguration(XmlElement)

Initializes a new instance of the SAMLConfiguration class.

Declaration

public SAMLConfiguration(XmlElement xmlElement)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlElement	The SAML configuration XML.

Properties

LocalIdentityProviderConfiguration

Gets or sets the local identity provider configuration.

Declaration

public LocalIdentityProviderConfiguration LocalIdentityProviderConfiguration { get; set; }

Property Value

Type	Description
LocalIdentityProviderConfiguration	The local identity provider configuration.

LocalServiceProviderConfiguration

Gets or sets the local service provider configuration.

Declaration

public LocalServiceProviderConfiguration LocalServiceProviderConfiguration { get; set; }

Property Value

Type	Description
LocalServiceProviderConfiguration	The local service provider configuration.

Name

Gets or sets the configuration name.

The configuration name is used in multi-tenanted applications.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String	The configuration name or null if none.

PartnerIdentityProviderConfigurations

Gets or sets the partner identity provider configurations.

Declaration

public IList<PartnerIdentityProviderConfiguration> PartnerIdentityProviderConfigurations { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<PartnerIdentityProviderConfiguration>	The partner identity provider configurations.

PartnerServiceProviderConfigurations

Gets or sets the partner service provider configurations.

Declaration

public IList<PartnerServiceProviderConfiguration> PartnerServiceProviderConfigurations { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<PartnerServiceProviderConfiguration>	The partner service provider configurations.

Methods

AddPartnerIdentityProvider(PartnerIdentityProviderConfiguration)

Adds the partner identity provider configuration.

Declaration

public void AddPartnerIdentityProvider(PartnerIdentityProviderConfiguration partnerIdentityProviderConfiguration)

Parameters

Type	Name	Description
PartnerIdentityProviderConfiguration	partnerIdentityProviderConfiguration	The partner identity provider configuration.

AddPartnerIdentityProviders(IList<PartnerIdentityProviderConfiguration>)

Adds the partner identity provider configurations.

Declaration

public void AddPartnerIdentityProviders(IList<PartnerIdentityProviderConfiguration> partnerIdentityProviderConfigurations)

Parameters

Type	Name	Description
System.Collections.Generic.IList<PartnerIdentityProviderConfiguration>	partnerIdentityProviderConfigurations	The partner identity provider configurations.

AddPartnerServiceProvider(PartnerServiceProviderConfiguration)

Adds the partner service provider configuration.

Declaration

public void AddPartnerServiceProvider(PartnerServiceProviderConfiguration partnerServiceProviderConfiguration)

Parameters

Type	Name	Description
PartnerServiceProviderConfiguration	partnerServiceProviderConfiguration	The partner service provider configuration.

AddPartnerServiceProviders(IList<PartnerServiceProviderConfiguration>)

Adds the partner service provider configurations.

Declaration

public void AddPartnerServiceProviders(IList<PartnerServiceProviderConfiguration> partnerServiceProviderConfigurations)

Parameters

Type	Name	Description
System.Collections.Generic.IList<PartnerServiceProviderConfiguration>	partnerServiceProviderConfigurations	The partner service provider configurations.

GetPartnerIdentityProvider(String)

Gets the specified partner identity provider configuration.

If a single partner identity provider is configured then a name doesn't have to be specified.

Declaration

public PartnerIdentityProviderConfiguration GetPartnerIdentityProvider(string name)

Parameters

Type	Name	Description
System.String	name	The partner identity provider name or null if none.

Returns

Type	Description
PartnerIdentityProviderConfiguration	The partner identity provider configuration.

Exceptions

Type	Condition
SAMLException	Thrown when the partner identity provider configuration cannot be found.

GetPartnerServiceProvider(String)

Gets the specified partner service provider configuration.

If a single partner service provider is configured then a name doesn't have to be specified.

Declaration

public PartnerServiceProviderConfiguration GetPartnerServiceProvider(string name)

Parameters

Type	Name	Description
System.String	name	The partner service provider name or null if none.

Returns

Type	Description
PartnerServiceProviderConfiguration	The partner service provider configuration.

Exceptions

Type	Condition
SAMLException	Thrown when the partner service provider configuration cannot be found.

RemovePartnerIdentityProvider(String)

Removes the partner identity provider configuration with the specified name.

Declaration

public void RemovePartnerIdentityProvider(string name)

Parameters

Type	Name	Description
System.String	name	The partner identity provider name.

RemovePartnerServiceProvider(String)

Removes the partner service provider configuration with the specified name.

Declaration

public void RemovePartnerServiceProvider(string name)

Parameters

Type	Name	Description
System.String	name	The partner service provider name.

ToXml()

Serializes the configuration to XML.

Declaration

public XmlElement ToXml()

Returns

Type	Description
System.Xml.XmlElement	The configuration as XML.

ToXml(XmlDocument)

Serializes the configuration to XML.

Declaration

public XmlElement ToXml(XmlDocument xmlDocument)

Parameters

Type	Name	Description
System.Xml.XmlDocument	xmlDocument	The owning XML document.

Returns

Type	Description
System.Xml.XmlElement	The configuration as XML.