Auth Override and Auth Override JSON

Overview

The Auth Override and Auth Override JSON blocks enable you to override authentication credentials when you authenticate to services during workflows. Both blocks return variables that contain the overridden credentials. Use these variables in other blocks when you want to authenticate to services with the overridden credentials.

When you create authentications, you can indicate that certain authentication credentials are overridable. In your workflows, you can then add the Auth Override or Auth Override JSON blocks and provide values for these overridable credentials.

Procedure

  1. In your workflow, drag and drop an Auth Override or Auth Override JSON block onto a location above the other blocks that will use the overridden authentication credentials.
  2. In the Auth Override or Auth Override JSON block, in the authKey field, choose the authentication that you want to provide the overridable credentials for.
  3. Provide values for the credentials that you want to override.
    • For the Auth Override block, the overridable credentials are shown. Provide a value for each credential that you want to be overridden.
      Note: Overridable passwords are hidden by default. To see a password, click on the eye icon. If you want to configure the password to contain the result of another block, switch the password's type to expression.
    • For the Auth Override JSON block, in the override field, provide the overridable credentials in a JSON array of key-value pairs, for example:
      {
         "host": "myhost.mydomain.com",
         "username": "my_user",
         "password": $password
      }
  4. Optional: In another block that uses the same authentication as the Auth Override or Auth Override JSON block, set the value of the authKey field to $Name.result, where Name is the name of the Auth Override or Auth Override JSON block.

    For example, you might add a block called listApiKeys to your workflow. You might then add an Auth Override block called AuthOverride_1 that uses the same authentication key that listApiKeys does, and specify the overridable credentials. To use these credentials in the authentication that is performed by the listApiKeys block, set the value of its authKey field to $AuthOverride_1.result.

  5. Run the workflow and verify that the overridden credentials that you provided are used during the authentication.

To disable the Auth Override and Auth Override JSON blocks without deleting them, turn off the switches next to their names.