Adding authentication types and connection properties

To meet your application's security requirements, configure one or more authentication types for the connector. Select the appropriate protocol and specify the connection properties. These properties are the credential fields (such as a username and password, or a Client ID) that users must provide to establish a valid connection.

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. Enable the required authentication type by using the Enable authorization toggle switch in the authentication method.
4. Configure the connection properties based on the authentication method that you choose. Update the connection property (for example, username, password, token, or API key) information as necessary using the Edit connection property icon.

   For each connection property, you can configure the following details:

   • Display name: The label shown in the UI.
   • Description: A short explanation of the property's purpose.
   • Type: Choose from supported types such as string, boolean, or enum.
     • String: A sequence of characters (text).
     • Boolean: A true or false value.
     • Enum: A predefined list of allowed values.
   • Default value: Provide a default input if applicable.
   • Location: Specify where the property should be sent in the request (header, query, or cookie).
     • Query: The value in the URL after the '?'. Used in filtering, pagination, and search parameters.
     • Header: The value in the HTTP request headers. Used in authentication tokens, custom metadata, and content negotiation.
     • Cookie: The value in the cookie header of the request. Used in session management and setting user preferences.
   Set the property to Hidden, Required, or Secret based on your requirement.

   • Hidden: Hides the property from the connection UI. Use this for internal values that should not be displayed to users.
   • Required: Marks the property as mandatory. Users must provide a value to create a connection.
   • Secret: Masks the property value in the UI and stores it securely. Use this for sensitive data such as passwords or tokens.
5. If necessary, use the Add connection property + button to add a new connection property to the chosen authentication method.
   Note: For authentication types such as Basic, Bearer token, and API key, you can define extra connection properties beyond the predefined ones. These custom properties must be manually configured and can be marked as required, hidden, or secret, depending on your use case.
6. If necessary, enable proxy by using the toggle switch. Enabling proxy introduces the following properties:
   • Proxy destination host: The hostname for the proxy. This should be specified in the form http://<hostname>.
   • Proxy destination password: The password for authenticating proxy calls.
   • Proxy destination port: The port on which the proxy is hosted. It defaults to 8080 for the HTTP proxy.
   • Proxy destination username: The username for authenticating proxy calls.
7. If necessary, for Basic, Bearer token, and API key authentication methods, configure custom authentication and authentication renewal (refresh) steps. For more information, see Adding custom authentication steps and Adding authentication renewal steps.
8. Test the connection properties that you added to make sure that they work as expected. For more information, see Validating connections.