API Key and Secret
Account API Keys
Getting your API Key and Secret
The API Key and API Secret are used to interact with LoginRadius' APIs. To get your API Key and API Secret, refer to the steps below:
Navigate to the Platform Security > API Credentials > Account API Keys section of the Admin Console.
You can find your API Key and API Secret here. Click on the SHOW button to reveal the API Secret.
Note: It is highly recommended not to share API secrets since API secret has management capabilities and exposing it is deemed a high-security risk for your account.
Resetting your API Secret
To reset your API secret, click on RESET SECRET button to revoke the current secret and generate a new one.
Note: After resetting the API Secret it will take approx 15-20 minutes to reflect the changes.
Additional API Secret(s)
Additional API Secrets are the secrets that can be generated to take the place of the Primary Secret for specific actions based on their permissions.
Therefore, in the case where multiple people need access to the site, you can provide each team member with their own respective secrets. You will then be able to revoke this if required.
Adding Additional API Secret
To add an additional API secret, refer to the steps below:
Click on ADD A NEW API SECRET button under Platform Security > API Credentials > Additional API Secret(s) in your Admin Console.
Fill in the Optional fields, Comment and Secret Name followed by selecting the API(s) from the dropdown to grant access to certain aspects of your site like Analytics, Cloud Directory, Customer Identity, SSO Federation, etc. as shown with an example below.
Note:
- If you do not provide any Secret name, the backend will generate a random value.
- Up to 10 additional API Secrets can be added for your LoginRadius site by selecting the desired APIs from the list. Use these API Secret(s) to securely grant limited access to certain areas of your site.
Revoking Additional API Secret
To revoke any of the created additional API Secrets, refer to the steps below:
Navigate to Platform Security > API Credentials > Additional API Secret(s) in your Admin Console and click on the delete button for the respective API Secret under the ACTION column as shown below.
Click on the PROCEED button to confirm the deletion.