Viewing API tokens - User Guide - BlueCat Horizon

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

The API tokens page provides a list of all the API tokens you have created on the platform. For each API token, the list displays the following information:

  • Name of the API token
  • Description of the API token
  • Status of the API token, such as Enabled, Disabled, or Expired
  • Last used date
  • Expires date, if applicable

The API tokens page displays a list of all created API tokens.

You can filter the list to view specific API tokens. Available filters include the following:

  • Status
  • Last used date
  • Expires date

Viewing API token details

To view more information about an API token, including its assigned roles and groups:

  1. Locate the API token in the list.
  2. Select the ellipses in the row.
  3. In the menu, select View details.

The API token details page will open, displaying the following information about the selected API token:

  • Description
  • Validity period — If the Never expire option was selected during API token creation, this field will be populated with (not set).
  • Status
  • Last used date
  • Rotated date
  • Expires date
  • Allowed networks
  • Client ID
  • ID
  • Created date and timestamp
  • Updated date and timestamp

The API token's assigned roles and groups are listed on the Roles and Groups tabs respectively. A user with the appropriate permissions can add roles and groups for the API token.

To view the API token's effective permissions, open the Effective access tab. A list of the token's permissions is displayed.