Product Documentation
Application Delivery Management
14.1 - Current Release 13.1 13.0
View PDF

Configure groups

December 31, 2023
Contributed by: 
C

In Citrix ADM, a group can have both feature-level and resource-level access. For example, one group of users might have access to only selected Citrix ADC instances; another group with only a selected few applications, and so on.

When you create a group, you can assign roles to the group, provide application-level access to the group, and assign users to the group. All users in that group are assigned the same access rights in Citrix ADM.

You can manage a user access in Citrix ADM at the individual level of network function entities. You can dynamically assign specific permissions to the user or group at the entity level.

Citrix ADM treats virtual server, services, service groups, and servers as network function entities.

  • Virtual server (Applications) - Load Balancing(lb), GSLB, Context Switching (CS), Cache Redirection (CR), Authentication (Auth), and Citrix Gateway (VPN)

  • Services - Load balancing and GSLB services
  • Service Group - Load balancing and GSLB Service groups
  • Servers - Load balancing Servers

Create a user group

  1. In Citrix ADM, navigate to System > User Administration > Groups.

  2. Click Add.

    The Create System Group page is displayed.

  3. In the Group Name field, enter the name of the group.

  4. In the Group Description field, type in a description of your group. Providing a good description of the group helps you to understand the role and function of the group in a better way at a later point.  

  5. In the Roles section, add or move one or more roles to the Configured list.

    Note Under the Available list, you can click New or Edit and create or modify roles. Alternatively, you can navigate to System > User Administration > Users and create or modify users.

    Create system group

  6. Click Next. On the Authorization Settings tab, you can provide authorization settings for the following resources:

    • Autoscale Groups
    • Instances
    • Applications
    • Configuration Templates
    • StyleBooks
    • Configpacks
    • Domain Names

    Categories in authorization settings

    You might want to select specific resources from the categories to which users can have access.

    Autoscale Groups:

    If you want to select the specific Autoscale groups that a user can view or manage, perform the following steps:

    1. Clear the All AutoScale Groups check box and click Add AutoScale Groups.

    2. Select the required Autoscale groups from the list and click OK.

    Instances:

    If you want to select the specific instances that a user can view or manage, perform the following steps:

    1. Clear the All Instances check box and click Select Instances.

    2. Select the required instances from the list and click OK.

      Select instances

    Applications:

    The Choose Applications list allows you to grant access to a user for the required applications.

    You can grant access to applications without selecting their instances. Because applications are independent of their instances to grant user access.

    When you grant a user access to an application, the user is authorized to access only that application regardless of instance selection.

    This list provides you the following options:

    • All Applications: This option is selected by default. It adds all the applications that are present in the Citrix ADM.

    • All Applications of selected instances: This option appears only if you select instances from the All Instances category. It adds all the applications present on the selected instance.

    • Specific Applications: This option allows you to add the required applications that you want users to access. Click Add Applications and select the required applications from the list.

    • Select Individual Entity Type: This option allows you to select a specific type of network function entity and corresponding entities.

      You can either add individual entities or select all entities under the required entity type to grant access to a user.

      The Apply on bound entities also option authorizes the entities that are bound to the selected entity type. For example, if you select an application and select Apply on bound entities also, Citrix ADM authorizes all the entities that are bound to the selected application.

      Note

      Ensure you have selected only one entity type if you want to authorize bound entities.

    You can use regular expressions to search and add the network function entities that meet the regex criteria for the groups. The specified regex expression is persisted in Citrix ADM. To add regular expression, perform the following steps:

    1. Click Add Regular Expression.

    2. Specify the regular expression in the text box.

      The following image explains how to use regular expression to add an application when you select the Specific Applications option:

      Specific applications

      The following image explains how to use regular expression to add network function entities when you choose the Select the Individual Entity Type option:

      Network function entity types

    If you want to add more regular expressions, click the + icon.

    Note

    The regular expression only matches the server name for the Servers entity type and not the server IP address.

    If you select the Apply on bound entities also option for a discovered entity, a user can automatically access the entities that are bound to the discovered entity.

    The regular expression is stored in the system to update the authorization scope. When the new entities match the regular expression of their entity type, Citrix ADM updates the authorization scope to the new entities.

    Configuration Templates:

    If you want to select the specific configuration template that a user can view or manage, perform the following steps:

    1. Clear the All Configuration templates check box and click Add Configuration Template.

    2. Select the required template from the list and click OK.

      Add configuration templates

    StyleBooks:

    If you want to select the specific StyleBook that a user can view or manage, perform the following steps:

    1. Clear the All StyleBooks check box and click Add StyleBook to Group. You can either select individual StyleBooks or specify a filter query to authorize StyleBooks.

      If you want to select the individual StyleBooks, select the StyleBooks from the Individual StyleBooks pane and click Save Selection.

      If you want to use a query to search StyleBooks, select the Custom Filters pane. A query is a string of key-value pairs where keys are name, namespace, and version.

      You can also use regular expressions as values to search and add StyleBooks that meet regex criteria for the groups. A custom filter query to search StyleBooks supports both And and Or operation.

      Example:

      name=lb-mon|lb AND namespace=com.citrix.adc.stylebooks AND version=1.0
<!--NeedCopy-->

      This query lists the StyleBooks that meet the following conditions:

      • StyleBook name is either lb-mon or lb.
      • StyleBook namespace is com.citrix.adc.stylebooks.
      • StyleBook version is 1.0.

      Use an Or operation between value expressions that is defined to the key expression.

      Example:

      • The name=lb-mon|lb query is valid. It returns the StyleBooks having a name either lb-mon or lb.
      • The name=lb-mon | version=1.0 query is invalid.

      Press Enter to view the search results and click Save Query.

      Custom filters

      The saved query appears in the Custom Filters Query. Based on the saved query, the ADM provides user access to those StyleBooks.

    2. Select the required StyleBooks from the list and click OK.

      Select StyleBooks

      You can select the required StyleBooks when you create groups and add users to that group. When your user selects the permitted StyleBook, all dependent StyleBooks are also selected.

    Configpacks:

    In Configpacks, select one of the following options:

    • All Configrations: This option is selected by default. It adds all the configuration packs that are in ADM.

    • All Configrations of the selected StyleBooks: This option adds all the configuration packs of the selected StyleBook.

    • Specific Configurations: This option allows you to add the required cofiguration packs.

      Select a configuration pack

      You can select the required configuration packs when you create groups and add users to that group.

    Domain Names:

    If you want to select the specific domain name that a user can view or manage, perform the following steps:

    1. Clear the All Domain Names check box and click Add Domain Name.

    2. Select the required domain names from the list and click OK.

  7. Click Create Group.

  8. In the Assign Users section, select the user in the Available list, and add the user to the Configured list.

    Note

    You can also add users by clicking New.

    Example to create a system group

  9. Click Finish.

Manage user access across multiple network function entities

As an administrator, you can manage user access at the individual level of network function entities in Citrix ADM. And, you can dynamically assign specific permissions to the user or a group at the entity level by using the regular expression filter.

This document describes how to define user authorization at the entity level.

Before you begin, create a group. See Configure groups on Citrix ADM for more information.

Usage scenario:

Consider a scenario where one or more applications (virtual servers) are hosted on the same server. A super administrator (George) wants to grant Steve (an application administrator) access only to App1 and not to the hosting server.

The following table illustrates this environment, where Server-A hosts applications App-1 and App-2.

Host Server Application (virtual server) Service Service group
Server A App1 App-service-1 App-service-group-1
Server A App2 App-service-2 App-service-group-2

Note

Citrix ADM treats virtual server, services, service groups, and servers as network function entities. The entity type virtual server is referred as an application.

To assign user permissions to network function entities, George defines the user authorization as follows:

  1. Navigate to Account > User Administration > Groups and add a group.

  2. In the Authorization Settings tab, select Choose Applications.

  3. Choose Select Individual Entity Type.

  4. Select the All Applications entity type and add the App-1 entity from the available list.

  5. Click Create Group.

  6. In Assign users, select the users who require the permission. For this scenario, George selects Steve’s user profile.

  7. Click Finish.

With this authorization setting, Steve can manage only App-1 and not other network function entities.

Note

Ensure the Apply on bound entities also option is cleared. Otherwise, Citrix ADM grants access to all network function entities that are bound to App-1. As a result, grants access to the hosting server as well.

A super administrator can specify the regular expressions (regex) for each entity type. The regular expression is stored in the system to update the user authorization scope. When new entities match the regular expression of their entity type, Citrix ADM can dynamically grant users access to the specific network function entities.

To grant user permissions dynamically, the super administrator can add regular expressions in the Authorization Settings tab.

In this scenario, George adds App* as a regular expression for the Applications entity type and the applications that match the regex criteria appear in the list. With this authorization setting, Steve can access all the applications that match the App* regex. However, his access is limited only to the applications not to the hosted server.

How user access changes based on the authorization scope

When an administrator adds a user to a group that has different access policy settings, the user is mapped to more than one authorization scopes and access policies.

In this case, the ADM grants the user access to applications depending on the specific authorization scope.

Consider a user who is assigned to a group that has two policies Policy-1 and Policy-2.

  • Policy-1 – View only permission to applications.

  • Policy-2 – View and Edit permission to applications.

User access changes with authorization scopes

The user can view the applications specified in Policy-1. Also, this user can view and edit the applications specified in Policy-2. The edit access to Group-1 applications are restricted as it is not under Group-1 authorization scope.

Mapping of RBAC when upgrading Citrix ADM from 12.0 to later releases

When you upgrade Citrix ADM from 12.0 to 13.0, you do not see the options to provide “read-write” or “read” permissions while creating groups. These permissions have been replaced by “roles and access policies,” which give you more flexibility to provide role-based permissions to the users. The following table shows how the permissions in release 12.0 are mapped to release 13.0:

12.0 Allow Applications Only 13.0
admin read-write False admin
admin read-write True appAdmin
admin read-only False readonly
admin read-only True appReadonly
Configure groups
December 31, 2023
Contributed by: 
C
December 31, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.