Table of Contents

Search

  1. Preface
  2. Connectors and connections
  3. Connection configuration
  4. Connection properties
  5. Swagger file generation for REST V2 connections

Connections

Connections

Client Credential Authentication

Client Credential Authentication

The following table describes the REST V3 connection properties for OAuth 2.0 client credentials authentication type connection:
Connection property
Description
Runtime Environment
Name of the runtime environment where you want to run the tasks.
Specify a Secure Agent or serverless runtime environment.
Auth Type
The authentication method that the connector must use to connect to the REST endpoint.
Select
OAuth 2.0 client credentials
.
Default is None.
Access Token URL
Access token URL configured in your application.
Client ID
The client identifier issued during the application registration process.
Client Secret
The client secret issued during the application registration process.
Scope
The scope of the access request when the rest endpoint has defined custom scopes. Enter space-separated scope attributes.
For example:
root_readonly root_readwrite manage_app_users
Access Token Parameters
Additional parameters to use with the access token URL. Define parameters in the JSON format.
For example:
[{"Name":"resource","Value":"https://<serverName>"}]
Client Authentication
The client authentication details for authorization.
Select an option to send Client ID and Client Secret for authorization either in the request body or in the request header.
Default is
Send client credentials in body
.
Generate Access Token
Generates access token based on the authentication details provided.
Access Token
The access token granted by the authorization server to access the data using a specific role. Enter the access token value or click
Generate Access Token
to populate the access token value.
To pass the generate access token call through a proxy server, you must configure a proxy server at the Secure Agent level. The REST V3 connection-level proxy configuration does not apply to the generate access token call.
TrustStore File Path
The absolute path of the truststore file that contains the TLS certificate to establish a one-way or two-way secure connection with the REST API.
Ensure that the truststore file is in .jks format. Specify a directory path that is available on each Secure Agent machine in the runtime environment.
TrustStore Password
The password for the truststore file that contains the SSL certificate.
KeyStore File Path
The absolute path of the keystore file that contains the keys and certificates required to establish a two-way secure communication with the REST API.
Ensure that the keystore file is in .jks format. Specify a directory path that is available on each Secure Agent machine in the runtime environment.
KeyStore Password
The password for the keystore file required for secure communication.
Proxy Type
Type of proxy.
You can select one of the following options:
  • None. Bypasses the proxy server configured at the agent or the connection level.
  • Custom. Considers proxy configured at the connection level.
  • Platform. Considers proxy configured at the agent level.
Proxy is not applicable when you use the serverless runtime environment.
Proxy Host
The IP address or host name of the proxy server.
Required only for the Custom proxy type.
Proxy Port
The port number of the proxy server.
Required only for the Custom proxy type.
Proxy User
The user name for the proxy server.
Required only for the Custom proxy type.
Proxy Password
The password for the proxy server.
Required only for the Custom proxy type.
Connection Timeout
The wait time in seconds to get a response from a REST endpoint. The connection ends after the connection timeout is over.
Default is 60 seconds.
If you define both the REST V3 connection timeout and the endpoint API timeout, the connection ends at the shortest defined timeout.
Retry Attempts
Number of times to retry the connection when 100, 300, 400, and 500 series error codes are returned in the response.
Default is 0. Specify 0 to disable the retry attempts.
In case of 408 error code, silent retries are attempted. Therefore, the number of retry attempts can be more than the value you specify.
Retry Delay
The wait time in seconds before a retry is attempted.
Default is 0.
HTTP version
The HTTP version to connect to the rest endpoint.
You can select one of the following options:
  • HTTP 2
  • HTTP 1.1
Default is HTTP 2.

0 COMMENTS

We’d like to hear from you!