Interface ISamlIdentityProvider

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

Inherited Members

ISamlProvider.SetConfigurationNameAsync(string)

ISamlProvider.GetStatusAsync()

ISamlProvider.PeekMessageTypeAsync()

ISamlProvider.ClearSessionAsync(string)

IArtifactResolver.ResolveArtifactAsync()

Namespace: ComponentSpace.Saml2

Assembly: ComponentSpace.Saml2.dll

Syntax

public interface ISamlIdentityProvider : ISamlProvider, IArtifactResolver

Properties

Events

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

Declaration

ISamlIdentityProviderEvents Events { get; set; }

Property Value

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
string	logoutReason	The logout reason or null if none.
string	relayState	The relay state or null if none.

Returns

Type	Description
Task	A task that represents the operation.

Exceptions

Type	Condition
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.

Declaration

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

Parameters

Type	Name	Description
string	partnerName	The partner service provider name or null to specify the default.
string	userID	The user ID to include in the SAML assertion or null if none.
IList<SamlAttribute>	attributes	The attributes to include in the SAML assertion or null if none.
string	relayState	The relay state (eg target URL) or null if none.
string	authnContext	The authentication context identifying how the user was authenticated or null if the configured value is to be used.
string	nameIDFormat	The name identifier format or null if the configured value is to be used.

Returns

Type	Description
Task	A task that represents the operation.

Exceptions

Type	Condition
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.

Declaration

Task<ISloResult> ReceiveSloAsync()

Returns

Type	Description
Task<ISloResult>	A task that represents the operation and returns the SLO result.

Exceptions

Type	Condition
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.

Declaration

Task<IIdpSsoResult> ReceiveSsoAsync()

Returns

Type	Description
Task<IIdpSsoResult>	A task that represents the operationand returns the SSO result.

Exceptions

Type	Condition
SamlException	Thrown when the single sign-on fails.

SendSloAsync(string, string)

Sends a single logout message to a service provider (ie. SP-initiated SLO).

Declaration

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

Parameters

Type	Name	Description
string	errorMessage	The error message or null if logout was successful.
string	correlationID	The correlation ID identifying the logout request to respond to.

Returns

Type	Description
Task	A task that represents the operation.

Exceptions

Type	Condition
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.

Declaration

Task SendSsoAsync(Status status, string correlationID = null)

Parameters

Type	Name	Description
Status	status	The error status.
string	correlationID	The correlation ID identifying the authentication request to respond to.

Returns

Type	Description
Task	A task that represents the operation.

Exceptions

Type	Condition
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.

Declaration

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

Parameters

Type	Name	Description
string	userID	The user ID to include in the SAML assertion or null if none.
IList<SamlAttribute>	attributes	The attributes to include in the SAML assertion or null if none.
string	authnContext	The authentication context identifying how the user was authenticated or null if the configured value is to be used.
string	nameIDFormat	The name identifier format or null if the configured value is to be used.
string	correlationID	The correlation ID identifying the authentication request to respond to.

Returns

Type	Description
Task	A task that represents the operation.

Exceptions

Type	Condition
SamlException	Thrown when the single sign-on fails.

See Also

SamlConstants.AuthnContextClasses

SamlConstants.NameIdentifierFormats