Enable authentication action

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

You have the following options to authenticate sessions for your apps in the Connector Builder:

  • Authentication toggle switch: When you use this option, the auth token is maintained in a session. The Control Room manages this session and passes the token to all the actions in the package that leverage this session. We recommend that you use this option because the session context is maintained for you by the Control Room and you need not explicitly pass authentication header or query parameter in each of your actions.
  • Add an authentication action: When you use this option, you will need to explicitly pass the auth token to all the other actions in the package. Based on the API specifications used, you will either send the token in the header or the query parameter for each of the actions in the package. See Add action in Connector Builder.

Prerequisites

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

Procedure

  1. Turn on the Authenticated toggle switch.
  2. Select one of the following authentication types from the drop-down:
    Authentication type Description
    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 prefix 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. Enter a name and prefix for header parameter and enter a name for query parameter.
    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.