Managing API Keys
- Mojib Javadi
Analytics
An Application Programming Interface (API) Key is a code used to identify and authenticate a user on the Portal. API Key Generation is disabled by default. Platform Admins can enable users to generate an API Key and use it in the Pilot Command Line Interface to carry out automated or scripted data operations without the need to manually enter a username and password. Generated API keys are valid for one year and can be revoked or regenerated at any time.
API Keys should be treated with the same level of security as passwords.
Enabling API Key Generation
Login and navigate to the Platform Management page by clicking the link in the main menu of the Portal.
Search the User Management, Platform Users list to find the target user card and under the Action column click the dots and then Profile.
Under their User Profile, find the API Key Generation toggle and click it to enable.
The toggle will turn green and the user will now be able to generate an API Key from their Profile.
Disabling API Key Generation
Login and navigate to the Platform Management page by clicking the link in the main menu of the Portal.
Search the User Management, Platform Users list to find the target user card and under the Action column click the dots and then Profile.
Under their User Profile, find the API Key Generation toggle and click it to disable.
The toggle will turn grey and the user’s API Key will be immediately disabled and they will not be able to generate another.
Note: API Keys are automatically disabled when users are Disabled from the platform.