# Realm Roles

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2F3vnZyf9GIgMb6CQ9vniM%2Fimage.png?alt=media&#x26;token=bee2c52d-4889-4f08-b5b3-7d41ed7053bb" alt=""><figcaption></figcaption></figure>

If you want to view all the roles available within the Realm, click on View All Roles.

#### **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.

#### **Actions**

This section provides options to either edit or delete the configurations for the available roles in ZTrust.

#### **Edit**

If you want to adjust settings related to the available roles, you can make modifications using the Edit button.

#### **Delete**

To remove any roles at the realm level, simply click on the Delete button next to  that role to remove that particular role.

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

After clicking on Add Role, you will be directed to the following screen.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXeKpfwGMSFQoeGKYpHhU4x3gN2V840aTOKZHA5VIDw5bAvj3yby9wkRbcslnib9mECYbTb3Yg4T6aZKm8G25JwxymTXueZ215cAHeF7KReQ0nXJqzVJ4OjC9JcgN54Mr674kMWYScKIygDpL4htuXtj0I5DOThSeLozuxenfEZeXYVPKGhOAA?key=0ECnkWiuLUYSWNiFTVoEqA" 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.

#### **Reset**

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

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

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXfO0e0TL5dVLr2OJoyo4GhIkvDos0keD0zPCB7N5w__aNAygI5YgOxfpouQk4RaYchu7mQ6JKR8JdSzIiMYQHiWCK5MNsx5Q2GfSuTDC52lHCt13tQ3gV6Zf08DlxKIkLHJDKkFHi_TW9_l-7CDEUvC2Oi4m8HpTK_wnRd6xa-PwStA7Fb6Mw?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

#### **Role Name**

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

#### **Description**

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

#### **Composite Roles**

This toggle button, when activated (toggled ON), implies that when this specific role is assigned or unassigned to a user, any associated roles will also be implicitly assigned or unassigned to the user. When deactivated (toggled OFF), no other roles will be associated with this role.&#x20;

When enabled, the corresponding settings will also become available.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXf-wKzSj7QplCq7UZ3-33IjgMC8dzM0Ek-97Sley5-jEMwDeFgHp4RvzCk6G33M7MJHmnjyrWcSaRQKg4UjOzMEmLS9jj7NBPYlgJcx2gHu5mvAMcivxYY39wE9S2QpCjA_80qQJhaxH1q22_ytmqvAabkT1C-MQ-EuWLJ5q34Ws7MYZf8goRE?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

#### **Realm Roles**

#### **Available Roles**

It pertains to the Realm-level roles that you can link with this composite role.

#### **Associated Roles**

It lists all the Realm-level roles that are linked with this composite role.

If you want to include a role from the Available Roles to the Associate Roles, select the specific role and click on Add Selected.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXewbqJG9hu5D9I4wJmQ1Wvjr_fz7nc5_dNyk-bEOYVpqayBWQ1EmEZ7iXzgfj9bhaT2NknllxYDO_Jk7-oG3khccO46x5hzlpUiBhcGPJ5Z6vBgj-TRCGxLv4XSr8OXKFGMnkxjunN-pQTsv5UAw96wVtda4Q_olHPJMTqWzzh8kkb6r7XVQA?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

If you need to remove a role from the Associate Roles, select the role and click on Remove Selected.&#x20;

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXcUZARn5_uQYorOwAvRMMWeQ31dzmW5_t62IUh0I6YuxyRfc-O0yxv7a9ShAx6aR2RT5S-1nmkxLB5jPG10GupVpgRDje8gAE-FBQWILvPUMsvLAPpg38rZN2mPTZxQzThQ3XQpr20Exbk2rjCG5QyOk17mm2osyiB7VSRwYasaFHjBR7QowEU?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

The removed role will then appear under the Available Roles list.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXdh5Kgh2TIKHRT9vVuSS_PsRGY3yqAx3OKn0fxZT-LatqQACfNdYJpXY_dzF-BkNU0MXsQGF960agGwWxfFN8cZlMbObYRKk4EWP2VqtpuXBZWq11YJwDLZa6NxfXMGpdGUA5tuzI6Z6xv8QxCERRtTpyqoEV8IJ3rKuFgMEGJwR80gpqyFJAg?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

#### **Client Roles**

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXfD4JPGfXM1b0iXlBXMupbi67AdUoyWfePdnBokZLDyFf1eV932-FCccFOqK4QlCfU7xnOjvTGrOSfAJjb8i5xHXrkeR5NqOIpwcz7uGuILGJUKuh_wGT-c2nAMB98vqUR-Hsc6yvmhQvba_dP2ijZIlG6KyJOMCWIprADhiKqRkOgWw44_dCs?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

Client roles are namespaces designated for clients, with each client having its own namespace.

These roles are managed within the Roles tab specific to each client.&#x20;

You can assign the role to a particular client by selecting the preferred option from the dropdown menu.

#### **Save**

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

#### **Reset**

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

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXeeDGN-O5nSgGra1GmpeiI5BUMM89KWqDSuOml8bsCVKC12iaRrRGhO2yfOFqWL4n6tXITLky70010u3OHaCs-S4LDTjyBM_lftZ1fRrkZewA94PlpxdLmfamnkcAiA0yTm69ww0oxxdqE3Q5oUDXxSpddDk66iRxm1VG0Nj-Tv5xydcui8ug?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

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

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

Click Add to save the Key-Value pair.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXek2AblKjH7zd5F-TzZqrzyF2G9glamHCjkm5yBhR27NVj9t8lUUckbSyUQW5T8HiG_rwFBpkp6l--7WLXUBIoX1pyp8RZVBfrSFjDCcwsAsZmVc_iy6MZssNryMV4A_d6IHwKPigflA_I2ntihCbKzdb5Lf5rgSmZeZw6Hxn7t5Uh7SQmTFg?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

If you no longer need the Key-Value pair, click on Delete.

#### **Save**

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

#### **Reset**

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

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXdYZvT6n6NfKPnm7YSw1puvOiVQPEudVeJmd1PDqvmOSy5WzOZ0VZ93wb21PwYG9P5tLJTwrJsn5U469xhjJ8-zh8t-u2OgjnIYNwZ_jciBp9ypsLdsIjRJl7lnQ1jr8cNw3hvYqYF5gmLg8A8GkWNC109jZysp873Y_LN2AE_Ht5s9u4GtTgk?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

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

For example - for the Role mentioned below, we can see the user assigned to that role.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXdxn_-SyPpIZtJvz3eDSvCRD9VUy1tu-N9UsvTIZQ7S4_w2Le9g0NXJPyjHHHUgOtgbSDZYqYOfJto7RPFny6kEAIAr6bf5Oi18BTPRJKFF6YnsJIwPOy4Ifjpxm4fq9D9ORHU6LeW9--G4IKqlwQ7SIcfEAfVS8X07L4T_mWd6OeWdwvS2fGQ?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

#### **Username**

It refers to the username of the user.

#### **Last Name**

It refers to the surname or the last name of the particular user.

#### **First Name**

It refers to the first name of the user.

#### **Email**

It specifies the email ID of the user.

#### **Edit**

To modify any specific setting related to the user, select Edit.

Upon clicking Edit, you will be directed to the Users tab.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXdh8pbbf1233_hU2184cQre745Qx1cq_gD_Og8bCRpDd-hYRhsPI-eMjn4aDrdHz8Wj2Gw__HRkWG_R24aKbaJ3yQiNIW2iH2Lg4Nrufkiq5iEpMsNzzaon5Z99XkSsB-ef_4LlTSvMJQD523Kuo-uFSe-xBc-yS5Rd_Owl1G8bNcT0v515JnI?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

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

![](https://lh7-us.googleusercontent.com/docsz/AD_4nXdFTX-m0wr2ws4neDkGSdLpYYI65cm9YGwK-JMYr-r3iUQKBoLEm_m71eInX5swUVRD4ScQIiVDNJb0uDhAFlqktE1Ia3v3U-Gn8zu1tNSvOIS3DzUQqfiPPbHTMrjva9ibuwjx9KQZg9Z9Ply6_voKoJ0vv58duFSw5RjHUjaODIDpDY110g?key=0ECnkWiuLUYSWNiFTVoEqA)

#### **Role Name**

It indicates the name of the specific role.

This field is not open for editing.

#### **Description**

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

This is an editable field and you can modify it as per your requirements.

#### **Composite Roles**

This toggle button, when activated (toggled ON), implies that when this specific role is assigned or unassigned to a user, any associated roles will also be implicitly assigned or unassigned to the user. When deactivated (toggled OFF), no other roles will be associated with this role.&#x20;

When enabled, the corresponding settings will also become available.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXf-wKzSj7QplCq7UZ3-33IjgMC8dzM0Ek-97Sley5-jEMwDeFgHp4RvzCk6G33M7MJHmnjyrWcSaRQKg4UjOzMEmLS9jj7NBPYlgJcx2gHu5mvAMcivxYY39wE9S2QpCjA_80qQJhaxH1q22_ytmqvAabkT1C-MQ-EuWLJ5q34Ws7MYZf8goRE?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

#### **Realm Roles**

#### **Available Roles**

It pertains to the Realm-level roles that you can link with this composite role.

#### **Associated Roles**

It lists all the Realm-level roles that are linked with this composite role.

If you want to include a role from the Available Roles to the Associate Roles, select the specific role and click on Add Selected.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXewbqJG9hu5D9I4wJmQ1Wvjr_fz7nc5_dNyk-bEOYVpqayBWQ1EmEZ7iXzgfj9bhaT2NknllxYDO_Jk7-oG3khccO46x5hzlpUiBhcGPJ5Z6vBgj-TRCGxLv4XSr8OXKFGMnkxjunN-pQTsv5UAw96wVtda4Q_olHPJMTqWzzh8kkb6r7XVQA?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

If you need to remove a role from the Associate Roles, select the role and click on Remove Selected.&#x20;

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXcUZARn5_uQYorOwAvRMMWeQ31dzmW5_t62IUh0I6YuxyRfc-O0yxv7a9ShAx6aR2RT5S-1nmkxLB5jPG10GupVpgRDje8gAE-FBQWILvPUMsvLAPpg38rZN2mPTZxQzThQ3XQpr20Exbk2rjCG5QyOk17mm2osyiB7VSRwYasaFHjBR7QowEU?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

The removed role will then appear under the Available Roles list.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXdh5Kgh2TIKHRT9vVuSS_PsRGY3yqAx3OKn0fxZT-LatqQACfNdYJpXY_dzF-BkNU0MXsQGF960agGwWxfFN8cZlMbObYRKk4EWP2VqtpuXBZWq11YJwDLZa6NxfXMGpdGUA5tuzI6Z6xv8QxCERRtTpyqoEV8IJ3rKuFgMEGJwR80gpqyFJAg?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

#### **Client Roles**

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXfD4JPGfXM1b0iXlBXMupbi67AdUoyWfePdnBokZLDyFf1eV932-FCccFOqK4QlCfU7xnOjvTGrOSfAJjb8i5xHXrkeR5NqOIpwcz7uGuILGJUKuh_wGT-c2nAMB98vqUR-Hsc6yvmhQvba_dP2ijZIlG6KyJOMCWIprADhiKqRkOgWw44_dCs?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

Client roles are namespaces designated for clients, with each client having its own namespace.

These roles are managed within the Roles tab specific to each client.&#x20;

You can assign the role to a particular client by selecting the preferred option from the dropdown menu.

#### **Save**

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

#### **Reset**

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

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXeeDGN-O5nSgGra1GmpeiI5BUMM89KWqDSuOml8bsCVKC12iaRrRGhO2yfOFqWL4n6tXITLky70010u3OHaCs-S4LDTjyBM_lftZ1fRrkZewA94PlpxdLmfamnkcAiA0yTm69ww0oxxdqE3Q5oUDXxSpddDk66iRxm1VG0Nj-Tv5xydcui8ug?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

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

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

Click Add to save the Key-Value pair.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXek2AblKjH7zd5F-TzZqrzyF2G9glamHCjkm5yBhR27NVj9t8lUUckbSyUQW5T8HiG_rwFBpkp6l--7WLXUBIoX1pyp8RZVBfrSFjDCcwsAsZmVc_iy6MZssNryMV4A_d6IHwKPigflA_I2ntihCbKzdb5Lf5rgSmZeZw6Hxn7t5Uh7SQmTFg?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

If you no longer need the Key-Value pair, click on Delete.

#### **Save**

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

#### **Reset**

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

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXdYZvT6n6NfKPnm7YSw1puvOiVQPEudVeJmd1PDqvmOSy5WzOZ0VZ93wb21PwYG9P5tLJTwrJsn5U469xhjJ8-zh8t-u2OgjnIYNwZ_jciBp9ypsLdsIjRJl7lnQ1jr8cNw3hvYqYF5gmLg8A8GkWNC109jZysp873Y_LN2AE_Ht5s9u4GtTgk?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

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

