ZTrust Documentation
  • User Manual - ZTrust V3.0
    • Key Terminologies
    • Guide to Navigation
      • Clients
        • Clients List
        • Initial Access Token
        • Client Registration
      • Client Scopes
      • Realm Roles
      • Users
      • Groups
      • Sessions
      • Events
        • User events
        • Admin events
      • Realm Settings
        • General
        • Login
        • Email
        • Themes
        • Keys
        • Events
        • Localization
        • Security Defenses
        • Sessions
        • Tokens
        • Client Policies
        • User profile
        • User Registration
      • Authentication
        • Flows
        • Required Actions
        • Policies
      • Identity Providers
      • User Federation
    • Admin Manual
      • Creation of a Realm
      • Creation of a User
        • Login to Account Console
      • How to set up Password Invalidator
      • How to set up Password Policies
      • How to set up Brute Force Detection feature
      • How to enable the One-to-Many feature
      • How to set up Multi-Factor Authentication
        • Setup of ReCAPTCHA registration flow
        • Setup of ReCAPTCHA login flow
        • Setup of OTP Based Registration
        • Setup of OTP Based Login
        • Setup of QR Code Based Authentication
        • Setup of Push Notification Based Authentication
        • Setup of Biometric based Authentication
        • How to set-up 2FA Authentication
      • ZTrust Authenticator App
      • Self-Service Portal (SSP)
        • Authenticator Setup from Self-Service Portal
        • Set Your Profile Photo in Self-Servicce Portal
      • How to setup Session Invalidator feature
      • How to setup GDPR Compliant feature
      • How to set up Social Media login
      • How to setup Inactive User Tracking feature
      • How to setup Archive Inactive User feature
      • Role-Specific Attribute Based Access Control at client level
      • Self-Role Request at the Business Level
      • Self-Role Request at the Application Level
      • How to setup Delete Archived/Inactive User feature
      • Reporting Module
      • Geo Tagging and Fencing
      • Event Type
  • Release Notes
    • ZTrust V3.1.0
    • ZTrust V3.0.0
    • ZTrust V2.1.0
    • ZTrust V2.0.1
    • ZTrust V2.0.0
    • ZTrust V1.0.4
    • ZTrust V1.0.3
    • ZTrust V1.0.2
    • ZTrust V1.0.1
    • ZTrust V1.0.0
  • Frequently Asked Questions
  • User Manual - ZTrust V2.0
    • Key Terminologies
    • Guide to Navigation
      • Clients
        • Clients List
        • Initial Access Token
        • Client Registration
      • Client Scopes
      • Realm Roles
      • Users
      • Groups
      • Sessions
      • Events
        • User events
        • Admin events
      • Realm Settings
        • General
        • Login
        • Email
        • Themes
        • Keys
        • Events
        • Localization
        • Security Defenses
        • Sessions
        • Tokens
        • Client Policies
        • User profile
        • User Registration
      • Authentication
        • Flows
        • Required Actions
        • Policies
      • Identity Providers
      • User Federation
    • Admin Manual
      • Creation of a Realm
      • Creation of a User
        • Login to Account Console
      • How to set up Password Invalidator
      • How to set up Password Policies
      • How to set up Brute Force Detection feature
      • How to enable the One-to-Many feature
      • How to set up Multi-Factor Authentication
        • Setup of ReCAPTCHA registration flow
        • Setup of ReCAPTCHA login flow
        • Setup of OTP Based Registration
        • Setup of OTP Based Login
        • Setup Time-based One-Time Password (TOTP) Based Login
        • Setup of QR Code Based Authentication
        • Setup of Push Notification Based Authentication
        • Setup of Biometric based Authentication
        • How to set-up 2FA Authentication
      • How to setup Session Invalidator feature
      • How to setup GDPR Compliant feature
      • How to set up Social Media login
      • How to setup Inactive User Tracking feature
      • How to setup Archive Inactive User feature
      • How to setup Delete Archived/Inactive User feature
      • Role-Specific Attribute Based Access Control at client level
      • Reporting Module
      • Geo Tagging and Fencing
      • Event Type
  • User Manual - ZTrust V1.0
    • Guide to Navigation
      • Realm Settings
        • General
        • Login
        • Keys
        • Email
        • Themes
        • RabbitMQ Config
        • Localization
        • Cache
        • Tokens
        • Client Registration
        • Client Policies
        • Security Defenses
      • Clients
      • Client Scopes
        • Default Client Scopes
      • Roles
        • Realm Roles
        • Default Roles
      • Identity Providers
      • User Federation
      • Authentication
        • Flows
        • Bindings
        • Required Actions
        • Password Policy
        • OTP Policy
        • WebAuthn Policy
        • WebAuthn Passwordless Policy
        • CIBA Policy
      • Groups
        • Default Groups
      • Users
      • Sessions
        • Realm Sessions
        • Revocation
      • Events
        • Login Events
        • Admin Events
        • Config
      • Import
      • Export
    • Admin Manual
      • Creation of a Realm
      • Creation of a User
        • Login to Account Console
      • How to set up Password Invalidator
      • How to set up Password Policies
      • How to set up Brute Force Detection feature
      • How to enable the One-to-Many feature
      • How to set up Multi-Factor Authentication
        • Setup of ReCAPTCHA registration flow
        • Setup of ReCAPTCHA login flow
        • Setup of OTP Based Registration
        • Setup of OTP Based Login
        • Setup of QR Code Based Authentication
        • Setup of Push Notification Based Authentication
        • Setup of Biometric based Authentication
      • How to setup Session Invalidator feature
      • How to setup GDPR Compliant feature
      • How to set up Social Media login
      • How to setup Inactive User Tracking feature
      • How to setup Archive Inactive User feature
      • How to setup Delete Archived/Inactive User feature
Powered by GitBook
On this page
  1. User Manual - ZTrust V3.0
  2. Guide to Navigation

Realm Roles

PreviousClient ScopesNextUsers

Last updated 11 months ago

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

Click the Refresh button to see the latest settings.

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.

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.

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.

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

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

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.

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.

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.

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.

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

Selecting Add associated roles will display the following screen.

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

Click the Refresh button to see the latest settings.

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.

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

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

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

Click the Refresh button to see the latest settings.

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.

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