Group Settings for user groups - Platform - BlueCat Gateway - 22.4.1

Gateway Administration Guide
Locale
English
Product name
BlueCat Gateway
Version
22.4.1

You can use the Group Settings workflow page to configure settings that apply to all members of a specific user group. You can:

  • Set a default landing page for specific user groups when they log in to BlueCat Gateway.
  • Show or hide the BlueCat Address Manager (BAM) IP address from members of a group.
  • Make the BlueCat Gateway Help and Documentation available or unavailable for specific user groups.

A User group is a group defined by a BlueCatGateway UDF value within BlueCat Address Manager (such as all).

  • All non-admin users must be defined in the Group Settings workflow by a BlueCatGateway UDF value.
  • Administrative users can be defined in the Group Settings workflow either by a BlueCatGateway UDF value or by a BlueCat Gateway user group created in BlueCat Address Manager. This user group must be granted permissions in BlueCat Gateway.

If a user doesn't have permissions to any workflow and is not assigned a default landing page, then the user will receive a 403 error (Forbidden) upon login to BlueCat Gateway.

Tip: The landing_page setting can be used to redirect to external resources as well. It is not limited to workflow pages of an active BlueCat Gateway instance.

Assigning a group setting to a user group

To assign a specific group setting to a user group:

  1. Log in to BlueCat Gateway as an administrative user.

  2. Under Available Actions > Administration, click Group Settings.

  3. In the Group/UDF field, enter a BlueCatGateway UDF value, and then click Add Group.

  4. From the Groups list, select a BlueCatGateway UDF value or the name of a user group.

  5. Under Available Settings select the setting you want to assign and click click Add Option.

    For example, to assign a landing page to a user group, select the landing_page setting.

  6. In the Group Settings list, select the setting you want to configure (such as landing_page). Then, in the text value field under the Group Settings list, enter the value of that setting for the user group.

    For a list of available settings and what value to enter for each, see Available group settings below.

  7. Click Update.

Gateway updates the setting for the BlueCatGateway UDF.

Available group settings

You can assign the following Group Settings to user groups.

Setting Description and value
landing_page

Specifies a default landing page for the a user group when they log in to BlueCat Gateway.

Set the value of landing_page to the workflow endpoint in the text field. For example, to set the landing page to the Workflow permissions page, enter /admin/workflow_permissions.

Tip: The landing_page setting can also be used to redirect users to external resources as well. It is not limited to workflow pages of an active BlueCat Gateway instance.
show_bam Specifies whether the BlueCat Address Manager (BAM) address/alias is available to the user group.

Set the value of show_bam to true to show the BAM IP to the user group.

Set the value of show_bam to false to hide the BAM IP from the user group.
show_help Specifies whether Help & Documentation should be available to specific user groups. Since BlueCat Gateway is aimed at developers and administrators, you might want to hide the BlueCat Gateway API and operations documentation in order to avoid misconfiguration.there by specific users or user groups.

Set the value of show_help to true to reveal the Help & Documentation link in Gateway to the the user group.

Set the value of show_help to false to hide the Help & Documentation link in Gateway from the user group.