To access Liminal Express APIs, you need to provide your API key and secret for authentication. As an owner or admin of your organisation, take the following steps to generate your orgnaization's unique client ID and secret.
- Log into Vaults.
- Go to Dev. Scroll down to the API Key section.
- Select Generate Key. Then fill in the following fields:
- Name: Enter the name of the API key.
- Expiry Date: Select the expiry date of the API key. You can select the last day until when this API key is valid.
Note:
- Liminal sends timely notifications as the expiry date approaches, at intervals of 1 month, 15 days, 7 days, and 1 day before expiration.
- Before expiry, you can rotate the API key in Vaults. Liminal generates and displays the new secret ID in a pop-up. You can set a new expiry date and configure IP address for the newly rotated key.
- Once the expiry date passes, the key is removed from Auth0 but remains visible to you in Vaults with the "expired" status. Once expired, you can create a new API key.
- Notification: Enter a unique email address where you want to receive transaction alerts. Ensure that this email address is different from your login credentials and not used by any other user with a role assigned in Vaults. After this, select Generate Now to generate the keys.
- Download your generated client ID and secret as these values will be inaccessible if lost. Select Download client ID and secret to download the CSV file.
- Whitelist IP addresses. You can specify IP addresses to only allow the API key access to individuals with those addresses for enhanced security. Select the three dots icon under of an API key.
- Select IP Whitelist.
- Enter IP Address and Subnet Mask in the fields and then select Add. Perform the same action to add more.
