REST

Use the REST connector to consume REST services.

Add connector

1. Select Connectors in Hub menu and select Add Connector.

   
2. Select REST Connector

   
3. Enter the name and optionally a description.

   
4. Enter the configuration values for different environments.

5. Select Save.

Configuration values

Configuration	Description
Agent Group	Agent group where the connector should be executed
Base URL	Base address of the REST service
Authentication Type	Authentication type defines the authentication mechanism to use while communication with REST service. None - No authentication Basic Authentication - Can be used for REST API's protected with basic authentication and often involves providing a username and password. API Key Credentials - Can be used for REST API's protected with some sort of a API key. Typically the key is sent either via a query parameter or as a header. OAuth2 Client Credentials - Can be used for REST API's protected with OAuth2 client credentials grant type. Token Endpoint - The URL of the token endpoint Client ID - The client id obtained from app registration Client Secret - The client secret obtained from app registration Scopes - You can add one more scopes separated by space OAuth2 Password Credentials - Can be used for REST API's protected with OAuth2 password credentials grant type. Token Endpoint - The URL of the token endpoint Client ID - The client id obtained from app registration Client Secret - The client secret obtained from app registration Username - The username of the resource owner Password - The password of the resource owner Scopes - You can add one more scopes separated by space OAuth2 Authorization Code Flow - Can be used for REST API's protected with OAuth2 authorization flow grant type. Display Name - The given name of the external system/IDP and it will be used in the client prompt Authorization Endpoint - The URL of the auth endpoint Token Endpoint - The URL of the token endpoint Client ID - The client id obtained from app registration Client Secret - The client secret obtained from app registration Scopes - You can add one or more scopes separated by space Advanced Section Extra Query Parameters - You can add one or more extra query parameters. These parameters provide context, customization, or security enhancements to the authorization process. Example: prompt=login forces the authorization server to prompt the user to log in, regardless of any active session PKCE - Dictates if PKCE should used in the authorization flow. Typically PKCE is used for securing public clients and mobile applications Prefill User Email - When enabled flow user email address will be used as the pre-fill username/email in the external systems log-in prompt Private Session - When enabled opens a none cookie storing web browser in iOS and Android clients during the auth steps. You will find the Redirect URIs here. Open ID Authentication - Can be used for REST API's protected with Open ID connect. Display Name - The given name of the external system/IDP and it will be used in the client prompt Authorization Endpoint - The URL of the auth endpoint Client ID - The client id obtained from app registration Scopes - You can add one or more scopes separated by space. By default it is set to openid Advanced Section Extra Query Parameters - You can add one or more extra query parameters. These parameters provide context, customization, or security enhancements to the authorization process. Example: prompt=login forces the authorization server to prompt the user to log in, regardless of any active session Prefill User Email - When enabled flow user email address will be used as the pre-fill username/email in the external systems log-in prompt Private Session - When enabled opens a none cookie storing web browser in iOS and Android clients during the auth steps. You will find the Redirect URIs here.

Edit connector

1. Hover over the connector card and the context menu will appear, select Edit.

2. You can now change or the configuration values for different environments.

Delete connector

1. Hover over the connector card and the context menu will appear, select Delete.

2. Confirm and the connector will be deleted.

Deleting a connector can not be undone.

Configure Passthrough proxy

You can configure a passthrough proxy for REST communication in the Agent settings. This configuration is applied per Agent. If your Agent Group includes multiple Agents, you must configure the proxy individually for each one. A passthrough proxy in this case should simply forwards API calls from the connector to the target REST API, and returns the responses back, unchanged. No changes are required in the connector configuration.

To configure the passthrough proxy,

1. In the Agent Manager select an agent and select Details.

2. Stop the agent if its in running state.

3. Select Open Folder. This is will open the local file folder where the agent is installed.

4. In the local installation folder find the file named appSettings.json file and open it in you favorite text editor.

5. Add the following configuration at the end and save (make sure you add a comma before this section)

    "Proxy": {  
       "Address": "",  
       "Bypass": [],   
       "Username": "",  
       "Password": "",  
       "Domain": ""  
    }

   The "Bypass" field lists addresses or domains that should not go through the proxy.

6. Restart the Agent.