Container Portal User Guide

13 October 2021

How to generate an API key for use with dmrc.io, including how to set distinct permissions per key, and how to use the key to view images in dmrc.io

The Container Portal comprises 2 primary functions: Generating and Managing API Keys, and using those API Keys to access a docker registry. Additionally, the docker registry features a UI which allows a user to browse the available images, as well as connect a docker client.

API Key Management

1. Access the Container Portal in a browser: at https://dmrc.io
2. Login with Digimarc Shield credentials (see your customer service representative if you need assistance)
   
    
3. You will be able to create API Keys for an(y) account(s) you are configured for. Select the account desired, if more than one is available.
   
4. An account may have one or more product subscriptions. These will be displayed, with details about the product and the valid dates.
   
5. API Keys already created can be reviewed and managed.
   
6. Click Create to bring up the new API Key box.
7. The description is required. In cases where multiple products can be assigned, the description can help organize different keys, with different access, for different teams, users, or processes.
   
8. Once you create the key, it is available for you to copy here, and here only. Once the form is closed, the key cannot be recovered (though generating a new replacement is easy).
   
9. A snippet of the API key is shown to correlate details against your saved keys.
10. You can view which products are enabled for each API key.
    
11. Selecting 'Edit' will allow you to modify which products the API key can provide access to.
12. If you have access to more than one product, you can add or remove product access to a given key.
    
13. A key can be deleted as well. This will cause the key to be invalidated, and any current users will need a replacement key, or will no longer have access.

Docker Registry Browser

1. Access the docker browser at https://dmrc.io/browse
2. Enter an API key to access
   
3. The API key used controls which container images you will have access to.
   
4. View connection/access at the 'Connected To' link in the bottom left, if desired.
   
5. From here you can return to the Container Portal API Key Management UI, or Log Out of the registry browser