As a Media Portal administrator, you can create and manage CDN API security keys for your organization. You create a key for a specific access group and role. From there, Media Portal generates a key ID and a secret which you use to make API requests.
After signing into Media Portal, if you navigate to Portal Admin > CDN API Security Keys, you can view a list of API security keys for your organization. On this page you can view details for an API key by clicking on one. It will show you information for that key, such as the name, applicable access group, the role for the key, who created the key (and when), and the status for the key. You can also edit the key, disable it, or delete it.
On this page, you can create a new API security key by selecting an access group for which you wish to create the key and click “Add a New Key”. Read through the terms and conditions and if you accept them, you’ll be taken to the key creation menu, where you can set a name for the key and define its authorization by assigning a role for it. The key will only have the permissions of the role assigned to it. Select a contact for the key from your organization and you may also add any additional information for your reference before you create the key by clicking “Save”. Please note that you can only have five API keys per access group. If you wish to update an API key, simply click on the API key you wish to edit, then click on “Edit Key” and you will be shown the ”edit key menu” (This menu will be referred to again later in this page) where you can update the aforementioned fields for it.
To help ensure security, Media Portal deactivates keys after 120 days of inactivity and disables keys after 180 days of inactivity. Media Portal sends a warning message to the users associated with a key 30 days before deactivating or disabling the key. To keep a key active, you must include the key in an API request or edit it in Media Portal. If a key is deactivated or disabled, you can enable it again in the “edit key menu”, where you can enable a disabled key or vice versa. If you wish to delete the API key, you can click on “Delete Key” and it’ll be deleted.
If for some reason you wish to regenerate the secret text string for an API security key, (e.g., if the old secret has been compromised), you can create a new secret for the API key by opening the “edit key menu” and clicking on the “Generate New Secret” button. Media Portal invalidates the old secret and creates the new secret text string. To view the new text string, click “show”.
Learn more about
Top 10 articles