Deployment Keys
Deploy mods without requiring an end-user account
Deployment Key Use Cases
Deployment Keys are shared keys that can be used to deploy mods without requiring end-user accounts. They can be used in enterprise use cases that don't require access to privileged resources:
Embedding an authenticated iframe via the PixieBrix sidebar
Retrieving information from public APIs
Compliance/governance use cases
Creating a Deployment Key
In the Admin Console, click on Deployment Keys
in the left side nav.
If you do not see "Deployment Keys" in the Admin Console left side nav, contact your Account Executive or [email protected]
Click + Create Deployment Key
and name your key. The key will appear in the Deployment Keys table:
Adding the Deployment Key to a Deployment
Deployment Keys can be added to permissions groups. See Deploying Mods for information on adding the key to a Group and Deployment
Testing the Deployment Key in the Browser Extension
To test the deployment key in the browser extension, open the Extension Console and change the URL to include #/settings
to force the Extension Console to show the settings page. Or, paste one of the following URLs into your URL bar:
Chrome Web Store (Stable)
Chrome Web Store (Beta)
Scroll the Advanced Settings at the bottom of the Settings screen.
Click Clear PixieBrix Token
to disconnect/logout:
Then, paste the Deployment Key:
Reload the browser extension for the new settings to take effect
Configuring Deployment Key in the Extension Configuration Policy
To use the deployment key automatically at scale, include the deploymentKey
setting in your PixieBrix Extension Configuration Policy. For more information on configuring the policy, see Browser Extension Configuration Policy
Name | Type | Data |
---|---|---|
deploymentKey | REG_SZ | The deployment key you created |
Frequently Asked Questions (FAQs)
Are deployment keys secure?
As a shared secret, deployment keys are best reserved for use cases that don't have access to privileged resources.
Last updated