Interface ISamlProvider

Namespace

ComponentSpace.Saml2

Assembly

ComponentSpace.Saml2.dll

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

public interface ISamlProvider : IArtifactResolver

Inherited Members

IArtifactResolver.ResolveArtifactAsync()

Methods

ClearSessionAsync(string)

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

Task ClearSessionAsync(string partnerName = null)

Parameters

partnerName string

The partner name or null if none.

Returns

Task

A task that represents the operation.

Exceptions

SamlException

Thrown when the SAML session state cannot be cleared.

GetStatusAsync()

Returns the current SSO status.

Task<ISsoStatus> GetStatusAsync()

Returns

Task<ISsoStatus>

A task that represents the operation and returns the current SSO status.

Exceptions

SamlException

Thrown when the starts cannot be retrieved.

PeekMessageTypeAsync()

Peeks the currently received SAML message type.

Task<SamlMessageType> PeekMessageTypeAsync()

Returns

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.

Task SetConfigurationNameAsync(string configurationName)

Parameters

configurationName string

The configuration name.

Returns

Task

A task that represents the operation.

Exceptions

SamlException

Thrown when the configuration name cannot be set.