Haivision Media Platform
Haivision Media Platform
Breadcrumbs

Generating an API Key and Secret for IDP Users

If HMP is connected to a third-party identity provider (IDP), your connected users can use HMP's REST API by authenticating using an API key and secret. The user utilizes this key and secret pair to create a token to authenticate future API requests. See (4.1) Initiate IDP User Session in the REST API Integrator's Guide for details.

To create an API key and secret for a user:

  1. Click the  hamburger.png icon and select Administration from the navigation drop-down menu.

  2. Click Access Controls on the toolbar and then click Users on the sidebar.
    The Users list opens, displaying the list of defined users for your platform.

  3. Click the user for whom you want to generate an API key and secret.

  4. Click the Generate button next to API Key.

    API_Key.png

  5. Click the Save Settings button.

  6. Supply the key and secret pair to the user. Ensure the user stores the secret, as it cannot be viewed again after leaving this screen.

Note

  • If the API secret is lost, regenerate a new API key/secret pair by clicking the Generate button and provide the pair to the user.

  • If you need to disable API access to the user, click the Disable button next to the API Key.