WebService Interface Template
The template defines the parameters for connecting to a service supporting SOAP requests.
Refer to the common template parameters.
Template parameters
| Parameter | Type | Description |
|---|---|---|
| Url | External | The url of the service to connect to. |
| UseDefaultCredentials | External | Whether the credentials of the user running the process should be used. |
| Domain | External | The domain of the user used for authentication on the service. |
| Username | External | The username of the user used for authentication on the service. |
| Password | External | The password of the user used for authentication on the service. |
| Debug | External | When set to true, this will output a debugging record instead of the actual call result. |
| SkipCertificateValidation | External | Specifies whether certificate validation should be skipped when calling the service. Don't set this to true for production environments as this can cause a security threat. This setting allows you to bypass the validation of self-signed certificates which would otherwise throw an exception. |
| OAuth Url | External | The full url of where to fetch the access token to use. Optional. If both username, password and OAuth Url are provided, the request will be made with Basic Authentication in conjunction with the requested access token |
| OAuth Scope | External | The authentication scope for OAuth. Optional. By default, the scope is sent as scope in the body. This can be overridden by prefixing the value and separate it with a semicolon: resource;user.profile.read. |
| OAuth Client ID | External | The client id to send along with the OAuth token request. Optional but required when an OAuth Url is given. |
| OAuth Client Secret | External | The client secret to authenticate on the OAuth service. Required when an OAuth Url is given. |
| OAuth Grant Type | External | The grant type to use for requesting a token. The default parameter name which is send to the OAuth provider is grant_type. If this is different you can override this by separating it with a semicolon: my_grant_type;client_credentials" |
| OAuth Use On Behalf Of | External | Set to true to use the on-behalf-of flow which will cause the request to be done with the user's identity making use of delegation and OBO tokens in Microsoft Entra. |
| WSS Password Type | External | The WS-Security password type to use for basic authentication. Only 'Text' is supported at this moment. Leave empty to disable WS-Security and just use the authorization header. |
| WSS Certificate | External | The subject of the certificate to use for signing the SOAP message and creating/altering the security element in the SOAP envelope. |
| Request Encoding | External | The encoding to use for sending the request to the Web Service. If left empty, the default encoding is used. Both encoding names as well as code page numbers are allowed here. Please consult this page for the possible encodings. |
Note
When you want to use a certificate to generate the WS-Security element, it is important that:
- The certificate is placed in the Personal store of the Local Computer including the private key
- The complete subject of the certificate is set in the WSS Certificate profile field. In the example below the subject would be 'CN=DigiCert Global Root CA, OU=www.digicert.com, O=DigiCert Inc, C=US'
