Interface ISamlServiceProvider

Namespace

ComponentSpace.Saml2

Assembly

ComponentSpace.Saml2.dll

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

public interface ISamlServiceProvider : ISamlProvider, IArtifactResolver

Inherited Members

ISamlProvider.SetConfigurationNameAsync(string)

ISamlProvider.GetStatusAsync()

ISamlProvider.PeekMessageTypeAsync()

ISamlProvider.ClearSessionAsync(string)

IArtifactResolver.ResolveArtifactAsync()

Properties

Events

Gets or sets the optional events associated with SAML SSO and SLO.

ISamlServiceProviderEvents Events { get; set; }

Property Value

ISamlServiceProviderEvents

The optional events associated with SAML SSO and SLO.

Methods

InitiateSloAsync(string, string, string)

Initiates single logout from the service provider to the identity provider (ie. SP-initiated SLO).

An logout request is sent to the identity provider.

Task InitiateSloAsync(string partnerName = null, string logoutReason = null, string relayState = null)

Parameters

partnerName string

The partner identity provider name or null to specify the default.

logoutReason string

The logout reason or null if none.

relayState string

The relay state or null if none.

Returns

Task

A task that represents the operation.

Exceptions

SamlException

Thrown when the single logout fails.

InitiateSsoAsync(string, string, ISsoOptions)

Initiates single sign-on from the service provider to the identity provider (ie. SP-initiated SSO).

An authn request is sent to the identity provider.

Task InitiateSsoAsync(string partnerName = null, string relayState = null, ISsoOptions ssoOptions = null)

Parameters

partnerName string

The partner identity provider name or null to specify the default.

relayState string

The relay state or null if none.

ssoOptions ISsoOptions

The SSO options or null if none.

Returns

Task

A task that represents the operation.

Exceptions

SamlException

Thrown when the single sign-on fails.

ReceiveSloAsync()

Receives a single logout request (ie. IdP-initiated SLO) or single logout response (ie. SP-initiated SLO) from an identity provider.

Task<ISloResult> ReceiveSloAsync()

Returns

Task<ISloResult>

A task that represents the operation and returns the SLO result.

Exceptions

SamlException

Thrown when the single logout fails.

ReceiveSsoAsync()

Receives a single sign-on response from the identity provider (ie. IdP-initiated or SP-initiated SSO).

Task<ISpSsoResult> ReceiveSsoAsync()

Returns

Task<ISpSsoResult>

A task that represents the operation and returns the SSO result.

Exceptions

SamlException

Thrown when the single sign-on fails.

SendSloAsync(string, string)

Sends a single logout response to the identity provider (ie IdP-initiated SLO).

Task SendSloAsync(string errorMessage = null, string correlationID = null)

Parameters

errorMessage string

The error message or null if logout was successful.

correlationID string

The correlation ID identifying the logout request to respond to.

Returns

Task

A task that represents the operation.

Exceptions

SamlException

Thrown when the single logout fails.