Tags

Prev Next

Tags are free-text labels you can apply to objects throughout AppGate ZTNA. Most forms in the admin UI include a Tags field, typically at the top of the page. Use tags to find objects and establish relationships between different objects in the system. Tags are most useful when you need to set up many-to-one relationships. For example, if you tag several objects with mytag, you only need to add mytag to an admin role to allow an admin to manage all those objects.


Using tags

In search

Most pages offer search with tag-based filtering. Entering a tag name returns only objects with that tag.

Search interface with fields for keywords, name, health, and tags for filtering results.

Tag objects when you create them to make filtering and retrieval easier later. This becomes especially important as your deployment grows and the number of objects exceeds what a single page can display.

When adding entitlements to policies

When a policy contains several entitlements, tags provide an efficient way to configure the relationship.

As you create the entitlements, make sure to add a tag to each, for example, Sales.

As you create entitlements, add a tag to each one—for example, Sales. When you define the policy's assignment criteria, select Entitlements by Tag instead of selecting each entitlement individually using Entitlements by Name. Enter the Sales tag to link all entitlements tagged with Sales to the policy.

You do not need to enter anything in the Tags field at the bottom of the Policies screen for this use case.

When assigning users to policies

You can use tags to link many users to a single policy. This applies only to users in the Local Database identity provider type.

In Local Users, add a tag to each user—for example, admin. When you configure a policy, select User claims > Tags under Select Assignment Criteria. Enter the tag name admin. The policy evaluates as true for any user tagged with admin.

Criteria settings for user assignment based on username and tag type.

You do not need to enter anything in the Tags field at the top of the Policies screen for this use case.

NOTE

For other identity providers, map an attribute from the IdP to a new user claim instead of using tags to assign users. Then select that user claim in the policy.

When applying access control to entitlements

A Gateway can optionally apply access control when a user or device attempts to use any action defined in an entitlement. Tags are not the primary tool for this use case, but condition-based access supports it as part of its broader feature set.

Follow the same procedure described above for policy assignment when configuring the condition's access criteria.

You do not need to enter anything in the Tags field at the top of the Conditions page for this use case.

When configuring admin roles

TTags play a key role in limiting the scope of administrator privileges and are central to delegated administration in AppGate ZTNA. For general information about configuring admin access, see Configuring Admin Roles.

Unlike the previous use cases, where tags apply only to entitlements or users, apply tags to objects throughout the system. When you create an admin role, you can limit the scope of privilege to objects tagged with a specific tag.

Edit privileges for entitlement with options for limiting scope and adding tags.

You can also tag admin roles themselves to delegate administration of those roles. Select Admin Role for the target item, then limit the scope of privilege using tags assigned to the admin roles.

Admin role privileges settings with options for limiting scope by name and tag.


Configuring tags

To configure tags:

  1. Go to System > Tags.

  2. Select +Add and complete the following fields:

    • Name. The tag name. You can edit a tag name after it is in use—the system updates all references to it automatically. If you reference tags in a script (for example, user.tags), update those references manually.

    • Description. An optional description of the tag.

    • Appearance. The color assigned to the tag.

  3. Save the tag.


Managing tags

To add a tag in most areas of the system, select + Add under Tags. As you type, a filtered dropdown list of existing tags appears. To create a tag, select Create tag and enter the required details.

After tags are in use, they appear on the Tags page, where you can change their color or delete unused tags. Each tag also has an overview that shows all occurrences of that tag in the system. You can edit the tag from this overview. Access the same overview by selecting the tag anywhere in the system.

Select the actions button—the three dots icon (Three circular shapes stacked vertically on a dark background, selected to access a menu.) to the right of a list item—to perform the following actions:

  • Show Tag Overview. Opens the overview of the tag's occurrences in the system. Select Edit Tag in the Tag Overview window to edit the tag.

  • Clone. Creates a copy of the tag.

  • Delete. Removes the tag.

NOTE

You can only delete a tag after you remove it from all objects in the system.