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 and replication 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 Standard. |
Authentication Type | The authentication type that you can use when you select the Standard authentication. You can select one of the following authentication types:
Default is NONE. |
Auth User ID | The user name to log in to the web service application when you select the Standard authentication. Digest authentication is not applicable. |
Auth Password | The password associated with the user name when you select the Standard authentication. Digest authentication is not applicable. |
OAuth Consumer Key | The client key associated with the web service application. Required only for Oauth authentication type. |
OAuth Consumer Secret | The client password to connect to the web service application. Required only for Oauth authentication type. |
OAuth Token | The access token to connect to the web service application. Required only for Oauth authentication type. |
OAuth Token Secret | The password associated with the OAuth token. Required only for Oauth authentication type. |
Swagger File Path | The path of the Swagger file or OpenAPI file. You can specify one of the following file paths:
If you provide the absolute path of the Swagger file or OpenAPI file, the file must be located on the Secure Agent machine. 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. |
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 | 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 | The password for the keystore file required for secure communication. You can also configure the keystore password as a JVM option. |
Proxy Type | Type of proxy. You can select one of the following options:
|
Proxy Configuration | The format required to configure proxy. You can configure proxy using the following format: <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 (;):
Note: If you define both the REST V2 connection timeout and the endpoint API timeout, the connection ends at the shortest defined timeout. For example, connectiondelaytime:10000;retryattempts:5 Note: In a streaming ingestion and replication task, only ConnectionTimeout and retryattempts are applicable. |
Connection property | Description |
|---|---|
Access Token URL | Access token URL configured in your application. |
Client ID | Client ID of your application. |
Client Secret | Client secret of your application. |
Scope | Specifies access control if the API 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. Parameters must be defined in the JSON format. For example, [{"Name":"resource","Value":"https://<serverName>"}] |
Client Authentication | 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 information provided in the above fields. |
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:
If you provide the absolute path of the swagger file or OpenAPI file, the file must be located on the Secure Agent machine. 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. Note: In a streaming ingestion and replication task, use only a hosted URL of the swagger specification file as the swagger file path. |
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 machinet. 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 | 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 | The password for the keystore file required for secure communication. You can also configure the keystore password as a JVM option. |
Proxy Type | Type of proxy. You can select one of the following options:
|
Proxy Configuration | The format required to configure proxy. You can configure proxy using the following format: <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 (;):
Note: If you define both the REST V2 connection timeout and the endpoint API timeout, the connection ends at the shortest defined timeout. For example, connectiondelaytime:10000;retryattempts:5 Note: In a streaming ingestion and replication task, only ConnectionTimeout and retryattempts are applicable. |
Connection property | Description |
|---|---|
Authorization Token URL | Authorization server URL configured in your application. |
Access Token URL | Access token URL configured in your application. |
Client ID | Client ID of your application. |
Client Secret | Client secret of your application. |
Scope | Specifies access control if the API 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. Parameters must be defined in the JSON format. For example, [{"Name":"resource","Value":"https://<serverName>"}] |
Authorization Code Parameters | Additional parameters to use with the authorization token URL. Parameters must be defined in the JSON format. For example, [{"Name":"max_age","Value":60},{"Name":"state","Value":"test"}] |
Client Authentication | 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 and refresh token based on the information provided in the above fields. |
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. |
Refresh Token | Enter the refresh token value or click Generate Access Token to populate the refresh token value. If the access token is not valid or expires, the Secure Agent fetches a new access token with the help of refresh token. If the refresh token expires, you must either provide a valid refresh token or regenerate a new refresh token by clicking Generate Access Token. |
Swagger File Path | The path of the Swagger file or OpenAPI file. You can specify one of the following file paths:
If you provide the absolute path of the swagger file or OpenAPI file, the file must be located on the Secure Agent machine. 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. Note: In a streaming ingestion and replication task, use only a hosted URL of the swagger specification file as the swagger file path. |
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 | 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 | The password for the keystore file required for secure communication. You can also configure the keystore password as a JVM option. |
Proxy Type | Type of proxy. You can select one of the following options:
|
Proxy Configuration | The format required to configure proxy. You can configure proxy using the following format: <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 (;):
Note: If you define both the REST V2 connection timeout and the endpoint API timeout, the connection ends at the shortest defined timeout. For example, connectiondelaytime:10000;retryattempts:5 Note: In a streaming ingestion and replication task, only ConnectionTimeout and retryattempts are applicable. |
Connection property | Description |
|---|---|
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:
If you provide the absolute path of the swagger file or OpenAPI file, the file must be located on the Secure Agent machine. 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. Note: In a streaming ingestion and replication 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. You can configure proxy using the following format: <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 (;):
Note: If you define both the REST V2 connection timeout and the endpoint API timeout, the connection ends at the shortest defined timeout. For example, connectiondelaytime:10000;retryattempts:5 Note: In a streaming ingestion and replication task, only ConnectionTimeout and retryattempts are applicable. |