Interface ISamlProvider

Provides Identity Provider (IdP) and Service Provider (SP) support for web browser single sign-on.

Inherited Members

IArtifactResolver.ResolveArtifactAsync()

Namespace: ComponentSpace.Saml2

Assembly: ComponentSpace.Saml2.dll

Syntax

public interface ISamlProvider : IArtifactResolver

Methods

ClearSessionAsync(string)

Clears the current SAML session state for all partners or for the specified partner only.

Declaration

Task ClearSessionAsync(string partnerName = null)

Parameters

Type	Name	Description
string	partnerName	The partner name or null if none.

Returns

Type	Description
Task	A task that represents the operation.

Exceptions

Type	Condition
SamlException	Thrown when the SAML session state cannot be cleared.

GetStatusAsync()

Returns the current SSO status.

Declaration

Task<ISsoStatus> GetStatusAsync()

Returns

Type	Description
Task<ISsoStatus>	A task that represents the operation and returns the current SSO status.

Exceptions

Type	Condition
SamlException	Thrown when the starts cannot be retrieved.

PeekMessageTypeAsync()

Peeks the currently received SAML message type.

Declaration

Task<SamlMessageType> PeekMessageTypeAsync()

Returns

Type	Description
Task<SamlMessageType>	The SAML message type.

SetConfigurationNameAsync(string)

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

Task SetConfigurationNameAsync(string configurationName)

Parameters

Type	Name	Description
string	configurationName	The configuration name.

Returns

Type	Description
Task	A task that represents the operation.

Exceptions

Type	Condition
SamlException	Thrown when the configuration name cannot be set.