Interface ISoapBinding
Supports the HTTP SOAP binding.
Namespace: ComponentSpace.Saml2.Bindings.Soap
Assembly: ComponentSpace.Saml2.dll
Syntax
public interface ISoapBindingRemarks
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 |
|
ReceiveRequestAsync()
Receives a SAML request.
Declaration
Task<ReceiveResult> ReceiveRequestAsync()Returns
| Type | Description |
|---|---|
| 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 |
|---|---|---|
| string | url | The URL to receive the SAML message. |
| string | message | The SAML message XML. |
Returns
| Type | Description |
|---|---|
| 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 |
|---|---|---|
| string | message | The SAML message XML. |
Returns
| Type | Description |
|---|---|
| Task | A task that represents the operation. |
Exceptions
| Type | Condition |
|---|---|
| SamlBindingException | Thrown if the SAML message cannot be sent. |