Adding custom authentication steps

Use the Custom authentication configuration tab in the Connector Development Kit to define how your connector retrieves and manages authentication tokens. You can configure one or more steps to generate tokens, send credentials, and map responses to connection properties.

1. From the Connector Development Kit home page, open the connector that you want to work with.
2. Go to the Connection Properties tab.
3. Click the Custom authentication configuration tab, then click the Add custom authentication step + button.
4. Complete the steps that follow:
   1. In the Step title field, enter a name that describes the step (for example, Custom authentication step 1).
   2. In the URL field, enter the endpoint URL for the token or session ID. You can use mappings and numeric functions to customize the URL as necessary.
   3. Select the HTTP method. Choose GET or POST depending on the API requirements.
   4. Set the content type (application/json or application/x-www-form-urlencoded).
   5. Use the Request properties section to define how the request is constructed. You can configure the following as necessary:
      • Body: The request body parameters.
      • Query parameters: The value in the URL after the '?'. Used in filtering, pagination, and search parameters.
      • Header parameters: The value in the HTTP request headers. Used in authentication tokens, custom metadata, and content negotiation.
      • Cookie parameters: The value in the cookie header of the request. Used in session management and setting user preferences.

      For each property type, define the following subfields:

      • Parameter name: Enter the name of the parameter as expected by the API.
      • Parameter value
        Choose one of the following:

        • Map to a connection property.
        • Use a complex expression.
        • Use an intermediate variable from a previous step.
        • Enter a literal value in plain text.
   6. Use the Response mapping section to define how the response is processed.
      • Output parameters
        Define response values to connection properties.

        • Response property: Enter the name of the field in the response.
        • Located in: Select BODY or HEADER depending on where the value is returned.
        • Target variable name: Select a connection property or enter a new variable name.
   7. Click the Configure button.