Interface ISamlIdentityProvider

Namespace

ComponentSpace.Saml2

Assembly

ComponentSpace.Saml2.dll

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

public interface ISamlIdentityProvider : 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.

ISamlIdentityProviderEvents Events { get; set; }

Property Value

ISamlIdentityProviderEvents

The optional events associated with SAML SSO and SLO.

Methods

InitiateSloAsync(string, string)

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

A logout request is sent to the service providers that are signed in.

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

Parameters

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, IList<SamlAttribute>, string, string, string)

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

A SAML response containing a SAML assertion is sent to the service provider.

Task InitiateSsoAsync(string partnerName = null, string userID = null, IList<SamlAttribute> attributes = null, string relayState = null, string authnContext = null, string nameIDFormat = null)

Parameters

partnerName string

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

userID string

The user ID to include in the SAML assertion or null if none.

attributes IList<SamlAttribute>

The attributes to include in the SAML assertion or null if none.

relayState string

The relay state (eg target URL) or null if none.

authnContext string

The authentication context identifying how the user was authenticated or null if the configured value is to be used.

nameIDFormat string

The name identifier format or null if the configured value is to be used.

Returns

Task

A task that represents the operation.

Exceptions

SamlException

Thrown when the single sign-on fails.

See Also

SamlConstants.AuthnContextClasses

SamlConstants.NameIdentifierFormats

ReceiveSloAsync()

Receives a single logout request (ie. SP-initiated SLO) or single logout response (ie. IdP-initiated SLO) from a service 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 request from a service provider (ie. SP-initiated SSO).

An authn request is received from the service provider.

Task<IIdpSsoResult> ReceiveSsoAsync()

Returns

Task<IIdpSsoResult>

A task that represents the operationand returns the SSO result.

Exceptions

SamlException

Thrown when the single sign-on fails.

SendSloAsync(string, string)

Sends a single logout message to a service provider (ie. SP-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.

SendSsoAsync(Status, string)

Sends a single sign-on error response as part of SP-initiated SSO.

A SAML error response is sent to the service provider.

Task SendSsoAsync(Status status, string correlationID = null)

Parameters

status Status

The error status.

correlationID string

The correlation ID identifying the authentication request to respond to.

Returns

Task

A task that represents the operation.

Exceptions

SamlException

Thrown when the single sign-on fails.

SendSsoAsync(string, IList<SamlAttribute>, string, string, string)

Sends a single sign-on response as part of SP-initiated SSO.

A SAML response containing a SAML assertion is sent to the service provider.

Task SendSsoAsync(string userID = null, IList<SamlAttribute> attributes = null, string authnContext = null, string nameIDFormat = null, string correlationID = null)

Parameters

userID string

The user ID to include in the SAML assertion or null if none.

attributes IList<SamlAttribute>

The attributes to include in the SAML assertion or null if none.

authnContext string

The authentication context identifying how the user was authenticated or null if the configured value is to be used.

nameIDFormat string

The name identifier format or null if the configured value is to be used.

correlationID string

The correlation ID identifying the authentication request to respond to.

Returns

Task

A task that represents the operation.

Exceptions

SamlException

Thrown when the single sign-on fails.

See Also

SamlConstants.AuthnContextClasses

SamlConstants.NameIdentifierFormats