Creating a BlueCat Gateway user in Address Manager - Adaptive Applications - BlueCat Gateway - 23.1

BlueCat Cisco ACI Adaptive Plugin Guide

Locale
English
Product name
BlueCat Gateway
Version
23.1

BlueCat Gateway features and workflows require the use of an administrative user in Address Manager named BlueCatGateway. This user provides access to the Address Manager API and GUI. You must assign this user either the all or admin BlueCatGateway UDF value in order to let the user view workflows on the BlueCat Gateway UI.

By default, the BlueCatGateway UDF all value gives users access to all Gateway workflows. The admin value permits access only to a small subset of workflows.

Note: Before setting up the BlueCatGateway user, you must have created the BlueCatGateway UDF with the "Named User" Object Type in Address Manager. For more details, see Creating the BlueCatGateway UDF.

To create a BlueCat Gateway user:

  1. Log in to Address Manager as an administrator.

  2. Select the Administration tab.

  3. Under User Management, click Users and Groups then click New.

  4. Under User, enter BlueCatGateway.

  5. Under Authentication, type and confirm the user’s Address Manager password in the Password and Confirm Password fields.

  6. If you have defined authenticators, an Other check box and a drop-down menu open. To select an external authenticator, click Other and select an authenticator from the menu.

    Note: If an external authenticator is used, the name in the Username field must match the user name on the remote authentication system.
  7. Under Extra Information, set the following:

    • E-mail Address: The user’s email address (required).

    • Phone Number: The user’s phone number.

  8. Under User Access, define the user type, security and history privileges, and access type:

    • Type of User: Select Administrator or Non-Administrator.

      Tip: To let administrator users quickly grant permissions to BlueCat Gateway workflows and operations, you can add Administrator users to BlueCat Gateway User Groups.
      Note: The Security Privilege and History Privilege fields are unavailable if the user type is Administrator.
    • Access Type: Select GUI and API.

    • X.509 Required Leave blank.

  9. Under Additional information, type all in the BlueCatGateway UDF field.

    Note: By default, BlueCat Gateway permissions include all and admin BlueCatGateway UDF values. You must enter the BlueCatGateway UDF value when granting workflow or REST endpoint permissions to Gateway users via the BlueCat Gateway user interface, or by modifying the permissions.json file in the <bluecat_gateway> directory.
  10. Under Change Control, add comments to describe the changes. In most cases comments are optional, but some organzizations require it as a best practice.

  11. Click Add to create the user and return to the Users and Groups page, or click Add Next to add another user.

The newly-created BlueCat Gateway administrator can now log in to the BlueCat Gateway UI and has immediate access to the default workflows.