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.

Learn more about how our platform was built click here

User Enrollment

Prev Next

Comprehensive Guide to User Enrollment, Authentication, and Phone Management

Content List


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



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

Note
You 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

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.


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.
  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. 
    • 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.
  4. Click Continue, and you will be redirected to the Confirm Your Identity page, where you can log in using any Authentication Factor.

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.
  2. Place your card on the reader.


  3. The added RFID Card detail is displayed.


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.
  2. Select any finger and Enroll it.
  3. Enroll the selected finger from the Biometric device.
  4. Click Finish to save your enrolled fingers.
  5. The biometric is successful, and details are displayed.

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.
  3.  Under the Add Software Token window, enter the Device ID and TOTP from the downloaded VIP Access.
  4. A pop-up message is displayed confirming the detailed saved.
  5. The enrolled Software Token detail is displayed.

Hardware Token Authentication

  1. Under the Add Hardware Token window, enter the Device Type and Device ID.
  2. On the Enrollment screen, scroll down and click Add Hardware Token.
  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.
  5. The added details are displayed under the Hardware Token.


Face Authentication

Note
Contact 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.


  2. Look at the camera and keep your face in the grid to enroll.
  3. Click Continue to approve your picture and enroll your face.


Add Face on Mobile

  1. Click Add Face on Mobile.


  2. You will receive a notification on your mobile device — tap Approve.
  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.


  2. Enter a 6-digit PIN and click Save.

Note
Once 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. 

YubiKey 

  1. Insert the Yubikey into the USB port.
  2. Click on Add Yubikey.
  3. Press the button on your YubiKey.
  4. Once the enrollment is completed, you will see the success message as Device is mapped to the user.
Note
If the YubiKey is already assigned to any of the users within the account, the following message will be displayed:
 

image-20240612-113440.png

PassKey

  1. Click on Add Passkey. A popup will appear, prompting you to select your device. 
  2. Turn on Bluetooth on your system or enable it directly from the popup.
  3. Scan the QR code displayed on the popup from your device.
  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.
  5. After successfully registering the Passkey, a confirmation popup will be displayed to notify you of the successful registration. 

In Cloud User Enrollment Workflow

The following are steps for users added manually to enroll in AuthX:

  1. The user receives an Enrollment Email in their mailbox.
  2. When the user clicks on the Enrollment 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
  4. In the following Enter Your Mobile Number window, the user enters their Phone Number and clicks Continue.
  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) or Play Store (Android).


    • 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.
    • 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.
  6. On the following Confirm Your Identity page, the user clicks the Push or Phone option to log in to the Dashboard.