Interface ISoapBinding

Supports the HTTP SOAP binding.

Namespace: ComponentSpace.Saml2.Bindings.Soap

Assembly: ComponentSpace.Saml2.dll

Syntax

public interface ISoapBinding

Remarks

Refer to the Bindings for the OASIS Security Assertion Markup Language (SAML) V2.0 specification for further details.

Methods

IsValid()

Indicates whether the current HTTP request is valid for the binding.

Declaration

bool IsValid()

Returns

Type	Description
System.Boolean	true if the current HTTP request is valid for the binding; otherwise false.

ReceiveRequestAsync()

Receives a SAML request.

Declaration

Task<ReceiveResult> ReceiveRequestAsync()

Returns

Type	Description
System.Threading.Tasks.Task<ReceiveResult>	A task that represents the operation and returns the HTTP SOAP result.

Exceptions

Type	Condition
SamlBindingException	Thrown if the SAML request cannot be received.

SendRequestReceiveResponseAsync(String, String)

Sends a SAML request and receives a SAML response.

Declaration

Task<ReceiveResult> SendRequestReceiveResponseAsync(string url, string message)

Parameters

Type	Name	Description
System.String	url	The URL to receive the SAML message.
System.String	message	The SAML message XML.

Returns

Type	Description
System.Threading.Tasks.Task<ReceiveResult>	A task that represents the operation and returns the HTTP SOAP result.

Exceptions

Type	Condition
SamlBindingException	Thrown if the SAML request cannot be sent or the SAML response cannot be received.

SendResponseAsync(String)

Sends a SAML response.

Declaration

Task SendResponseAsync(string message)

Parameters

Type	Name	Description
System.String	message	The SAML message XML.

Returns

Type	Description
System.Threading.Tasks.Task	A task that represents the operation.

Exceptions

Type	Condition
SamlBindingException	Thrown if the SAML message cannot be sent.