Creating API tokens - User Guide - BlueCat Horizon

BlueCat Horizon User Guide
ft:locale
en-US
Product name
BlueCat Horizon

Create new API tokens to act as machine credentials on the BlueCat Horizon platform.

Note: An API token's secret value can only be retrieved at the time of creation.

To create an API token:

  1. On the API tokens page, select New.
  2. In the dialog, enter the following information:
    • Name: A unique name for the API token
    • Description: A description of the API token and its function
    • Allowed networks: List the CIDR boundaries or IP addresses that are allowed to use the API token.
    • Validity: Select one of the following options to define for how long the API token is valid:
      • Never expire
      • Set validity period: If you select this option, enter the number of days for which the token is valid in the provided field.
  3. Select Create.
  4. The dialog displays a confirmation that API token has been created and displays the Client ID and Client secret. Use the Copy buttons to copy them. You will need these values to obtain a JSON Web Token for authentication.
    Note: This is the only time the Client secret can be copied. You cannot recover it later.

    Select Download .JSON file to download a JSON file of your API tokens.

  5. Select Close.

The API token will be added to the list on the API tokens page.