Tokens

A token is a secure way to access the Qualytics API instead of using a password. Each user gets a unique Personal API Token (PAT) for authentication. These tokens are created only once, so you need to copy and store them safely because you'll use them to log in and interact with the platform in the future.

Let’s get Started 🚀

Navigation to Tokens

Step 1: Log in to your Qualytics account and click the Settings button on the left side panel of the interface.

Step 2: By default, you will be navigated to the Tags section. Click on the Tokens tab.

Generate Token

Generating a token provides a secure method for authenticating and interacting with your platform, ensuring that only authorized users and applications can access your resources. Personal Access Tokens (PATs) are particularly useful for automated tools and scripts, allowing them to perform tasks without needing manual intervention. By using PATs, you can leverage our Qualytics CLI to streamline data management and operations, making your workflows more efficient and secure.

Step 1: Click on the Generate Token button located in the top right corner.

A modal window will appear providing the options for generating the token.

Step 2: Enter the following values:

1. Name: Enter the name for the Token ( e.g., DataAccessToken)
2. Expiration: Set the expiration period for the token (e.g., 30 days)

Step 3: Once you have entered the values, then click on the Generate button.

Step 4: After clicking on the Generate button, your token is successfully generated.

Warning

Make sure to copy your secret key as you won't be able to see it again. Keep your secret keys confidential and avoid sharing them with anyone. Use a password manager or an encrypted vault to store your secret keys.

Revoke Token

You can revoke your token to prevent unauthorized access or actions, especially if the token has been compromised, is no longer needed, or to enhance security by limiting the duration of access.

Step 1: Click the vertical ellipsis (⋮) next to the user token, that you want to revoke, then click on Revoke from the dropdown menu.

Step 2: After clicking the Revoke button, your user token will be successfully revoked. A success message will display saying User token successfully revoked. Following revocation, the token's status color will change from green to orange.

Restore Token

You can restore a token to reactivate its access, allowing authorized use again. This is useful if the token was mistakenly revoked or if access needs to be temporarily re-enabled without generating a new token.

Step 1: Click the vertical ellipsis (⋮) next to the revoked tokens, that you want to restore, then click on the Restore button from the dropdown menu.

Step 2: After clicking on the “Restore” button, your secret token will be restored and a confirmation message will display saying User token successfully restored

Delete Token

You can delete a token to permanently remove its access, ensuring it cannot be used again. This is important for maintaining security when a token is no longer needed, has been compromised, or to clean up unused tokens in your system.

Note

You can only delete revoked tokens, not active tokens. If you want to delete an active token, you must first revoke it before you can delete it.

Step 1: Click the vertical ellipsis (⋮) next to the revoked tokens, that you want to delete, then click on the Delete button from the dropdown menu.

After clicking the delete button, a confirmation modal window Delete Token will appear.

Step 2: Click on the Delete button to delete the token.

After clicking on the Delete button, your token will be deleted and a confirmation message will display saying User token successfully deleted.