The HTTP Client collector function collects data from a third-party HTTP server. You can configure this function to set the values for how the HTTP Client function would behave when communication with the third-party HTTP server, and how to specify the method of communication.

You can configure this function in the following settings.

• Connection

• Operational settings

• General settings

• Results

Connection

Depending on the users' configuration, two three authentication methods are available: None, Basic authentication and OAuth 2.0 implementation.

.

A selectable option from the Authentication type is used to make the selection and based on that separate configuration options are available. There will be additional options for the Authentication type selected.

Note!

.

In Target URL, enter the URL of the target HTTP server.  You can use Variable Insertion.

Select to customize the headers of the URL and specify multiple keys and their respective values.

The default value for the HTTP headers “content-type” and “accept” is application/json.

You can override the default value for the HTTP header “content-type.”

It is recommended that the default value for the HTTP

When the Authentication type selection is selected as OAuth 2.0 additional options are displayed. Their configuration is mandatory to properly activate the function. 

OAuth 2.0 credentials

It is also possible to use the Secrets Wallet functionality to apply stored credentials for the three HTTP Functions. 

If Secrets Wallet is not enabled, you configure the following fields.

• Grant type – In this field, select the grant type of the credential.

• Client ID – In this field enter the client identifier. 

• Client Secretsecret – in In this field enter the associated client secret. This parameter may be omitted if the client secret is an empty string. 

• Username – This field is used to specify the relevant username, it is mandatory.  This field appears when the Password credentials is selected for the Grant type.

• Password – This field is used to specify the password associated with the username, it is mandatory. 

• . This field appears when the Password credentials is selected for the Grant type.

OAuth 2.0 parameters

The OAuth 2.0 parameters section of the function controls the authentication token credentials. The Token Header Prefix field is the Authorization header placed before the access token. Based Based on the Grant Type selection in the OAuth 2.0 credentials section, there are two types of credentials access provided for the authentication provisions – Password and Client credentials. Each of them has a distinctive configuration option.

Password Credentials Grant Type Options

• Access token URL – In this field specify the URL containing the authorization token. 

• Token header prefix – is the Authorization header placed before the access token.

• Scope – The authorization and token endpoints allow the client to specify the access request scope using this parameter. The entered value must be expressed as a list of space-delimited, case-sensitive strings. This is an optional parameter.

• Audience

• Client Authentication – This option controls the type of authentication mechanism as defined by the connecting server – Auth Header or Auth Body are available. The options are named "Send as Basic Auth Header" and "Send client credentials in body". 

Client Credentials Grant Type Options 

• Access token URL – In this field specify the URL containing the authorization token. 

• Client ID – In this field enter the client identifier. 

• Client Secret – in this field enter the associated client secret. This parameter may be omitted if the client secret is an empty string. 

• Token header prefixToken header prefix –is the Authorization header placed before the access token.

• Scope – The authorization and token endpoints allow the client to specify the access request scope using this parameter. The entered value must be expressed as a list of space-delimited, case-sensitive strings. This is an optional parameter.

• Audience

• Client Authentication – This option controls the type of authentication mechanism as defined by the connecting server – Auth Header or Auth Body are available. The options are named "Send as Basic Auth Header" and "Send client credentials in body". 

Private Key JWT Grant Type Options Options

If Secrets wallet is enabled in the OAuth 2.0 credentials section, and a Private key JWT authentication type is selected, these options have to be configured.

• Access token URL – In this field specify the URL containing the authorization token. 

• Client ID – In this field enter the client identifier. 

• Client Secret – in this field enter the associated client secret. This parameter may be omitted if the client secret is an empty string. 

• Token header prefix

• Issuer

• Audience

• Subject

• IdentifierToken header prefix – Is the Authorization header placed before the access token.

• Issuer – Identifies the issuer of the JWT

• Audience – Identifies the recipients that the JWT is intended for. It can be a single recipient or a list of recipients.

• Subject – Identifies the subject of the JWT, typically representing the user or entity the token is about.

• Identifier – Provides a unique identifier for the JWT.

The Use redirect fields checkbox allows you to toggle URL redirection using the available options. Two fields are displayed when this option is enabled – the Target URL field where the designated address is to be entered, and an optional Resource path.

Operational settings

In Operational settings, enter the following details that determine how you want to handle the errors. The following options are available for HTTP Collector and Processor Functions only:

In Request run limit, specify the number of times the operation should run. 

In Action on error, specify the action you want to take in case of an error. You can select from the following options:

Any response with the HTTP status code 4xx or 5xx is considered an error. All errors get logged in the system logs. You can refer to the Logs for more information. The default value is Ignore.

General settings

You select an HTTP request method from the following options:

Both authentication types also include optional parameters: 

• Include query string in URL – This enables a query string in the token URL. 

• Customize header - This allows for custom headers to be specified.

1. Select Body or Form and add the corresponding details in the content of the request message. You can use Variable Insertion.

2. Expand the examples below to view samples of HTTP request messages for Body or Form:

{
"name" : "my_username",
"first-name" : "My",
"last-name" : "Username",
"display-name" : "My Username",
"email" : "user@example.test",
"active" : true
}

name=my_username&first-name=My&last-name=Username&display-name=My%20Username&email=user@example.test&active=true

Results

Response Headers

The support for response headers can be enabled by toggling the Enable response headers option.A default value for the key will be added by the engine (httpResponseHeaders) which will match the placeholder for the key input. Configuration is done by filling up the necessary input fields: Result Header Key and Result Key.

In Result Key, you can assign a name to the result that you receive in response to the request. It is recommended to configure the resulting key to make future references of the same response easy and traceable. The default value is httpResponse.