Adding a new authentication method
Last updated
Last updated
The connector builder . Before a connector can be used (i.e. before for use in ) you must add at least one authentication method for your connector.
The required will vary depending on which authentication type you choose to configure, but the general process is straightforward.
General steps are provided below, with links to detailed guidance for each of our .
Step 1 Click the add new authentication method button:
Step 2 You're prompted to enter some basic details for this authentication method:
Complete these details using the table below as a guide:
Enter a name
Enter the name to be displayed for this connector throughout Patchworks.
Select authentication type
Use the dropdown list to select the required authentication type. The selection made here determines subsequent settings and default options.
Step 3 Click the create button to confirm your updates. Basic details are saved and additional setup options are displayed over a series of 'metro stop' tabs - for example:
For any authentication method, the following configuration options are available:
Step 4 Step through each tab and as appropriate for your chosen authentication method.
Define authentication variables for any values that you need users to provide when they choose to of this connector (for use in ). Here, you define how fields for these variables are displayed to your users (so they can provide required values), and then how these details are passed in API requests for authentication.
For more information about working with authentication variables generally, please see the page. For guidance on configuring specific authentication types, please see our section.
These are 'shared' variables that can be used when defining authentication methods and endpoints for your connector. So, if you have a variable that might be used in multiple , or multiple , or both - define them here for quick access later.
For more information about working with connector variables generally, please see the page. For guidance on configuring specific authentication types, please see our section.
For more information about working with URL parameters generally, please see the page. For guidance on configuring specific authentication types, please see our section.
For more information about working with header variables generally, please see the page. For guidance on configuring specific authentication types, please see our section.
For more information about working with body options generally, please see the page. For guidance on configuring specific authentication types, please see our section.
For more information please see the page.
For more information please see the page.