License Keys¶
License keys grant your organization access to Capawesome Insiders SDKs. Each key is bound to one or more SDK packages and authenticates your installs against our private npm registry.
How License Keys Work¶
A license key is scoped to an organization and references one or more Insiders SDK packages. When your developers or CI pipelines install one of those packages, the key authenticates the request against our private npm registry and the install is granted.
Only Owners and Admins can create, edit, rotate or delete license keys. See Roles and Permissions for details.
Adding a new SDK to a license key (whether on creation or by editing an existing key) locks the key for 28 days. While locked, the SDKs attached to the key cannot be changed and the key cannot be deleted. The name can still be edited, and the key can still be rotated, copied, and used to install packages. The lock prevents adding SDKs only to swap them out shortly after to gain access to more packages than your plan includes.
Creating License Keys¶
To create a license key in your organization:
- Go to the License Keys page in the Capawesome Cloud Console.
- Click on the Create License Key button.
- Enter a name for the license key.
- Select the Insiders SDKs the license key should grant access to.
- Read and accept the End User License Agreement (EULA).
- Click Create. The new key is automatically copied to your clipboard.
Lock Period
Creating a license key with one or more SDKs locks it for 28 days. While locked, the attached SDKs cannot be changed and the key cannot be deleted. The name can still be edited, and the key can still be rotated and copied.
Editing License Keys¶
To change the name or selected Insiders SDKs of a license key:
- Go to the License Keys page in the Capawesome Cloud Console.
- Click on Edit in the "Actions" menu of the desired license key.
- Update the name or the selected Insiders SDKs.
- Click Save. Adding a new SDK starts a 28-day lock period; renaming alone does not.
Rotating License Keys¶
Rotating a license key generates a new key value and immediately revokes the previous one. The lock period is not reset by a rotation.
- Go to the License Keys page in the Capawesome Cloud Console.
- Click on Rotate in the "Actions" menu of the desired license key.
- Confirm. The new key is automatically copied to your clipboard.
Rotation is Irreversible
The previous key value is revoked immediately and cannot be recovered. Update any installs and CI pipelines that depend on the key.
Deleting License Keys¶
To delete a license key:
- Go to the License Keys page in the Capawesome Cloud Console.
- Click on Delete in the "Actions" menu of the desired license key.
- Confirm.
Applications using the deleted key will lose access to the Insiders SDKs immediately. License keys cannot be deleted while they are locked.