Realm Roles

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.

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

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.

When enabled, the corresponding settings will also become available.

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.

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

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

Client Roles

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.

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.

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.

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.

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.

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.

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

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.

When enabled, the corresponding settings will also become available.

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.

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

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

Client Roles

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.

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.

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.

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.

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