You can enable authentication to access your application and allow the Control Room to access your application data.

Use the authentication toggle switch to authenticate sessions for your apps in the Connector Builder. This option maintains the authentication token within a session managed by the Control Room, automatically passing it to all actions within the package. This approach simplifies the authentication process by eliminating the need to manually handle authentication headers or query parameters for each action.

Prerequisites

Ensure that you have created a custom connector. See Create custom connector.

Procedure

  1. Log in to your Control Room.
  2. Navigate to Manage > Packages.
  3. On the Packages page, click the Connectors tab.
  4. Click a connector or create a new connector.
  5. Turn on the Authenticated toggle switch.
  6. Select one of the following authentication types from the drop-down:

    Authentication typeDescription
    Basic When using a package action, you need to enter a username and password to authenticate with the target application. The Control Room automatically transmits the base-64 encoded credentials in an Authorization Header with the format Basic <base-64 encoded> in your API requests.
    Oauth 2.0 When using the package action, you need to select an existing OAuth2 connection from the Control Room when using your automation. The Control Room includes the access-token retrieved from the Control Room in your API requests.
    1. Select an appropriate location type to send to the API provider as a header or query parameter.
    2. Enter a name and prefix1 for header parameter and enter a name for query parameter.
    API Key When using the package action, you need to enter an API key for authentication. The Control Room automatically transmits the API key along with the headers or parameters in your API requests.
    1. Select an appropriate location type to send to the API provider as a header or query parameter.
    2. For headers, enter a name and prefix1.
      Note:
      • A minimum of one header is required to enable API key authentication.
      • You can add multiple headers to include additional information in the Authentication action.

        Multiple headers provides additional security layer. Contextual metadata can also be included in the headers.

      • You can change the key and prefix of an existing header using the edit button.
      • You can delete the existing headers individually or collectively using the delete button.
    3. For query parameter, enter an appropriate name to be included in the request.
    Custom When using the package action, you need to enter information to create a connection. Depending on how you configure the session to be created, the Control Room includes the session information in your API requests. To configure the settings used in the authentication, see Configure action in connector editor.

    1Do not add a space after the prefix. For example, if the prefix is Bearer, just enter Bearer without any succeeding space.