Authentication is used to verify the identity of the client/user attempting to access a resource on a host. More often than not, setting up a connector to one of your internal or third-party services will require some form of authentication, the method of which can vary depending on the service in question.
Xapix supports many types of authentication methods, as listed and detailed here.
To help you get started on this topic, what follows is the typical user-flow of setting up authentication in Xapix.
1.Onboard a REST API Connector that requires authentication:
Choose one of the options shown on the Connectors > REST Connector page, such as onboarding the REST API Connector via a OpenAPI/Swagger File:
And enter the required parameters and sample values for your connector on the Edit Connector Page
2.Configure your Authentication Scheme:
Now, to start configuring your connector authentication, scroll down and click on the Enable Authentication to display more options
Click on Add Authentication to display the Authentication Methods that are available to choose from
Choose the relevant authentication scheme for your connector and name it. In this example we have chosen the Basic Authentication Scheme:
3.Configure Your Authentication Credential
Based on your choice of Authentication Scheme, you will now be shown the relevant options for setting up an Authentication Credential. For the Basic Authentication Scheme, that will be a username/password credential:
Click on the Choose a credential drop down and then on New Credential:
Enter the required details for your authentication credential and click save:
You should now see the combined Authentication Scheme and Credential, with options to Edit, Delete, Replace either:
4.Test Your Connector
You can now test whether the connector has been configured correctly by clicking on Fetch Preview and checking whether the expected response is shown in the connector preview.
Complete the connector setup by clicking on Save Connector after fetching the preview.
5.Add Your Connector to a Pipeline:
In the pipeline Add Unit overlay, click on your connector. You will now be shown which Authentication Method and Credential is associated with the connector, and be given the chance to replace the Credential if necessary:
Once added, the Secure Store will appear as an additional unit on the pipeline, auto-mapping the relevant credential to the connector unit: