Authentication

Learn how to create authentication schemes and credentials.

Overview

Authentication may be required to verify the identity of the client (user) attempting to access a resource on a host.

You first create authentication schemes and authentication credentials and then apply them to data sources that requiring authentication. Xapix supports the following types of Authentication schemes:

  • API Token

  • Bearer Token

  • Basic Authentication

  • Cookie Authentication

  • OAuth2

For a quick overview of creating a new authentication scheme and credentials, take a look at this short video.

Building authentication resources

Creating an authentication scheme

After creating an authentication scheme, you can share this resource within an organization.

To create an authentication scheme, follow these steps.

Steps
Steps
  1. In a project, select Home > Auth. Scheme.

  2. From the New Authentication Scheme dropdown, select a scheme type.

  3. In the Create new Authentication Scheme pane, enter the required information.

  4. Click Create.

  5. A list of authentication schemes will appear showing the new scheme.

  6. Dismiss the confirmation dialog.

Example
Example

In this example, we use API Token.

Select an authentication scheme type
Enter authentication scheme information
New auth. scheme added

Creating authentication credentials

An authentication credential is the information that will be used within an authentication scheme. You can create two types of authentication credentials:

  • Token credential

  • Username/Password credential

After creating token or username/password credentials, you can share this resource within an organization.

Creating a token credential

To create a token credential, follow these steps.

Steps
Steps
  1. In a project, select Home > Auth. Credentials.

  2. Select New Authentication Credentials > Token Credential.

  3. In the Create new Authentication Credential pane, add the following:

    • Name: a descriptive name for the credentials to be used to identify it within your project

    • Token: This should be a secret value, so consider this before entering a string.

  4. Click Create.

  5. A list of authentication credentials will appear showing the new credential.

  6. Dismiss the confirmation dialog.

Example
Example
Select Token Credential
Enter token information and click Create

Creating a username/password credential

To create a username/password credential, follow these steps.

Steps
Steps
  1. Click Home and from the sidebar click Auth. Credentials.

  2. Select New Authentication Credentials > Username/Password Credential.

  3. In the Create new Authentication Credential pane, add the following:

    • Name: a descriptive name for the credentials to be used to identify it within your project

    • Username and Password: As determined by a user.

  4. Click Create.

  5. A list of authentication credentials will appear showing the new credential.

  6. Dismiss the confirmation dialog.

Example
Example
Select Username/Password Credential
Enter credential information then click Create