Assigning roles and groups to API tokens - User Guide - BlueCat Horizon

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

API tokens can be assigned to roles and groups, and have be granted granular permissions to access and manage various object types, in the same way as users.

Assigning API tokens to roles

Assign API tokens to roles to manage what permissions they have to access various objects on the platform. Roles comprise various permissions, either allowing or denying access to view information or perform actions. For more information about roles, refer to Roles.

To assign an API token to a role:

  1. Navigate to User management > API tokens and locate the API token you want to assign to roles in the list.
  2. Select the ellipses in the row and then select View details.
  3. On the API token details page, select the Roles tab.
  4. Select Add.
  5. In the dialog, start entering the name of a role to which you want to assign to the API token. A list of roles will populate the dropdown. Select the role(s) you want to assign.
  6. When you've selected all the roles you want to add, select Add.

The role(s) you added will be displayed on the token's Roles tab. If at some point you need to change the role(s) assigned to the token, you can add or remove roles from this tab.

Assigning API tokens to groups

Assign API tokens to groups, which let you designate common access permissions to all members of a group. This makes it easier to simultaneously manage multiple API tokens and/or users who should share the same access permissions. For more information about groups, refer to Groups.

To assign API tokens to groups:

  1. Navigate to User management > API tokens and locate the API token you want to assign to groups in the list.
  2. Select the ellipses in the row and then select View groups.
  3. On the Groups tab of the View API token details page, select Add.
  4. In the dialog, start entering the name of a group to which you want to assign to the API token. A list of groups will populate the dropdown. Select the group(s) you want to assign.
  5. Select Add.

The group(s) you added the API token to will be displayed on the Groups tab. If at some point you need to change the token's group membership, you can add or remove groups from this tab.