Interface IHttpPostBinding

Supports the HTTP POST binding.

Namespace: ComponentSpace.Saml2.Bindings.Post

Assembly: ComponentSpace.Saml2.dll

Syntax

public interface IHttpPostBinding

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
bool	true if the current HTTP request is valid for the binding; otherwise false.

ReceiveMessageAsync()

Receives a SAML message.

Declaration

Task<ReceiveResult> ReceiveMessageAsync()

Returns

Type	Description
Task<ReceiveResult>	A task that represents the operation and returns the HTTP Post result.

Exceptions

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

SendMessageAsync(string, string, bool, string)

Sends a SAML message.

Declaration

Task SendMessageAsync(string url, string message, bool isResponse, string relayState = null)

Parameters

Type	Name	Description
string	url	The URL to receive the SAML message.
string	message	The SAML message XML.
bool	isResponse	The flag indicating whether a SAML request or response.
string	relayState	The relay state or null if none.

Returns

Type	Description
Task	A task that represents the operation.

Exceptions

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