---
description: >-
  Realm Roles page is to create, view, and manage realm-wide roles. You can also
  assign composite roles to group multiple roles together for easier permission
  management.
---

# Realm Roles

#### What Is a Realm Role in Ztrust?

Realm Role is:

* A global role within a realm.
* Useful for cross-client permissions or admin-level roles.
* Can be assigned directly to users or indirectly through composite roles.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FvZ7eBftCX5SZh6urlTLI%2Fimage.png?alt=media&#x26;token=0418cebe-6c0b-4c53-80ed-8c1103a2aa02" alt=""><figcaption></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%2FSVDEuf9oPEBuBCyLMLWe%2F1.png?alt=media&#x26;token=799dbb20-0141-4117-b867-2e02e5852686" alt=""><figcaption></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.

#### **Role Name**

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

#### **Composite**

This setting can be either True or False.

When set to True, it means that when this particular role is assigned or unassigned to a user, any associated roles will also be automatically assigned or unassigned to the user.

When set to False, no other roles will be linked with this 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%2FvUUAvu7JqACJ2g3Lb5RX%2F2.png?alt=media&#x26;token=d33cea29-562f-47c7-ba18-c2bc64db5ae4" alt=""><figcaption></figcaption></figure>

After clicking on the three dots, you'll find the option to delete the role.

To remove any roles at the realm level, simply click on Delete.

After selecting Delete, a confirmation prompt will appear.

\
Click Delete to remove the role, or click Cancel to keep it.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FbRXYpjsAYSSNRLohZOOQ%2F3.png?alt=media&#x26;token=6f7304b7-7dbc-49d4-9071-683550190c90" alt=""><figcaption></figcaption></figure>

#### **Create Role**

If you want to add a new role, click on Create Role.

After clicking on Create 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%2FeQLpPCIX3PugR8NkFjTE%2F4.png?alt=media&#x26;token=e3afe0e8-8868-4157-b143-1d0e4ea2cb5c" alt=""><figcaption></figcaption></figure>

#### **Role Name**

It  indicates the name of the specific role.

#### **Description**

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

#### **Save**

After entering the Name and Description, if you wish to create the role, click on Save.

#### **Cancel**

If you don’t want to apply those changes, click on Cancel to discard those changes.

After clicking on Save, you will be redirected to the below screen

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FxtYefuhu63ul9m075a4X%2F5.png?alt=media&#x26;token=90c06162-b47e-46bf-8969-e8a2ba9a5016" alt=""><figcaption></figcaption></figure>

Here, the details will be mentioned as given by you during the role creation.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FSYSF0UEC6PfvYqZMym7u%2F6.png?alt=media&#x26;token=b33bbf9c-4c15-4994-9633-ea17c1c25f4d" alt=""><figcaption></figcaption></figure>

Within the Attributes section, you have the ability to define any variable you require for the specific Role.

After clicking on Add attributes, you will be directed to the following screen to add the Key-Value Pair.

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

Click Add attributes to save the Key-Value pair.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FJTzPC25dKOT8foBmuxN9%2Fimage.png?alt=media&#x26;token=a57ed241-7947-4eab-b9d0-7e10c6628799" alt=""><figcaption></figcaption></figure>

To remove a specific Key-Value pair, click on the '-' button.

#### **Save**

Once you've entered the required details, if you want to implement the changes, click on Save.

#### **Revert**

If you don’t want to apply those changes, click on Revert to discard those changes.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FoDjqiAsiGBjweUtOaG3w%2F8.png?alt=media&#x26;token=18515116-7470-408b-a1c5-e060362009ae" alt=""><figcaption></figcaption></figure>

In the Users in Role section, you can view the various users assigned to that specific role.

To add users to this role, click on Users. You will be taken to the Users tab (as shown below), where you can add the necessary users.&#x20;

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FYjZbR3Gp7yd76IorSBbo%2F9.png?alt=media&#x26;token=c102cc9c-c284-413f-ada6-f8c56cd98ef4" alt=""><figcaption></figcaption></figure>

Furthermore, you can assign specific user groups to this role by selecting Groups, which will take you to the Groups tab (as illustrated below), where you can add the role to the groups.

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FRJt1m5dfnmynZo8xWbLm%2F10.png?alt=media&#x26;token=7b9e7ec7-46fa-4356-aba5-5d6a22439572" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2F6b3I6pAOLaNbqbM1YsiJ%2F11.png?alt=media&#x26;token=12e754e4-9c44-4b0f-9961-d2a014a4534f" alt=""><figcaption></figcaption></figure>

In the dropdown menu for Actions, you have the option to either Add associated roles or Delete this role.&#x20;

Selecting Add associated roles will display the following screen.&#x20;

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FEfbRPJK9FwZuZ6nZW3Mu%2F12.png?alt=media&#x26;token=beacd918-c3d4-41db-a68e-93e32f1c082d" alt=""><figcaption></figcaption></figure>

You can also search for a specific role by using the search box.

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%2FUcO6GCbK8qY6LZEicnEp%2F13.png?alt=media&#x26;token=1cad539a-1714-46e6-be35-03ba749019ba" alt=""><figcaption></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.

You can then select the checkbox for the specific role you want to associate with this role. 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%2FZCwSVeZRPihNDgOXhWMb%2F14.png?alt=media&#x26;token=076185c2-bdd8-48e2-b4f7-4cdcc2d7c410" alt=""><figcaption></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%2FJvwQmdEVGBkLCn096EXv%2F15.png?alt=media&#x26;token=812059ad-b23f-4c50-9999-9944996e5e6e" alt=""><figcaption></figcaption></figure>

You can also search for a specific role by using the search box.

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%2Fx7eLKncYiRKnOH6N5KSh%2F16.png?alt=media&#x26;token=a6577ad6-243d-47cc-a501-5ea613ca5c9f" alt=""><figcaption></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.

You can then select the checkbox for the specific role you want to associate with this role. 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.
