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

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.