Class SAMLController
The SAML controller maintains the SAML configuration and other properties.
Inheritance
Inherited Members
Namespace: ComponentSpace.SAML2
Assembly: ComponentSpace.Saml2.dll
Syntax
public static class SAMLController
Properties
CertificateManager
Gets or sets the certificate manager.
By default the configuration certificate manager is used. The configuration certificate manager is suitable for certificates stored on the file system or Windows certificate store.
Declaration
public static ICertificateManager CertificateManager { get; set; }
Property Value
Type | Description |
---|---|
ICertificateManager | The certificate manager. |
Configuration
Gets or sets the SAML configuration.
Declaration
public static SAMLConfiguration Configuration { get; set; }
Property Value
Type | Description |
---|---|
SAMLConfiguration | The SAML configuration or |
See Also
ConfigurationName
Gets or sets the SAML configuration name for the current SAML SSO session.
For most applications, a single SAML configuration is used and the SAML configuration name is not required. For multi-tenanted applications and other special use cases with multiple SAML configurations, the SAML name specifies the configuration to use.
Declaration
public static string ConfigurationName { get; set; }
Property Value
Type | Description |
---|---|
System.String | The SAML configuration name or |
See Also
ConfigurationResolver
Gets or sets the SAML configuration resolver.
The SAML configuration resolver is an alternative mechanism for providing SAML configuration
rather than specifying a SAMLConfiguration
.
Declaration
public static ISAMLConfigurationResolver ConfigurationResolver { get; set; }
Property Value
Type | Description |
---|---|
ISAMLConfigurationResolver | The SAML configuration resolver. |
See Also
Configurations
Gets or sets the SAML configurations.
For most applications, a single SAML configuration is required. For multi-tenanted applications and other special use cases, multiple SAML configurations may be specified.
Declaration
public static SAMLConfigurations Configurations { get; set; }
Property Value
Type | Description |
---|---|
SAMLConfigurations | The SAML configurations. |
See Also
IDCache
Gets or sets the ID cache.
By default the in-memory cache is used. The in-memory cache is suitable for applications deployed to a single server.
Declaration
public static IIDCache IDCache { get; set; }
Property Value
Type | Description |
---|---|
IIDCache | The ID cache. |
SSOSessionStore
Gets or sets the single sign-on session store.
By default the HTTP session is used to store the single sign-on session.
Declaration
public static ISSOSessionStore SSOSessionStore { get; set; }
Property Value
Type | Description |
---|---|
ISSOSessionStore | The single sign-on session store. |
ValidateMessagesAgainstSchema
Gets or sets the flag indicating whether SAML messages should be validated against the XML schema.
Validating SAML messages against the XML schema is good practice but does result in a small performance hit.
Declaration
public static bool ValidateMessagesAgainstSchema { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The flag indicating whether SAML messages should be validated against the XML schema. |
Methods
DeleteSSOSession()
Deletes the SAML SSO session state.
Declaration
public static void DeleteSSOSession()
Initialize()
Initializes the SAML environment.
This occurs automatically but may be forced if required.
If the configuration resolver has been set then this this will be used.
Otherwise, if configuration has been set programmatically then this will be used.
Otherwise, a SAML configuration file is assumed and is loaded.
Declaration
public static void Initialize()
Uninitialize()
Uninitializes the SAML environment.
Any SAML configuration is unloaded.
Declaration
public static void Uninitialize()