Request
Sends a SOAP request using the provided connection, input, and options.
Task version: 1.0.0
Required Frends version: 5.7+
Required .NET version: 8.0
Compatible Agents: Crossplatform
Task Parameters
MessageBody : String
Xml Body of a message that will be wrapped into Soap envelope.
Default: -
Example: London
SoapAction : String
The SOAPAction HTTP header value (SOAP 1.1) or the action parameter in Content-Type (SOAP 1.2).
Known as the WS-Specs / WS-Addressing action field.
Default: -
Example: https://example.com/service/GetWeather
Url : String
The URL with protocol and path. You can include query parameters directly in the url.
Default: -
Example: https://example.org/path/to
Authentication : Authentication
Method of authenticating request.
Possible values:
None: Method of authenticating request.OAuth: Method of authenticating request.ClientCertificate: Method of authenticating request.Basic: Method of authenticating request.WindowsAuthentication: Method of authenticating request.WindowsIntegratedSecurity: Method of authenticating request.
Default: 0
Example: OAuth
🗝OAuthToken : String
OAuth2 Bearer token used when Authentication is set to OAuth.
Default: -
Example: eyJhbGciOiJSUzI1NiJ9...
BasicUsername : String
Username used when HTTP Basic authentication is selected.
Default: -
Example: basic-user
🗝BasicPassword : String
Password used when HTTP Basic authentication is selected.
Default: -
Example: basic-password
WindowsAuthenticationUsername : String
Username used when Windows authentication is selected.
Default: -
Example: DOMAIN\windows-user
🗝WindowsAuthenticationPassword : String
Password used when Windows authentication is selected.
Default: -
Example: windows-password
AllowInvalidCertificate : Boolean
Do not throw an exception on certificate error.
Default: False
Example: false
ClientCertPath : String
Path to the client certificate file (PFX or P12 format).
Default: -
Example: C:\certs\client.pfx
🗝ClientCertPassword : String
Password for the client certificate.
Default: -
Example: MyStrongPassword123
ProxyAddress : String
Optional HTTP proxy address.
Default: -
Example: http://localhost:8888
ProxyUsername : String
Username used for the HTTP proxy.
Default: -
Example: proxy-user
🗝ProxyPassword : String
Password used for the HTTP proxy.
Default: -
Example: proxy-password
FollowRedirects : Boolean
Determines whether HTTP redirects are automatically followed.
Default: True
Example: true
ConnectionTimeoutSeconds : Int32
HTTP request timeout in seconds. Set to 0 to disable the timeout.
Default: 100
Example: 100
CacheHttpClients : Boolean
Cache and reuse HTTP clients for identical connection settings.
Default: False
Example: false
HttpProtocolVersion : HttpProtocolVersion
HTTP protocol version used for the outgoing request.
Possible values:
Http10: HTTP protocol version used for the outgoing request.Http11: HTTP protocol version used for the outgoing request.Http20: HTTP protocol version used for the outgoing request.Http30: HTTP protocol version used for the outgoing request.
Default: 1
Example: HttpProtocolVersion.Http11
SslProtocolVersion : SslProtocolVersion
SSL/TLS protocol version used when negotiating HTTPS.
Possible values:
SystemDefault: SSL/TLS protocol version used when negotiating HTTPS.Tls12: SSL/TLS protocol version used when negotiating HTTPS.Tls13: SSL/TLS protocol version used when negotiating HTTPS.
Default: 0
Example: SslProtocolVersion.SystemDefault
CustomHeaders : Header[]
Custom HTTP headers added to the outgoing request.
Default: -
Example: Header[] { new Header { Name = "X-My-Header", Value = "value" } }
ServerCertificateThumbprints : String[]
Expected server certificate thumbprint(s) for validation.
Only used when AllowInvalidCertificate is false.
Used in mTLS mode for certificate pinning.
Default: -
Example: E5FA62B8B5F3B0B2B3B4B5B6B7B8B9B0B1B2B3B4
CertificationRevocationCheck : Boolean
Enables or disables certificate revocation checking.
Default: -
Example: false
SoapVersion : SoapVersion
SOAP version to use for wrapping the message.
Possible values:
Soap11: SOAP version to use for wrapping the message.Soap12: SOAP version to use for wrapping the message.
Default: 1
Example: SoapVersion.Soap12
IncludeWsSecurity : Boolean
Include the WS-Security header block in the SOAP envelope.
Default: True
Example: true
WsSecurityUsername : String
Username used when WS-Security UsernameToken is emitted.
Default: -
Example: service-account
🗝WsSecurityPassword : String
Password used when WS-Security UsernameToken is emitted.
Default: -
Example: MyStrongPassword123
WsSecurityPasswordType : String
Password token type used in the WS-Security UsernameToken header.
Use a full token type URI.
Default: -
Example: PasswordText
WsSecurityTimestampMinutes : Int32
Validity window for the WS-Security timestamp, in minutes.
Set to 0 to disable the WS-Security timestamp.
Default: 5
Example: 5
IncludeWsAddressing : Boolean
Include the WS-Addressing header block in the SOAP envelope.
Default: True
Example: true
WsAddressingMessageId : String
WS-Addressing message identifier.
If empty, a new UUID based identifier is generated automatically.
Default: -
Example: urn:uuid:8f4f3f77-9a0a-4c1c-8fb5-3a2f8ecb6a13
WsAddressingReplyTo : String
WS-Addressing ReplyTo address.
Default: -
Example: https://www.w3.org/2005/08/addressing/anonymous
IncludeWsReliableMessaging : Boolean
Include the WS-ReliableMessaging header block in the SOAP envelope.
Default: True
Example: true
WsReliableMessagingSequenceId : String
WS-ReliableMessaging sequence identifier.
If empty, a new UUID based identifier is generated automatically.
Default: -
Example: urn:uuid:1c0a8ef0-8e2f-4ae8-a5f6-9d0e2a8710d4
WsReliableMessagingMessageNumber : Int32
WS-ReliableMessaging message number.
Default: 1
Example: 1
IncludeWsPolicy : Boolean
Include the WS-Policy header block in the SOAP envelope.
Default: True
Example: true
WsPolicyReferenceUri : String
URI referenced by WS-Policy PolicyReference.
If empty, the request endpoint URL is used.
Default: -
Example: https://example.com/policy/service-policy
IncludeWsTrust : Boolean
Include the WS-Trust header block in the SOAP envelope.
Default: True
Example: true
WsTrustRequestType : String
WS-Trust request type URI.
Default: -
Example: https://docs.oasis-open.org/ws-sx/ws-trust/200512/Issue
WsTrustTokenType : String
WS-Trust token type URI.
Default: -
Example: urn:oasis:names:tc:SAML:2.0:assertion
WsTrustAppliesTo : String
WS-Trust AppliesTo address.
If empty, the request endpoint URL is used.
Default: -
Example: https://example.com/secured-service
IncludeWsFederation : Boolean
Include the WS-Federation header block in the SOAP envelope.
Default: True
Example: true
WsFederationRealm : String
WS-Federation realm value.
If empty, the request endpoint URL is used.
Default: -
Example: https://example.com/realm
WsFederationPassiveRequestorEndpoint : String
WS-Federation passive requestor endpoint.
If empty, the request endpoint URL is used.
Default: -
Example: https://login.example.com/passive
WsdlSource : WsdlSource
Source from which the WSDL is obtained for body validation.
Possible values:
None: Source from which the WSDL is obtained for body validation.Url: Source from which the WSDL is obtained for body validation.File: Source from which the WSDL is obtained for body validation.String: Source from which the WSDL is obtained for body validation.
Default: 0
Example: WsdlSource.None
WsdlString : String
WSDL provided as an XML string. Used when WsdlSource is String.
Default: -
Example: <definitions ...>...
WsdlPath : String
Path to the WSDL file on disk. Used when WsdlSource is File.
Default: -
Example: C:\wsdl\service.wsdl
WsdlUrl : String
URL pointing to the WSDL. Used when WsdlSource is Url.
Default: -
Example: https://example.com/service?wsdl
ThrowErrorOnFailure : Boolean
When true, exceptions are thrown on failure instead of returning a failed Result.
Default: True
Example: true
ErrorMessageOnFailure : String
Overrides the error message on failure.
Default: -
Example: Custom error message
Task Result
Success : Boolean
Indicates if the task completed successfully.
Example: true
XmlResponse : String
Response to the message.
Example: <soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/"> soap:Body 20 Sunny </soap:Body> </soap:Envelope>
Error : Error
Error that occurred during task execution.
Example: object { string Message, Exception AdditionalInfo }
Task Changelog
Changelog for Task Frends.Soap.Request.
[1.0.0] - 2026-05-12
Added
Initial implementation
Last updated
Was this helpful?