Searching...

Matching results

    How to manage personal API access key?

    As an AirVantage user, you can create a personal API access key to authenticate and interact with the AirVantage API programmatically. This personal access key is tied to your user profile, is only visible to you, and each user can have only one personal API access key.

    For API clients that are visible to all users in the company, see API Clients .

    This guide explains how to create a personal API access key, regenerate the secret key when needed, and delete the access key when it’s no longer required.

    Accessing the Personal API Access Key Section

    All personal API access key operations are managed from your User Profile. To access this section:

    1. Click the Menu icon Menu Icon in the top right corner of the AirVantage interface.

    2. Select My Profile from the righthand side menu.

    3. You will see the Personal API access key section at the bottom of the page.


    1 / Create

    2 / Regenerate Secret

    3 / Delete

    How to create a personal API access key

    A Personal API access key is created from your User Profile and is only visible to you. By default, the personal API access key inherits the user profile of the user who creates it and uses the Client Credentials OAuth flow .

    Creating a new personal API access key

    1. Navigate to your User Profile by following the steps outlined in the Accessing Personal API Section . Initially, you will see a message indicating that you don’t have a personal API access key.

    2. Click Create to generate a new Personal API access key. Once created, your personal API access key will be displayed with your Client ID and Secret key.

    How to regenerate the secret key

    If your secret key has been compromised or you need to rotate credentials for security purposes, you can regenerate the secret key. This will invalidate the old key and generate a new one.

    After regenerating the secret key, any applications using the old key will no longer be able to authenticate. Make sure to update your applications with the new key.

    Regenerating the secret key

    1. Navigate to your User Profile by following the steps outlined in the Accessing Personal API Section .

    2. In the Personal API access key section, click the Regenerate icon Regenerate Icon next to the Secret key. A prompt will be displayed to confirm whether you want to regenerate the secret key.

    3. Click Regenerate to generate a new secret key.

    How to delete a personal API access key

    When you no longer need your personal API access key, you can permanently delete it. This action will immediately revoke access for any applications using this client’s credentials.

    Deleting a personal API access key will immediately revoke access for any applications using this client’s credentials. This action is immediate and cannot be undone.

    Deleting a personal API access key

    1. Navigate to your User Profile by following the steps outlined in the Accessing Personal API Section .

    2. In the Personal API access key section, click Delete. A prompt will be displayed to confirm whether you want to delete the personal API access key.

    3. Click Confirm to permanently remove the personal API access key.

    TOP