A tutorial for generating a new SDK token using the Dev Tools Admin.
An SDK key is a unique identifier that allows your custom component(s) to be validated and used within our SDK. When you create an SDK token through Dev Tools, it becomes associated with your account and any custom components that you want to make available to your Community Aurora instance.
When someone tries to use your custom component within our SDK, the SDK will check the associated SDK token to ensure that it has been validated and approved. If the token is valid, the component will be allowed to run within the SDK. If the token is not valid, the component will not be allowed to run.
Generate or Revoke the SDK Key
The SDK Key section provides you with a method to generate and manage the SDK key for your community.
If there is no existing SDK key, you can generate a new key by clicking Generate SDK Key.
Note: The SDK key is unique to the user that generates it. Each user sees their own key on this page. Revoking the user's permissions also disables any SDK or API keys they have generated.
SDK keys can only be generated on non-production sites.
After you generate a key, it is displayed instead of the button. Both the key and its expiration date are displayed here. After the expiration date has passed, the key is no longer accepted, and you must generate a new key.
Revoking an SDK key is done by clicking Revoke next to the expiration date.
A confirmation modal opens, enabling you to either confirm the revocation of the key by clicking Revoke or cancel the process. Revoking an active SDK key immediately prevents any further actions on the SDK through any existing plugins until they are updated with a new, active key.
Revoking and Regenerating your SDK Key
It is important to keep your SDK token secure and not share it with others, as it grants access to your custom component within our SDK. If you suspect that your SDK token has been compromised, you should revoke it immediately and generate a new one using Dev Tools.
ATLAS
Comments