Interface ISsoStatus

Specifies the SSO status.

Namespace: ComponentSpace.Saml2

Assembly: ComponentSpace.Saml2.dll

Syntax

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.

Declaration

Task<bool> CanSloAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	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.

Declaration

Task<bool> CanSloAsync(string partnerName)

Parameters

Type	Name	Description
System.String	partnerName	The partner provider name.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	A task that represents the operation and returns true if single logout can occur; otherwise false.

GetPartnerPendingResponse(String)

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

Declaration

string GetPartnerPendingResponse(string correlationID)

Parameters

Type	Name	Description
System.String	correlationID

Returns

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

Declaration

string[] GetPartnersPendingResponse()

Returns

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

Declaration

bool IsSloCompletionPending()

Returns

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

Declaration

bool IsSloCompletionPending(string partnerName)

Parameters

Type	Name	Description
System.String	partnerName	The partner provider name.

Returns

Type	Description
System.Boolean	true if single logout completion is pending; otherwise false.

IsSso()

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

Declaration

bool IsSso()

Returns

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

Declaration

bool IsSso(string partnerName)

Parameters

Type	Name	Description
System.String	partnerName	The partner provider name.

Returns

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

Declaration

bool IsSsoCompletionPending()

Returns

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

Declaration

bool IsSsoCompletionPending(string partnerName)

Parameters

Type	Name	Description
System.String	partnerName	The partner provider name.

Returns

Type	Description
System.Boolean	true if single sign-on completion is pending; otherwise false.