Interface ISsoStatus

Namespace

ComponentSpace.Saml2

Assembly

ComponentSpace.Saml2.dll

Specifies the SSO status.

public interface ISsoStatus

Methods

CanSloAsync()

Indicates whether the local provider can single logout to one or more partner providers.

To single logout, one or more partner providers must have successfully completed SSO and also support SLO.

Task<bool> CanSloAsync()

Returns

Task<bool>

A task that represents the operation and returns true if single logout can occur; otherwise false.

CanSloAsync(string)

Indicates whether the local provider can single logout to a partner provider.

To single logout, the partner provider must have successfully completed SSO and also support SLO.

Task<bool> CanSloAsync(string partnerName)

Parameters

partnerName string

The partner provider name.

Returns

Task<bool>

A task that represents the operation and returns true if single logout can occur; otherwise false.

GetConfigurationName()

Gets the SAML configuration name for the current SAML SSO session.

string GetConfigurationName()

Returns

string

The configuration name or null if none.

GetPartnerPendingResponse(string)

Gets the name of the partner provider to which a response is pending for the specified correlation ID.

string GetPartnerPendingResponse(string correlationID)

Parameters

correlationID string

Returns

string

The name of the partner provider or null if none.

GetPartnersPendingResponse()

Gets the names of the partner providers to which a single sign-on or logout response is pending.

string[] GetPartnersPendingResponse()

Returns

string[]

The names of the partner providers or null if none.

IsSloCompletionPending()

Indicates whether completion of single logout is pending.

Single logout is pending if a logout request has been received but a logout response hasn't been sent or a logout request has been sent but a logout response hasn't been received.

bool IsSloCompletionPending()

Returns

bool

true if single logout completion is pending; otherwise false.

IsSloCompletionPending(string)

Indicates whether completion of single logout is pending.

Single logout is pending if a logout request has been received but a logout response hasn't been sent or a logout request has been sent but a logout response hasn't been received.

bool IsSloCompletionPending(string partnerName)

Parameters

partnerName string

The partner provider name.

Returns

bool

true if single logout completion is pending; otherwise false.

IsSso()

Indicates whether the local provider is currently single signed-on with any partner provider.

bool IsSso()

Returns

bool

true if currently single signed-on; otherwise false.

IsSso(string)

Indicates whether the local provider is currently single signed-on with the specified partner provider.

bool IsSso(string partnerName)

Parameters

partnerName string

The partner provider name.

Returns

bool

true if currently single signed-on; otherwise false.

IsSsoCompletionPending()

Indicates whether completion of single sign-on is pending.

Single sign-on is pending if the service provider has sent an authn request but the identity provider hasn't sent the SAML response.

bool IsSsoCompletionPending()

Returns

bool

true if single sign-on completion is pending; otherwise false.

IsSsoCompletionPending(string)

Indicates whether completion of single sign-on is pending with the specified partner provider.

Single sign-on is pending if the service provider has sent an authn request but the identity provider hasn't sent the SAML response.

bool IsSsoCompletionPending(string partnerName)

Parameters

partnerName string

The partner provider name.

Returns

bool

true if single sign-on completion is pending; otherwise false.