REST
Last updated
Last updated
Use the REST connector to consume REST services.
Select Connectors in Hub menu and select Add Connector.
Select REST Connector
Enter the name and optionally a description.
Enter the configuration values for different environments.
Select Save.
Hover over the connector card and the context menu will appear, select Edit.
You can now change or the configuration values for different environments.
Hover over the connector card and the context menu will appear, select Delete.
Confirm and the connector will be deleted.
Deleting a connector can not be undone.
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.
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.
