Administrator
- Administrator
- All Products
ASK INFAPreview
Please log in to access Bolo.
ASK INFAPreview
Connection property
| Description
|
|---|---|
Connection Name
| Name of the connection.
Each connection name must be unique within the organization. Connection names can contain alphanumeric characters, spaces, and the following special characters: _ . + -,
Maximum length is 255 characters.
|
Description
| Description of the connection. Maximum length is 4000 characters.
|
Type
| The REST V2 connection type.
|
Runtime Environment
| Name of the runtime environment where you want to run the tasks.
Select a Secure Agent, Hosted Agent, or serverless runtime environment.
You cannot run a streaming ingestion task on a Hosted Agent or serverless runtime environment.
|
Authentication
| The authentication method that the REST V2 Connector must use to connect to the REST endpoint.
Select
JWT Bearer Token .
|
JWT Header
| JWT header in JSON format.
Sample:
{ "alg":"RS256", "kid":"xxyyzz" } You can configure
HS256 and
RS256 algorithms.
|
JWT Payload
| JWT payload in JSON format.
Sample:
{ "iss":"abc", "sub":"678", "aud":"https://api.box.com/oauth2/token", "box_sub_type":"enterprise", "exp":"120" , "jti":"3ee9364e" } The expiry time represented as
exp is the relative time in seconds. The expiry time is calculated in the UTC format from the token issuer time (iat ).
When
iat is defined in the payload and the expiry time is reached, mappings and Generate Access Token will fail. To generate a new access token, you must provide a valid
iat in the payload.
If
iat is not defined in the payload, the expiry time is calculated from the current timestamp.
To pass the expiry time as a string value, enclose the value with double quotes. For example:
"exp":"120" ,To pass the expiry time as an integer value, do not enclose the value with double quotes.
For example,
"exp":120 , |
Authorization Server
| Access token URL configured in your application.
|
Authorization Advanced Properties
| Additional parameters to use with the access token URL. Parameters must be defined in the JSON format.
For example,
[\{"Name":"client_id","Value":"abc"},\{"Name":"client_secret","Value":"abc"}] |
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. Specify a directory path that is available on each Secure Agent machine.
You can also configure the truststore file name and password as a JVM option or import the certificate to the following directory:
<Secure Agent installation directory\jre\lib\security\cacerts .
For the serverless runtime environment, specify the truststore file path in the serverless agent directory.
For example,
/home/cldagnt/SystemAgent/serverless/configurations/ssl_store/<cert_name>.jks |
TrustStore Password
| The password for the truststore file that contains the SSL certificate.
You can also configure the truststore password as a JVM option.
|
KeyStore File Path
| Mandatory. 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. Specify a directory path that is available on each Secure Agent machine.
You can also configure the keystore file name and location as a JVM option or import the certificate to any directory.
For the serverless runtime environment, specify the keystore file path in the serverless agent directory.
For example,
/home/cldagnt/SystemAgent/serverless/configurations/ssl_store/<cert_name>.jks |
KeyStore Password
| Mandatory. The password for the keystore file required for secure communication.
You can also configure the keystore password as a JVM option.
|
Private Key Alias
| Mandatory. Alias name of the private key used to sign the JWT payload.
|
Private Key Password
| Mandatory. The password for the keystore file required for secure communication. The private key password must be same as the keystore password.
|
Access Token
| 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 an unauthenticated proxy server at the Secure Agent level. The REST V2 connection-level proxy configuration does not apply to the generate access token call.
|
Swagger File Path
| The path of the Swagger file or OpenAPI file.
You can specify one of the following file paths:
The hosted URL must return the content of the file without prompting for further authentication and redirection.
For example, the path of the swagger file can be:
C:\swagger\sampleSwagger.json The user must have the read permission for the folder and the file.
In a
streaming ingestion task, use only a hosted URL of the swagger specification file as the swagger file path.
|
Proxy Type
| Type of proxy. You can select one of the following options:
|
Proxy Configuration
| The format required to configure proxy.
<host>:<port> You cannot configure an authenticated proxy server.
|
Advanced Fields
| Enter the arguments that the agent uses when connecting to a REST endpoint.
You can specify the following arguments, each separated by a semicolon ( ; ):
For example,
connectiondelaytime:10000;retryattempts:5 In a
streaming ingestion task, only
ConnectionTimeout and
retryattempts are applicable.
|
