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 communicating with the third-party HTTP server, and how to specify the method of communication.

You can configure this function in the following settings.

:

Connection

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

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 selectedWhen you select an Authentication type, there will be separate configuration options for the selected authentication type.

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

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

• Scope – The authorization and token endpoints allow the client you 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 - Set the recipient that the token is intended for.

• Client Authenticationauthentication – 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 Headerbasic auth header" and "Send client credentials in body".

If Secrets wallet is enabled in the OAuth 2.0 credentials section, and the Private key JWT authentication type is selected, there are distinctive configuration options:

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

• Token header prefix – The authorization header placed before the access token.

• Issuer – Set the issuer of the JWT

• Audience – Set the recipient that the JWT is the Authorization intended for.

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

• Identifier – Set a unique identifier for the JWT.

• Add claim – List the permissions that the application requests. When you click the Add claim button, you enter the Key and Value of the permission.

If Secrets wallet is enabled in the OAuth 2.0 credentials section, and the Bearer token authentication type is selected, there are distinctive configuration options.

• Token header prefix – 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 - Set the recipient that the token is intended for. This is an optional parameter.

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

• 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.

• 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.

Operational settings

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

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

in a single stream. The limit of runs you can request is from one to 12.

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.

See Logs for more information.

The default value is Ignore.

General settings

In General settings, you select an HTTP request method from the following options:

You can select a combination of the following options to be included:

Note!

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

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

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.

The support for response headers can be enabled by toggling on the Enable response headers option.A default value for the key Result headers 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 headers Key and Result key.