> For the complete documentation index, see [llms.txt](https://ztrust.gitbook.io/ztrust-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ztrust.gitbook.io/ztrust-documentation/user-manual-ztrust-v4.1/3.-guide-to-navigation/3.5-groups.md).

# 3.5 Groups

Groups page manages user groups within the realm to simplify role and permission assignments. Using this page, you can create, organize, and assign users to groups with shared access settings

#### What Is a Group in Ztrust?

Group in ztrust a collection of users that can share common roles, attributes, and access controls. Rather than assigning roles to each user individually, you can assign them to a group and all users in that group will inherit them

Group role inheritance is dynamic: When you add/remove roles from a group, all users in that group are immediately affected.

A user can belong to multiple groups.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FxzYQz3Wd5Bs6kS2pN2Fi%2Fimage.png?alt=media&amp;token=c582eaf1-1bc9-4276-beba-0b1aeb0367d6" alt=""><figcaption><p>Fig 3.5.a: Groups Section </p></figcaption></figure>

Under the Groups tab, users have the ability to create various groups to accommodate specific sets of users.

You can use the search box to find a specific user.

You also have the option to go for Exact Search.

Click the Refresh button to see the latest settings.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FEJTHMvlLWOS7aFySnlk8%2F1.png?alt=media&amp;token=90c0cc48-4e89-4354-9638-262a962b8d88" alt=""><figcaption><p>Fig 3.5.b: Choose how many groups you want to display on one screen</p></figcaption></figure>

You can also choose how many groups you want to display on one screen. Select your preferred option from the dropdown menu as shown above.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FjH9mXQNcj5B3mxJyndzs%2F2.png?alt=media&amp;token=d3773290-12c6-4fae-a8ad-81b997104082" alt=""><figcaption><p>Fig 3.5.c: No groups in this realm</p></figcaption></figure>

#### **Create group**

Click on the Create group option to generate a new group.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FRLrutxLovLTCWxNuA0Ya%2F3.png?alt=media&amp;token=81ca7134-8200-49c9-b539-fca8c6402e41" alt=""><figcaption><p>Fig 3.5.d: Create a new group</p></figcaption></figure>

Choose any Name you like and form the group. For example - demo

Click on Create to establish the group, or click Cancel to abort the operation. Upon selecting Create, you will be directed to the screen below.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FCzCEXWk7OoVUWDFkQsjy%2F4.png?alt=media&amp;token=2fd41fe1-f625-4e14-b157-6d7cd36e7a04" alt=""><figcaption><p>Fig 3.5.e: Group created</p></figcaption></figure>

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2Fr2X3C8MXpcF4SOfX6T94%2F5.png?alt=media&amp;token=0a141f0c-7f28-4595-b238-876462d06ca9" alt=""><figcaption><p>Fig 3.5.f: Edit options for group</p></figcaption></figure>

After clicking on the three dots, the following options are visible:

* Rename - After selecting Rename, you will see the following prompt

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FCtlqEhUVlj6iXxv1RQM5%2F6.png?alt=media&amp;token=3be46327-7206-409a-877d-38c94e966aad" alt=""><figcaption><p>Fig 3.5.g: Rename group</p></figcaption></figure>

Enter the desired name for the group.

Click Rename to confirm the new name or Cancel to discard the change.

* Move to - After selecting Move to, the following prompt will appear:

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2Fo62RdvcIxcdCMvaWePNb%2F7.png?alt=media&amp;token=624d3537-cf9f-4a8d-be9c-c0784e0b9c36" alt=""><figcaption><p>Fig 3.5.h: Move group to Root</p></figcaption></figure>

Choose the specific group where you want to move your group.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FjGKwj6CBfdkR68anG0fi%2F8.png?alt=media&amp;token=d1f0b4db-5834-4349-90ca-bb60706c6df5" alt=""><figcaption><p>Fig 3.5.i: Click Move here to confirm</p></figcaption></figure>

Then click Move here to confirm the action.

* Create child group - After selecting this option, the following prompt will appear:

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FDohjM1Ii9vhmOaqAGvJK%2F9.png?alt=media&amp;token=60910438-c4ec-4469-a838-5390a8e1524e" alt=""><figcaption><p>Fig 3.5.j: Create child group</p></figcaption></figure>

Enter any name according to your requirements. Click Create to create the child group, or click Cancel to discard.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FkC7JnItHwhlKEKqBQwhT%2F10.png?alt=media&amp;token=2d3fc024-e404-4631-bdb7-51e7a29cc081" alt=""><figcaption><p>Fig 3.5.k: Child group created</p></figcaption></figure>

The new group will be created inside the previous group. For example, childgroup\_demo2 will be created inside the rename\_demo group.

* Delete - After selecting Delete, the following confirmation prompt will appear:

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FQvn9XutXhWHzrPvLz8hb%2F11.png?alt=media&amp;token=68b8cfe4-ef30-4d2d-bffc-7e47dcea59db" alt=""><figcaption><p>Fig 3.5.l: Confirmation to delete</p></figcaption></figure>

Click Delete to remove the group, or click Cancel to abort the action.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FMFWnKvT5TG779R5mnUpf%2F12.png?alt=media&amp;token=8dad9222-6387-4547-86b4-195dfa8c9dbc" alt=""><figcaption><p>Fig 3.5.j: Available groups</p></figcaption></figure>

You can use the filter groups box to find a specific group.

Click the Refresh button to see the latest settings.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FOxFHA7cg8xFg9rZcf6Jg%2F13.png?alt=media&amp;token=e176308f-4fd7-4768-8df1-c369a82eec6e" alt=""><figcaption><p>Fig 3.5.k: Choose how many groups you want to display on one screen</p></figcaption></figure>

You can also choose how many groups you want to display on one screen. Select your preferred option from the dropdown menu as shown above.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FdTjpmZEfaJBSJOM0U7K1%2F14.png?alt=media&amp;token=6837704b-64ff-4957-b9fa-29fb92a2bd65" alt=""><figcaption><p>Fig 3.5.l: To delete multiple groups at once</p></figcaption></figure>

To delete multiple groups at once, select each group by clicking the checkbox next to it. Then, click Delete.

A confirmation prompt will appear.

&#x20;

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FCN5m8Gexx6rtxiEXqsUW%2F15.png?alt=media&amp;token=fa747be8-db3b-4efd-ab48-284a30ad6e2d" alt=""><figcaption><p>Fig 3.5.m: Confirmation to delete</p></figcaption></figure>

Click Delete to confirm the deletion, or click Cancel to abort.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2F9Q0DP4Yo7VpeqoleOSqp%2F16.png?alt=media&amp;token=6181b982-20f5-4146-b344-3ed5ead01b63" alt=""><figcaption><p>Fig 3.5.n: Child group</p></figcaption></figure>

#### **Child groups**

#### **Create group**

To create a new child group, click on Create Group.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FPIhxLDBUK5If9IhXJXZd%2F17.png?alt=media&amp;token=1f18c6d6-b80a-401c-9c4f-f77fa57284e8" alt=""><figcaption><p>Fig 3.5.o: Creating new chaild group</p></figcaption></figure>

Enter the desired name.

Click Create to make the group, or Cancel to discard.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FH6Bz09IMuikMNMmZz7SK%2F18.png?alt=media&amp;token=87ca9d74-4fcd-4f78-b067-4ccbc743c059" alt=""><figcaption><p>Fig 3.5.p: Available child groups</p></figcaption></figure>

You can use the filter groups box to find a specific group.

Click the Refresh button to see the latest settings.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FSns70sFsdvTGELdbZZs8%2F19.png?alt=media&amp;token=2a095577-e4c8-4c77-a193-139dc4d6209b" alt=""><figcaption><p>Fig 3.5.q: Choose how many groups you want to display on one screen</p></figcaption></figure>

You can also choose how many groups you want to display on one screen. Select your preferred option from the dropdown menu as shown above.

#### **Members**

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2F9bmOQa6E9LKTjULgRB4i%2F20.png?alt=media&amp;token=2c18ab20-b9fc-4296-883b-a0ac2cf3c49c" alt=""><figcaption><p>Fig 3.5.r: Users assigned to this group</p></figcaption></figure>

After selecting Add member, you will be taken to the following screen.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FNOk6bfuTkEfZdN2rK9n9%2F21.png?alt=media&amp;token=8fcbe0d8-fcce-4e78-aa3e-987ec60fef01" alt=""><figcaption><p>Fig 3.5.s: List of users under same realm</p></figcaption></figure>

Select the desired users by clicking the checkbox next to their names, then click Add.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2F9XgsxlaebKrGomPQ71dO%2F22.png?alt=media&amp;token=41a8ae51-b348-4648-9c3e-04f5b4316fd0" alt=""><figcaption><p>Fig 3.5.t: Clicking the checkbox next to their names to add into group</p></figcaption></figure>

You'll find the specific user within this group.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FiHGTAusU9mDtJECnKuAM%2F23.png?alt=media&amp;token=e2c8e61b-010c-4864-b5e3-bbb2037b85f0" alt=""><figcaption><p>Fig 3.5.u: User added into group</p></figcaption></figure>

#### **Name**

This is the name used by the user during creation.

It can also be used for logging into ZTrust.

#### **Email**

The user's provided Email address during registration or in case the user has been created by the Admin. It can also be used for logging into ZTrust.

#### **First Name**

The user's First Name or the First Name provided during registration.

**Last Name**

The Last Name provided by the user during registration, or the user's last name.

#### **Membership**

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FsC9ukytlepaWoh8vNPAI%2F24.png?alt=media&amp;token=2278bf4d-9aac-4f17-a3dc-2af5306713c5" alt=""><figcaption><p>Fig 3.5.v: Option to remove the user</p></figcaption></figure>

To remove the specific user from the group, simply click the Leave button.

#### **Attributes**

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2F67GydhQCS6akQ24IuUfc%2F25.png?alt=media&amp;token=79b8b41a-e61c-4d3c-bc7d-81484905602d" alt=""><figcaption><p>Fig 3.5.w: Group attributes tab</p></figcaption></figure>

Within the Attributes section, you have the ability to define any variable you require for the entire Group.

Click on Add attributes.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2F2S146GA1uO0SfSJDO9x9%2F26.png?alt=media&amp;token=eabd40ac-43cd-48cf-a655-c7b916d112ed" alt=""><figcaption><p>Fig 3.5.x: Adding attribute to group</p></figcaption></figure>

Just provide the Key, which is the variable you want to define, and then input its corresponding Value.

Click Add attribute to save the Key-Value pair.

To delete the Key-Value pair, click on the '-' symbol.

Click on Save to keep these alterations, and click on Revert to discard any changes made.

#### **Role mapping**

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2F02GlOffzCPfl0arFKR6B%2F27.png?alt=media&amp;token=d9ba7c39-b997-452d-9ec5-384379e57e29" alt=""><figcaption><p>Fig 3.5.y: Group role mapping tab</p></figcaption></figure>

Upon selecting the Assign role, you will be directed to the following screen.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2Fpm15AignuduQS2sHBC3W%2F28.png?alt=media&amp;token=f3cefad4-7aed-4da9-a6bf-b1e72e8d2cdd" alt=""><figcaption><p>Fig 3.5.z: Add role to group</p></figcaption></figure>

You can use the search box to find a specific group.

Click the Refresh button to see the latest settings.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FuN0DHjX6gZW9rZ0w6sQX%2F29.png?alt=media&amp;token=ada2351a-79e4-4e21-ab83-13e26c0bcc37" alt=""><figcaption><p>Fig 3.5.Aa: Choose how many groups you want to display on one screen</p></figcaption></figure>

You can also choose how many groups you want to display on one screen. Select your preferred option from the dropdown menu as shown above.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FaDysCtOpQWjGAfPQ0myL%2F30.png?alt=media&amp;token=4db03278-7087-406f-9087-ba57101e23b3" alt=""><figcaption><p>Fig 3.5.Ab: Add realm role to group</p></figcaption></figure>

You can then select the checkbox for the specific role you want to assign to this group. Click on the checkbox to select the role, then click on Assign.&#x20;

If you decide not to associate the selected roles, click on Cancel to discard the changes.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FVh1fIxndqQzHUgwuyKqq%2F31.png?alt=media&amp;token=de865a25-1a8f-48dd-9640-c4ef20b91689" alt=""><figcaption><p>Fig 3.5.Ac: Filter tab to clients roles</p></figcaption></figure>

You also have the option to filter roles based on the clients.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FEDh8bv9Z0BISCtgTMjqK%2F32.png?alt=media&amp;token=cecb12e8-7ce1-49df-99be-d9b2c0aa6b0d" alt=""><figcaption><p>Fig 3.5.Ad: List of client roles</p></figcaption></figure>

You can then select the checkbox for the specific role you want to assign to this group. Click on the checkbox to select the role, then click on Assign.&#x20;

If you decide not to associate the selected roles, click on Cancel to discard the changes.

After clicking on Assign, you can see the below screen.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2F9nyOOxWiyyUDi7ShTBZ4%2F33.png?alt=media&amp;token=701e57b8-306c-4e39-a59d-17061ec982f1" alt=""><figcaption><p>Fig 3.5.Ae: Role added to group</p></figcaption></figure>

You can use the search box to find a specific role.

Click the Refresh button to see the latest settings.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2F8dpUg7cqSpCS6iDPJwRY%2F34.png?alt=media&amp;token=d0af09fe-a71b-4f11-8f09-206bb935ed57" alt=""><figcaption><p>Fig 3.5.Af:  Choose how many roles you want to display on one screen</p></figcaption></figure>

You can also choose how many roles you want to display on one screen. Select your preferred option from the dropdown menu as shown above.

#### **Hide inherited roles**

Selecting this checkbox hides inherited roles, preventing you from seeing roles inherited from composites. To view inherited roles, simply uncheck this option.

#### **Name**

It includes the list of all the different roles that are already defined in ZTrust.

#### **Inherited**

This pertains to roles explicitly assigned to users and those inherited from composite roles. It can have two values: True (indicating the role is inherited from composites) or False (indicating it is not inherited from any composite role).

#### **Description**

It refers to the description for the role which will aid you in identifying its purpose.

This field can be localized by specifying a substitution variable with ${var-name} strings.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FJG1xDgIDb4Fz8Ok5jRPm%2F35.png?alt=media&amp;token=f0b8f77d-c17c-4259-a333-213da954a8fd" alt=""><figcaption><p>Fig 3.5.Ag: Option to remove role to group</p></figcaption></figure>

Upon clicking on the three dots, you will find the Unassign option.

When you click on Unassign, a confirmation prompt will appear.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FE6aNn15oezbP4X7qMVHi%2F36.png?alt=media&amp;token=1f09b2aa-7ca1-46d5-a784-75635537d8d2" alt=""><figcaption><p>Fig 3.5.Ah: Confirmation to remove</p></figcaption></figure>

If you wish to unassign a specific role from this group, click on Remove. Otherwise, click Cancel.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FhSI6sVaJjHCrnJsbwKHF%2F37.png?alt=media&amp;token=a6b45f22-1e8e-4d53-953c-f022bd3ae9d1" alt=""><figcaption><p>Fig 3.5.Ai: To unassign multiple roles simultaneously</p></figcaption></figure>

To unassign multiple roles simultaneously, first, select the specific roles by clicking on the checkboxes next to them. Then, click on Unassign.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2F20z8b6jzewOj6kb4RD8h%2F38.png?alt=media&amp;token=6bbc6e7a-8ace-4bf7-94a8-138d546de808" alt=""><figcaption><p>Fig 3.5.Aj: Confirmation to remove</p></figcaption></figure>

You'll receive a confirmation prompt similar to the one shown above. To unassign the roles, click on Remove. Otherwise, click on Cancel.

<br>
