Skip to content

Using an Authentication object in an API call

An Authentication object allows you to securely store authentication details for supported providers and reuse them across multiple API calls.

This means credentials can be managed in one place rather than being entered separately into each API call configuration.

For more information, see What is an Authentication object and how do I configure it?.

Set up the API call

To use an Authentication object in an API call:

  1. Right-click the API call actor and select Configure.

  2. Choose the required Type, Method, and Data Type.

  3. In the Authentication menu, select Auth Object.

API call configuration showing Auth Object selected in the Authentication menu

  1. A new field called Auth Object is displayed.

  2. Select the required Authentication object from the list.

API call configuration showing the Auth Object selection field

  1. Complete the remaining API configuration.

  2. Test the API call so that it becomes active.

  3. Save the API call configuration.

Things to remember

  1. An Authentication object can be reused in multiple API calls.
  2. Updating an Authentication object updates the credentials used by all API calls that reference it.
  3. The maximum number of Authentication objects allowed in your system is 100.