Creating the BlueCatGateway user in Address Manager - Platform - BlueCat Gateway - 25.2

Gateway Installation Guide

ft:locale
en-US
Product name
BlueCat Gateway
Version
25.2

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.
Important: The Address Manager UI changed significantly in Address Manager v25.1 (the version immediately following Address Manager v9.6). the procedure for setting up the BlueCatGateway user depends on the version of Address Manager (Integrity or Integrity X) that you're using.
Tip: As of Address Manager 25.1, the versioning scheme for Address Manager changed to reflect the year and sequential major versions within that year. The last major version before Address Manager 25.1 is Address Manager 9.6.

Address Manager v25.1 or earlier

To create the BlueCat Gateway user in Address Manager v25.1 or later:

  1. Log in to Address Manager as an administrator.

  2. Click the Settings tab on the sidebar, then expand User management and click Users and groups.

  3. Click the New button.

  4. In the Create user window, click the General tab (if it's not already selected) and enter the following:

    • Name: Enter BlueCatGateway.

    • E-mail Address: An email address to use for the BlueCatGateway user. This is required, so make sure it is an email address available to an appropriate role or administrator.

    • Phone Number: (Optional) A phone number to use for the BlueCatGateway user.

  5. Click the Authentication tab and enter the following:

    • Authenticator: If you are using an external authenticator (that is, you're not using Address Manager's built-in authentication), select the authenticator from the menu.

      Note: If an external authenticator is used, the user name in the Name field must match the user name on the remote authentication system.

      Otherwise, select BlueCat Address Manager.

    • Password, Re-enter password: Enter the password for the BlueCatGateway user.

    • Leave the X.509 and Reset user password on next login settings cleared.

  6. Click the Access rights tab and enter the following:

    • Assign administrator privilege: Tick this checkbox to create the BlueCatGateway user an Administrator user. Clear this checkbox to create it as a non-Administrator user.

      Tip: To let administrators quickly grant permissions to BlueCat Gateway workflows and operations, you can add Administrator users to BlueCat Gateway User Groups.
    • Security privilege: Select No access.

    • History privilege: Select Hide.

    • Access type: Select UI and API.
    Note: Security privilege and History privilege are unavailable if Assign administrator privilege is selected.
  7. Click the User-defined fields tab. For the BlueCatGateway UDF (that you created earlier), enter all in the input 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.
  8. (Optional) Click the Change control tab and enter a comment to describe your changes. In most cases comments are optional, but some organizations require it as a best practice.
  9. When you're done, click Create to create the user and return and close the window (or click Create and add another 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. For details, see Logging in and out of Gateway.

Address Manager v9.6 or earlier

To create the BlueCat Gateway user in Address Manager v9.6:

  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 organizations 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. For details, see Logging in and out of Gateway.