Interface IHttpArtifactBinding

Supports the HTTP Artifact binding.

Namespace: ComponentSpace.Saml2.Bindings.Artifact

Assembly: ComponentSpace.Saml2.dll

Syntax

public interface IHttpArtifactBinding

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.

ReceiveArtifactAsync()

Receives an HTTP artifact.

Declaration

Task<ReceiveResult> ReceiveArtifactAsync()

Returns

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

Exceptions

Type	Condition
SamlBindingException	Thrown if the HTTP artifact cannot be received.

SendArtifactAsync(string, ArtifactEncoding, HttpArtifact, string)

Sends an HTTP artifact.

Declaration

Task SendArtifactAsync(string url, ArtifactEncoding encoding, HttpArtifact artifact, string relayState = null)

Parameters

Type	Name	Description
string	url	The URL to receive the artifact.
ArtifactEncoding	encoding	The HTTP artifact encoding used to transport the artifact.
HttpArtifact	artifact	The HTTP artifact.
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 HTTP artifact cannot be sent.