Class SAMLConfigurations
The SAML configurations specifies the configurations for SAML single sign-on.
Inheritance
Inherited Members
Namespace: ComponentSpace.SAML2.Configuration
Assembly: ComponentSpace.Saml2.dll
Syntax
public class SAMLConfigurations
Constructors
SAMLConfigurations()
Initializes a new instance of the SAMLConfigurations
class.
Declaration
public SAMLConfigurations()
SAMLConfigurations(XmlElement)
Initializes a new instance of the SAMLConfigurations
class.
Declaration
public SAMLConfigurations(XmlElement xmlElement)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlElement | xmlElement | The SAML configuration XML. |
Properties
Configurations
Gets or sets the list of SAML configurations.
Declaration
public IList<SAMLConfiguration> Configurations { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<SAMLConfiguration> | The list of SAML configurations. |
ReloadOnConfigurationChange
Gets or sets the flag indicating whether the application should be reloaded if the configuration changes.
Declaration
public bool ReloadOnConfigurationChange { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The flag indicating whether the application should be reloaded if the configuration changes. |
ValidateMessagesAgainstSchema
Gets or sets the flag indicating whether SAML messages should be validated against the XML schema.
Declaration
public bool ValidateMessagesAgainstSchema { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The flag indicating whether SAML messages should be validated against the XML schema. |
Methods
AddConfiguration(SAMLConfiguration)
Adds a SAML configuration.
Declaration
public void AddConfiguration(SAMLConfiguration samlConfiguration)
Parameters
Type | Name | Description |
---|---|---|
SAMLConfiguration | samlConfiguration | The SAML configuration. |
GetConfiguration(String)
Returns the configuration with the specified ID.
Declaration
public SAMLConfiguration GetConfiguration(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The configuration name. |
Returns
Type | Description |
---|---|
SAMLConfiguration | The configuration with the specified name. |
Exceptions
Type | Condition |
---|---|
SAMLConfigurationException | Thrown when the configuration with the specified name cannot be retrieved. |
RemoveConfiguration(String)
Removes the configuration with the specified name.
Declaration
public void RemoveConfiguration(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The configuration name. |
ToXml()
Serializes the configurations to XML.
Declaration
public XmlElement ToXml()
Returns
Type | Description |
---|---|
System.Xml.XmlElement | The configurations as XML. |
ToXml(XmlDocument)
Serializes the configurations 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 configurations as XML. |