Managing Product Keys

Topic Progress:

Every product in XMPro Subscription Manager needs to have at least one key. When installing a new product, a key needs to be specified. The way the key is specified for the product you are installing might differ from product to product, for example, XMPro IoT requires you to download an installation profile from XMPro Subscription Manager. The installer then gives you the choice between letting it create a product in XMPro Subscription Manager for you or not. If you choose not to let the installer create a product in XMPro Subscription Manager for you, you will need to manually create the product and its key and then make sure the key in the application’s appsettings.json file corresponds with what is stored in XMPro Subscription Manager.

In this section of the guide, we will be looking at how to manage keys within XMPro Subscription Manager; thus, not using the installer of an application to manage the keys for you.

For the purpose of this guide, please make sure that you have at least one product created in XMPro Subscription Manager (other than “XMPro”). Please follow the steps below:

  1. Open the Products page from the left-hand menu.
  2. Select a product from the list.
  3. Click on the Product Keys button.
  4. If you let an installer, such as the XMPro IoT installer, create a product in XMPro Subscription Manager for you, a key will be listed here. If you have created a product yourself the list will be empty and you need to manually create keys for the product.

To generate a new key, please follow the steps below:

  1. Click on the Generate Keys button on the Product Keys page.
  2. Enter a description for the key, for example, “Shared Key“.
  3. Click on “Submit“.
  4. The new key will be saved immediately and be listed on the Product Keys page.

If you would like to revoke or delete a key, please follow the steps below.

  1. Select the keys you want to delete from the list on the Product Keys page.
  2. Click on “Revoke Keys“.
  3. Confirm that you would like to remove the selected keys.
  4. After confirming that the keys should be deleted, they will be removed immediately and the list on the Product Keys page will be updated.

If you would like to copy a key, follow the steps below.

  1. Select one key from the list on the Product Keys page.
  2. Click on the Copy Key button.
  3. Click on Copy to copy the key to your clipboard.
Comments are closed.

This is the legacy version of the XMPro Documentation site. For the latest XMPro documentation, please visit documentation.xmpro.com

X