--- title: "User Enrollment" slug: "user-enrollment" updated: 2025-05-15T11:58:21Z published: 2025-05-15T11:58:21Z canonical: "docs.authx.com/user-enrollment" stale: true --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.authx.com/llms.txt > Use this file to discover all available pages before exploring further. # User Enrollment ## Comprehensive Guide to User Enrollment, Authentication, and Phone Management **Content List** - [Overview](/v1/docs/user-enrollment#overview) - [User Enrollment Page](/v1/docs/user-enrollment#user-enrollment-page) - [Edit User Enrollment](/v1/docs/user-enrollment#edit-user-enrollment) - [Delete Phone](/v1/docs/user-enrollment#delete-phone) - [Activate Phone Now](/v1/docs/user-enrollment#activate-phone-now) - [Send Enrollment Message](/v1/docs/user-enrollment#send-enrollment-message) - [Authentication Factors](/v1/docs/user-enrollment#authentication-factors) - [RFID Authentication](/v1/docs/user-enrollment#rfid-authentication) - [Fingerprint Authentication](/v1/docs/user-enrollment#fingerprint-authentication) - [Software Token Authentication](/v1/docs/user-enrollment#software-token-authentication) - [Hardware Token Authentication](/v1/docs/user-enrollment#hardware-token-authentication) - [Face Authentication](/v1/docs/user-enrollment#face-authentication) - [Pin Authentication](/v1/docs/user-enrollment#pin-authentication) - [YubiKey](/v1/docs/user-enrollment#yubikey) - [PassKey](/v1/docs/user-enrollment#passkey) - [In Cloud User Enrollment Workflow](/v1/docs/user-enrollment#in-cloud-user-enrollment-workflow)[](/v1/docs/user-enrollment#incloud-user-enrollment-workflow) --- ### Overview This comprehensive guide provides detailed processes involved in user enrollment, authentication, and phone management within the AuthX User Portal. It covers various enrollment methods, including manual and in-cloud workflows, where users can register and verify their accounts through phone number activation, RFID, fingerprint, face, and PIN authentication. The guide also explains the steps for phone enrollment and activation and the user interface for authentication factors like software tokens, hardware tokens, and YubiKey. Overall, it outlines the complete procedure for setting up, authenticating, and managing user devices securely within the platform. --- ### User Enrollment Page ![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202024-11-11%20161912.png) ### ![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202025-04-28%20113218.png) --- ### Edit User Enrollment - You can only edit the Username, which will also change the Primary Username. - You cannot add or remove assigned Groups. - A user can edit and update their phone number but cannot update the device. Only the admin can update both the phone number and the device. --- ### Delete Phone ![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202025-02-18%20124717.png) #### NoteYou can only delete the phone numbers of **In-Cloud** users. 1. To delete a user’s phone, click **Delete** on the **Enrollment** page. Navigate to the **Phones** section → **Action** ellipsis menu → **Delete**. 2. In the "Are You Sure?" pop-up window, click **Yes, Delete It!** to confirm the deletion. 3. When you delete the phone, the following occurs: 1. The registered user receives a **Phone Number Deleted** email. 2. The phone's status changes from **Active** to **Inactive**. 3. The Action menu displays the following three options in addition to Edit Phone Number: 1. **Active Phone Now** 2. **Send Enrollment Email** 3. **Send Enrollment Message![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202025-02-18%20125726(1).png)** --- ### Activate Phone Now This option allows the user to activate the phone number in the system. A pop-up displays a QR Code, which users can scan to verify and activate their phones in the AuthX Mobile App.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202025-02-18%20143439(1).png) --- ### Send Enrollment Email 1. You may click **Send Enrollment Email** to send yourself an activation email for your phone. 2. In the **Enroll New Phone**, click on the **Activation Link**. ![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202024-11-11%20162917.png) 3. In the **Install** and **Activate** window, the user scans the **QR Code,** or clicks **Generate OTP**. - For the **QR Code Option**: After scanning the QR Code, a green check mark will appear, indicating that the user is set up in the AuthX App.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202025-02-18%20133344(1).png) - For the **Generate OTP Option**: The user receives a **One-Time Passcode (OTP)** on the phone number provided during registration. Once the OTP is entered, the user is set up in the AuthX App.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202025-02-18%20133500.png) 4. Click **Continue**, and you will be redirected to the **Confirm Your Identity** page, where you can log in using any Authentication Factor.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202025-01-15%20163020(3).png) --- ### **Send Enrollment Message** This option sends a message to the user's phone containing an enrollment link to complete the enrollment process through the AuthX Mobile App. --- ### Authentication Factors #### ### RFID Authentication 1. Connect your RFID reader to your system and click **Add RFID** to enroll the RFID card.**![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/u16.png)** 2. Place your card on the reader.**![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/rf5(1).png)** 3. The added RFID Card detail is displayed. ![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/RFID%20Card%20-%20Active%20RFID%20Card.jpg) --- ### Fingerprint Authentication 1. Connect the biometric device to your system. On the **Enrollment Page**, scroll down to the **Fingerprint ID** section and click **Add Fingerprint** **on Computer**.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/u3.png) 2. Select any finger and **Enroll** it.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202025-01-15%20151130(2).png) 3. Enroll the selected finger from the Biometric device.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/image%20(17)(2)(3).png) 4. Click **Finish** to save your enrolled fingers.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/image%20(18)(2)(3).png) 5. The biometric is successful, and details are displayed.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/image%20(19)(3)(3).png) --- ### Software Token Authentication 1. Download **VIP Access** on your phone device. 2. On the **Enrollment** page of the AuthX portal, scroll down to the **Software Token** and click **Add Software Token**.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/sw2.png) 3. Under the **Add Software Token** window, enter the **Device ID** and **TOTP** from the downloaded **VIP Access**.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/sw1.png) 4. A pop-up message is displayed confirming the detailed saved.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/sw3.png) 5. The enrolled **Software Token** detail is displayed.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/sw4.png) --- ### Hardware Token Authentication 1. Under the **Add Hardware Token** window, enter the **Device Type** and **Device ID**.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/u14(4).png) 2. On the **Enrollment** screen, scroll down and click **Add Hardware Token.** **![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/u15.png)** 3. Select your device from the **Device ID** drop-down menu in the Hardware Token window and enter your **TOTP**. 4. A pop-up confirming the enrollment is displayed.****![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/hw13.png)**** 5. The added details are displayed under the Hardware Token.****![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/hw15.png)**** --- ### Face Authentication NoteContact the **AuthX Support** team to enable **Face Authentication**. You may enroll your face either on a computer or via the AuthX Mobile Vault App. #### Add Face on Computer 1. Click **Add Face on Computer.****![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/u4.png)** 2. Look at the camera and keep your face in the grid to enroll.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/u5.png) 3. Click **Continue** to approve your picture and enroll your face.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/u6.png) > --- #### Add Face on Mobile 1. Click **Add Face on Mobile.****![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/u7.png)** 2. You will receive a notification on your mobile device — tap **A****pprove**.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/user%20face%20enroll.png) 3. Keep your face in the grid to enroll. 4. Click **Continue** to approve your picture and enroll your face. #### --- ### Pin Authentication 1. Click **Add Pin.****![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/u8.png)** 2. Enter a 6-digit PIN and click **Save**.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/u9.png) > NoteOnce you add your Pin, you can change or deactivate it if needed. - **Change** **Pin**: In the **Pin Enrollment** action menu, click **Change Pin**. - **Deactivate**/**Activate**: In the **Pin Enrollment** action menu, click **Deactivate**/**Activate**.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/u10.png) --- ### YubiKey 1. Insert the Yubikey into the USB port. 2. Click on **Add Yubikey.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/y.png)** 3. Press the **button** on your YubiKey.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/y1.png) 4. Once the enrollment is completed, you will see the success message as **Device is mapped to the user**.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/y2.png) NoteIf the **YubiKey** is already assigned to any of the users within the account, the following message will be displayed:![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/y3(1).png)  --- #### ![image-20240612-113440.png](blob:https://certifyglobal.atlassian.net/2e4d1212-7ef2-4896-b81e-90cfcd0c9ab7#media-blob-url=true&id=819ecb69-5041-433a-8a30-6f26e648c6ae&collection=contentId-824672368&contextId=824672368&mimeType=image%2Fpng&name=image-20240612-113440.png&size=6950&width=417&height=207&alt=image-20240612-113440.png)![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/y3.png) ### PassKey 1. Click on **Add Passkey**. A popup will appear, prompting you to select your device. ![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202025-03-10%20131643.png) 2. **Turn on Bluetooth** on your system or enable it directly from the popup.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202025-03-10%20131701(1).png) 3. Scan the **QR code** displayed on the popup from your device.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202025-03-10%20131725(1).png) 4. The registered Passkey is securely saved for future use, allowing you to log in to the portal using the device without needing to re-enter credentials.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202025-03-10%20131848.png) 5. After successfully registering the Passkey, a confirmation popup will be displayed to notify you of the successful registration. ![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202025-03-10%20131857(1).png) --- ### In Cloud User Enrollment Workflow The following are steps for users added manually to enroll in AuthX: 1. The user receives an **E****nrollment Email** in their mailbox.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202024-11-11%20123929(3).png) 2. When the user clicks on the **E****nrollment Link** in the email, they are directed to the AuthX Portal. 3. On the following **Create a Password** page, set up your password by following the rules in the "Info Icon" next to the textbox. Then, click **Continue**. ![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202024-11-11%20143226(1).png) 4. In the following **Enter Your Mobile Number** window, the user enters their **Phone Number** and clicks **Continue**.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Enter%20Your%20Mobile%20Number(6)(2).jpg) 5. In the following **Install** and **Activate** window, the user activates their account by scanning the **QR Code** or clicking **Generate OTP**. They must download the **AuthX App** from the [**App Store (iOS)**](https://apps.apple.com/us/app/authx/id1434071312) or [**Play Store (Android)**](https://play.google.com/store/apps/details?id=com.authx.security&hl=en_IN&gl=US). ![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202025-02-18%20143439(3).png) - For the **QR Code Option**: A green check mark will appear after scanning the QR code. This lets them know they are set up in the AuthX App.![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/QR%20Code%20with%20Check(5).jpg) - For the **Generate OTP Option, the user receives** a One-Time Passcode on the Phone Number provided during registration. Once they enter the OTP, they are set up in the AuthX App. ![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Generate%20OTP%20Method(1).jpg) 6. On the following **Confirm Your Identity** page, the user clicks the **Push** or **Phone** option to log in to the **Dashboard**. ![](https://cdn.document360.io/ff6b0d12-ffa4-4d40-b8c9-0ed75ec11cce/Images/Documentation/Screenshot%202025-01-15%20162419.png) ---