Auth Fundamentals

Prev Next

Overview

An Auth is designed to pass values to a third-party system to authenticate the API call and enable the app to be used. Considering that there are basic standards, each Auth type is prebuilt to follow those standards, while still giving you the ability to extend and customize as needed to accommodate any possible use case.

Pre-built Arguments

Each Auth type has a basic set of arguments that are prompted when using the auth in a workflow, based on the industry standards for that Auth type. You can see what they are when looking at the “Test Credentials” tab:

You can see above that it automatically prompts for an API key, which will be passed in the standard format in the headers of any REST API call that uses this Auth.

Another example is Basic Auth, which you can see here:

Custom Arguments

If you need additional arguments beyond the basics, you can configure them here:

Any arguments created here will be prompted to anyone using the app, and will be available in the Test Credential screen so that you can validate that your Auth works.

Auth Actions

In many cases where the Auth does not follow the simple standard, you may need to actually manipulate the action of the Auth itself. In this case, you can configure a custom action connected to your Auth, where you can customize the headers, body, and any detailed adjustments that you need.

It is important to note that you can use the values in the Auth at any point in any action, (whether you create an Authenticate action or not), for example: