Show / Hide Table of Contents

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

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
System.Threading.Tasks.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, Boolean, String)

Sends a SAML message.

Declaration
Task SendMessageAsync(string url, string message, bool isResponse, string relayState = null)
Parameters
Type Name Description
System.String url

The URL to receive the SAML message.

System.String message

The SAML message XML.

System.Boolean isResponse

The flag indicating whether a SAML request or response.

System.String relayState

The relay state or null if none.

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.

In This Article
Back to top Copyright © ComponentSpace Pty Ltd 2017-2022. All rights reserved.