# Users

<figure><img src="https://1778922777-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3EUK5AUZv0UVaI5S0CTM%2Fuploads%2FtreeHZDYpvzn7Ui5V3gf%2Fimage.png?alt=media&#x26;token=14287986-af56-4636-a70e-28f44598e10c" alt=""><figcaption></figcaption></figure>

Within the Users section, new users can be generated.

Additionally, you can view or modify various attributes associated with the user accounts.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXcC-C569PhXhOVklNESApoYxhQZzMOyNg28JfDs6fhwZgpYSN3hpuRsIq3BhNrqCeCmXKN6oIjUUaml3ReXy0pWtt28bi5W0rarQ9e2UXgDmQzvrhX7AN1JNgE98KuurpINT3coALtSs_7bGI4gSGF5g2MQq0ESI-eNhYcZPJVj2KcyfYDIViI?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

Select View All Users to see all the different Users created within this Realm.

#### **Unlock User**

If a user is temporarily locked, you have the ability to unlock all temporarily locked users by selecting Unlock User.

#### **Add User**

To generate a new user, click on Add User.

If you need guidance, refer to the steps mentioned under [Creation of a User](https://ztrust.gitbook.io/ztrust-documentation/user-manual-ztrust-v1.0/admin-manual/creation-of-a-user).

#### **ID**

It is generated automatically once a user is created.&#x20;

#### **Username**

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.

#### **Last Name**

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

#### **First Name**

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

#### **Actions**

This comprises the available actions that can be performed on a User Account, including Edit, Impersonate, or Delete action.

#### **Edit**

Clicking on Edit for a specific user allows for modification of the user details as needed.

#### **Impersonate**

Clicking on Impersonate allows you to log in as that user.&#x20;

If the user is in the same realm as yours, your current session will be logged out before logging in as that user.

#### **Delete**

The user can be deleted on clicking the Delete button.

Upon selecting Edit,  you will be directed to the screen below.

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

The Username, Email, First Name and Last Name can be edited or modified.

#### **Username**

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.

#### **User Enabled**

When enabled (toggled ON), the user can log in.

If disabled (turned OFF) for any particular user, login access is restricted for that user.

#### **Email Verified**

This is a toggle button. When enabled (toggled ON), it enables the verification of a user's email address. When disabled (toggled OFF), the user's email address is not verified.

#### **Required User Actions**

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXdvXEkZqAMmiO4L9xLyAV80VU0X9AX2WNcBmyn_SEfQBaRf67kvQDDyhRwzLr5r5iA2ePSj3WDLJ7GsKqDFS3pz_2HkwIrv5f-WZUrI7gmBJ6icnm0l7kg-W4P_ciV6jokU0TOUgUyjD8s92JOTXSEgIT5BOCgXNid8TI05ZR4IEu9oS57fDw?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

It includes the actions which the user needs to perform after logging in.

For example - verify Email sends an email to the user to verify their email address. Update Profile requires the user to update their profile.

#### **Impersonate User**

Clicking on Impersonate under Impersonate User allows you to log in as that user.&#x20;

If the user is in the same realm as yours, your current session will be logged out before logging in as that user.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXdLqcVOaQTaRuVK7yqtD9LfaKVM4kSLiITHyJ9NHJ1czOhYbTBnv_-6_S4vXFyVdSDdFuvkIt40GbpJSH-3gkE8SmOFE2piA7G5szilgVJcwSQnnppZU4pzrsiHFBYv6EsOG785oyCKeCdK1boe4QeKsUP0XwIimehYYI2A4UrwRsc5ipDP9as?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

In the Attributes section, various Attributes can be specified for a particular user.

For example - phone number has been defined for this user, as illustrated above.

#### **Key**

In the Key section, the variable or attribute is specified.

#### **Value**

The corresponding value for that specific attribute is entered in the Value field.

#### **Actions**

It involves actions to either Add any new attribute or Delete the attributes defined for that specific user.

#### **Add**

Once you have defined the Key-Value pair, click Add to save the changes.

#### **Delete**

To remove the Key-Value pair if it is no longer needed, click on Delete.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXeEeisYpW_u8ABYvqat-J0nwOkatmVP0Cky9V-y1jzOP9X73lReL05WmsaEAXUthYFdVRgVKJsfeQPW8jspPOXXLu6wd2kiP04Zb8kNKB7TtjETqk6EFvJKjS5B85ZAHek1WlKvjHYVko66DKlMGERoRdsE7XUMrloxLdHtV1IujuVZ-u04yw?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

In the Credentials tab, the administrator can set up the password for the user.&#x20;

Additionally, the Admin user has the ability to delete or reset the user's password.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXeDCp8Im3PdAJ3ZvTjQCL-8VpG4DfCuHkKgrbHRJrms5PpiJRaE0QOKkIOFpUkYbv_MEMs58cRXIwK0E8c640PzWK6q3lteN-yIGOOtIlctdAS28ye3sPeAAQJVyQaDajTlTnlzsZhq8J3nBIzplxcNyHMSZ8626VwkUI7I9MTETJ5nWb5Euw?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

In the Manage Credentials section, you can oversee and handle the various credentials associated with a user.

#### **Position**

You can adjust the priority of credentials by simply dragging and dropping rows through the arrow buttons.

The new sequence establishes the priority of the credentials assigned to that user.

The credential at the top holds the highest priority, determining its display order following a user's login.

#### **Type**

This indicates the type of credential, such as password or OTP (One-Time Password).

#### **User Label**

This refers to the label assigned by the user to identify the credential when presented as an option during login.

You can assign any value to it that aids in recognizing the credential.

#### **Data**

This represents the technical details of the credential, which are not confidential.&#x20;

By default, this information is hidden.&#x20;

You can reveal the data for a credential by clicking on Show data…&#x20;

Upon clicking on Show data…, you will be presented with a prompt containing the following details.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXfV59S-gQtbZim_2kztaTicGA7ByXQ7HUvoGm6A39MbBOGP2JWNf_Ww8iZRvTxcN-wUO-JpQntG93AW-GP-NRWAQT2DQwAgJvAeW6rcTmQOC4XFTHhFn6WXajF7b7rXmcJ_xEOrqdVGe7uGB07Z-J1KvEcSobLfoDC3w8OQPqRgWvM-bdW8iI0?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

#### **Algorithms**

These are mathematical functions that transform plaintext passwords into unique, fixed-size outputs known as hashes. These hashes are subsequently stored in databases.

#### **hashIterations**

It indicates how many times a password is hashed before being stored in the database.

#### **Actions**

This encompasses the available actions that can be performed on the credentials, including Delete or Save.

#### **Delete**

If the credentials are no longer needed, select Delete to remove them.

#### **Save**

If you've made some adjustments and wish to apply them, click on Save.

Upon clicking Delete, you will receive the following prompt, seeking confirmation:

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXcRiEc6JBS_CSK2Cq6WYshKJeS3ILkamUBwjqgs8w-ZuOubV6UATFmfeDfIMdi7tAJqUmi40OrPUlKuSDswZ3PxtVg-ibFTZ93LVrIjKg7sCtk193QJUaHYKNsV2TKm1u5oKaXsvp1M5V_tztWT7yI4Y0-MSQo5HWFykm0nCGnCxGJmXSlrdw?key=0ECnkWiuLUYSWNiFTVoEqA" alt="" width="375"><figcaption></figcaption></figure>

To proceed with deleting the specific set of credentials, select Delete. Otherwise, click Cancel to abort the operation.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXft3gTUiFyqDHBN5asSVz92c2aCPy2In8BPEg-9X7Tz1rklieP8OVeYh1Rg_hvcZ7ZJUhQwpxPW5qvp1oZ0IxWjL-evscXDogTfTCX4oVcO747C69WWl3x9llu9WE-fdfeBurROsbNJ06g1APGuFvujhbJtVWNunYVAijoEsn9A9QPcdR-cuxk?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

In the Reset Password section, the Admin user can reset the password for the user.

#### **Password**

In this tab, the Admin can configure the Password for the selected user.

#### **Password Confirmation**

The same Password must be entered again here to ensure accuracy in setting up the password.

#### **Temporary**

When enabled (toggled ON), the user is required to change the password upon the next login. When disabled (OFF), the user is not prompted to change the password on the next login but can do so at their convenience.

#### **Set Password**

As an Admin, when setting up a password for an end user and providing the necessary details as indicated above, you can save the password by clicking on Set Password.

Upon clicking Set Password, you will receive the following confirmation prompt:

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXcuhksvcQedrjVmMvWVSMlnnkVBZGg0nhLA3t0SBc_KSD6pK6HQZvFR55sME1UDdWhF4UR1Dde5yTkv6bkTHhD6GQfXr4Gt2f_g3b8PZiYn6m9mJgp8J1eDSbIRbIOxwTFn7FWQE7kaMuLyQT82Zt1ATs2EYrxFnojloyzKt3vksdYOXG2Ang?key=0ECnkWiuLUYSWNiFTVoEqA" alt="" width="375"><figcaption></figcaption></figure>

To proceed with resetting the password for the user, select Reset Password. Otherwise, click Cancel to abort the operation.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXcl2VtV3dEykhZC40rvS6980JcrMbunDHCApqVaX0Hkfh5V5OJaKo5z1p5P9Lln_dfVaeHxAdBJ5iVOHeXb8fhAPJGUBxwRzKjhJFMkLtn1-6eeX3OiTxIXakccs4hsiVMIiZIGQLyV3VIQQZjG_mw-D52_NnRyuQbbV9Rd4ogDx5EvRED_pw?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

#### **Realm Roles**

#### **Available Roles**

It lists all the Available Realm Roles that a user can be assigned to. It includes roles that are effectively designated but not explicitly assigned.

#### **Assigned Roles**

It consists of the Realm Roles that have already been assigned to the user.

#### **Effective Roles**

It encompasses all Realm Role Mappings.&#x20;

Certain roles may be derived from a mapped composite role.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXe1LLJPyj2MdO1Y26A3x-DMSSQdQehITgFarLNNmiqhoFxUWLxFGZjOO_D90Ab4eCM1rvo-xPNv4sR_wxn2tQ4NRlDRa4Yzk6ZsYjrqOcjaJCv4jY0xxCoqRAJ5sqHYKrDlhUdeUxgHhMffWKGorXecZX4hZpUMnIneN2u62v8K51MoHX61FEI?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

If you want to move any of the Available Roles to Assigned Roles, select the Role and click on Add Selected.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXeARa5sNP4PNxLo2zX0YttqZ_4EgSs55NasxnD4FS7A-871hzMN_sdeoEpD9lsEYW0okl0uIwaXkT4QyhJKtDfi6nynIURMjDbSJinUFGMsIVcGFNDtOtoXjaJoIOAv9pdml72uuXT0QAf0ptemDdxVa4ZL9-DJ3q7rgISNfnc_lPqpLz_L3yw?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

If you want to delete any of the Assigned Roles, select the Role and then click on Remove Selected.

#### **Client Roles**

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXexfQ8gR8CWvd1PxeluPoLcvUGP9AjrX_psIbp1BxunGhhaqSTStCMmHXzMjpLw1tqrGrJU4h8MXsK7BpK5B3ARsQiF0CZU4OKIGqgtXCQssimiJrXx-PBiDWHsKjOd6AFv8WNxCF-J4ozGmzdPmzJejDU85ZXfArDFs1SQ5tFKbutownIsPoU?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.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXfrZWEGjbTWznMtzzKU1E2lIXLKxMXwN-fxHM6daXERK7m3b6Vjg6dneGJN4OTdd1ljunZnxFG_-1LcQ6ZPgUdMN8RU8AOWzJs4ZqOllNsSpYmvGNrI-4oSqIlpEc_ObhIbTrSPKiBrrHr8fQUrogpdTod4mQI3RTR9tOEW9-4Ii2u9ypuMk6A?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

#### **Group Membership**

It includes Groups in which the user is a member.

#### **View All Groups**

If you want to see all the groups that the User belongs to, simply click on View All Groups.

#### **Leave**

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXdXif-W8879CjcRo4eJ0NJ8h2CpdzVXagPZZjKiZ5pYtfKGhZy82FWTQ6KnWU58XLcCphYP2bNCGQTvKrBDTnxh62O1pWyUWOKLlkqhLYvWQeabCFHn_hjUvBVC-v4NAh54NxYid0OGoGJ35LqeXCRDjlkquWEDoZIgV-FZ790THOJhWpttDyc?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

If you want to exit a specific Group of which the User is a member, select that particular group and click on Leave.

#### **Available Groups**

It includes all the groups that a User can join.

#### **View All Groups**

If you want to see all the Groups present within the Realm, which the User can join, click on View All Groups.

#### **Join**

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXdV7-riwMvZqq34NyhtPQQlz0JfYM94FSVRAU4KBzdEGZdhq7lT-TBFdCBF5k5QUkVUnagiV2MRCqy9lPKIdovYevZX5f-1W3S4vRWledNuo1N_okJCDdNIbKDK1EXLda9xWQXT0la42Nt8Dtftz6OLPwcnIBdUSEaa8WM3Olx-x2ZCvk297g?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

If you want the user to Join any specific Group, then select the Group Name and click on Join.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXeQYqB7HU6j6I1KVZfwVmVJiO7hrglqt4LfBeedsD2ol3GU5yqWU2WWWkC-Me3CkFiv_LhgyKTjyt2y9zZMxKyNaX7__tEHyjL76E9Mvl6A6e813OAsC6HpC9GLy8GLLhDTa8__scw-GU_oP3qfD_4G0Bs1zQy518G9oDUCmTcptFL824mT5jE?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

#### **Consents**

This tab provides information about the clients to which the user has granted consent to access, including the default client scopes and any additional client scopes granted.

#### **Client**

It designates the name of the client or the client ID.

#### **Granted Client Scopes**

It specifies the client scopes assigned to that specific client.

#### **Additional Grants**

It specifies any additional grants permitted for that particular client.

#### **Created**

It indicates the time period during which this was created.

#### **Last updated**

It specifies the time period during which it was last updated.

#### **Action**

It represents the activities or operations executed by the user specifically within the context of this client.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXd3N7AuRHM2vlpn6fdr4OWlSBWQ5Llgp4vInYfOuUHpNEXCUTM8syK2yI_6ETVt4p2o8tmnaI4FKLInhsTG-zrgxlSf1TTyOxNWBnLbLO4pSd7Yh4G-8tuhsxCsegUsmfZoIIpD2Ec7VOFnacdrgkJbWzmPWJihMTQy8kfPwBRt_Bzo_RizI0Y?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

#### **Sessions**

Under Sessions, the admin can view the clients where this user has an active session along with the following details for each session.

#### **IP Address**

It indicates the IP Address associated with the session.

#### **Started**

It indicates the time at which the session was initiated.

#### **Last Access**

It represents the timestamp indicating the last access time of the session.

#### **Clients**

It denotes the clients that were most recently accessed during this session.

#### **Actions**

It denotes the activities or actions carried out by the user within the session.

#### **Log out All sessions**

To sign out of all active sessions for this specific user, select the option Log Out All sessions.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXfgfeCBQKm5VfPRC9ndYS_LlRDui-edWNUGxENF7q_sZLDLOjJQnpoKcB_oW0a3nJpWZNpC_Fi59hytHFPj9t005rawNmfsXkFEBmAMIcGr4gqq-YL1CYdakMG7bj2ASDf6x9B8xHqfBwxW1KbTlaKGFUTQU2oLYGnAhwulwMEkRz0ykmk_2TQ?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

#### **Identity Provider Links**

This section enables users to connect their accounts with other providers.

#### **Create**

Upon clicking Create, you will be directed to the screen below.

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXfVMuTIfK72zKmgEdeNtj8hj5KbffAODNGzrOmom8RwAGvPMXtyb5s2N-JO6zbyiwEKae4WYJuXLtwnii7S2Nm3tRQKxbvm7B18yDR_Lm6qCoD3AdXZvgLy-Od8lv93Si5aYmzeHiyTXsWz8rkZ1j6ojxG4_dGR2Fy7QVcTWk3yYrX8KXw-ECs?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

#### **Identity Provider**

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXdOSFoAaV9t9JUwhYG-kretVrDr-BdIlCLhfdT7ppI-b9KQw5ZeBe1HNvh_KNYkxZcDACgGNAEw5gUofba66db5i4esvVs3RWq45NKrG3mWksrNUuShKBGP17Jg9E0XXKfjxoKUa_VMSgMxR8Z328WAy4b8PbDPqONceH4kIP8CiHvwSnL6l7Q?key=0ECnkWiuLUYSWNiFTVoEqA" alt=""><figcaption></figcaption></figure>

This indicates the selected Identity Provider from the dropdown menu during the creation of the Identity Provider link.

#### **Identity Provider User ID**

This indicates the distinct ID of the user on the Identity Provider's end.

#### **Identity Provider Username**

This pertains to the user's username as registered on the Identity Provider's platform.

#### **Save**

Once you've entered the aforementioned details, to preserve the linking of the identity provider, select Save.

#### **Reset**

If you prefer not to apply the modifications, select Reset to discard them.

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

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

#### **Identity Provider Alias**

It refers to the Identity Provider which was selected from the dropdown for Identity Provider while creating the Identity Provider link.

#### **Provider User ID**

This denotes the unique ID of the user within the Identity Provider's system.

It specifies the  Identity Provider User ID that was configured during the creation of the Identity Provider link.

#### **Provider Username**

This refers to the username of the user as recorded within the Identity Provider's system.

It details the Identity Provider Username set during the setup of the Identity Provider link.

#### **Actions**

This comprises the available actions for managing the Identity Provider link, such as Delete.

#### **Remove**

If you no longer wish to maintain the Identity Provider links, click on Remove.

Upon doing so, you'll receive a prompt below, seeking confirmation.&#x20;

<figure><img src="https://lh7-us.googleusercontent.com/docsz/AD_4nXcinb0d42BpuQHxMiWrorWFfMa4sq9WeagRo2r0cg4ZYGNJM_22AbWiJNLF5XpjiPQClQ1re9aeg6b3l2Ba08PccvpylPCctB2H0GAq0hK92xwB0IXULE00WLMg3hUN2Geywh_2huUCddyIo2RMPIS9eVSp9UNmZXIoEarhP4zmv2-Jn6yaBSk?key=0ECnkWiuLUYSWNiFTVoEqA" alt="" width="375"><figcaption></figcaption></figure>

Choose Delete to proceed with deleting the Identity Provider Link, or select Cancel to retain it.

<br>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ztrust.gitbook.io/ztrust-documentation/user-manual-ztrust-v1.0/guide-to-navigation/users.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.