HomeBlog

Auth Armor Authenticator App

Suggest Edits

How Auth Armor Authenticator Registration works

2000

Registering users to use the Auth Armor Authenticator involves scanning an invite QR code using a smartphone.
When calling the API to register a user, QR code data will be returned to your calling application. You must take this QR code data and render a QR code image using your method of choice.

There are a few flows that are possible for the end users:

  • The user already has the Auth Armor Authenticator app installed on their smartphone
  • The user does not have the Auth Armor Authenticator app install in their smartphone

User already has the app installed

If the user already has the app installed, then when the user scans the QR code, using either the camera app built into the device, or using the scan QR code feature in the app, the app will automatically detect this request and start the enrollment process on the users device.

User has not yet installed the app

If the user does not have the app installed yet, then when the user scans the QR code with the camera app built into the device, a website will open asking the user to download the app. Once the user has clicked the "Download app" button, the user will be redirected to the appropriate app store depending on the device they are using. After downloading the app and opening for the first time, the app will automatically setup and enroll the user to your project.

In both cases, after a successful registration, the enrollment status for the user will be updated.

New User Registration

API Reference: https://docs.autharmor.com/reference/post_v3-users-register-authenticator-start

NOTE: - This is for new user registration only. For enrolling an existing user, see below.
Simply call the start register route for the Auth Armor Authenticator. This will return a user_id and qr_code_data
Take the QR code data and render a QR code that can be scanned by mobile devices.

Existing User Enrollment

NOTE: This is only for users who are already registered for another auth method, such as WebAuthn or Magiclink Emails, and are NOT yet registered for using the Auth Armor Authenticator.

API Route: /v3/users/{user_id}/authenticator/register/start

Simply call the API route and provide the user_id of the user you wish to add Auth Armor Authenticator to. This will return qr_code_data that you need to render into a QR code that scan be scanned by mobile devices.

Get Status of User Registration

API Route: /v3/users/{user_id}

Simply call the get user info route with the user_id that was provided via the return data when calling start user registration.

If the user was registered, user information will be returned. If the user successfully enrolled and registered using the Auth Armor authenticator, the enrolled method will also be returned.

See example below:

{
    "enrolled_auth_methods": [       
        {
            "auth_method_name": "AuthArmorAuthenticator",
            "auth_method_id": 4,
            "auth_method_masked_info": "Pixel 6 Pro"
        }
    ],
    "user_id": "9807bd11-ff99-4c33-a9b8-abf3346a60d3",
    "email_address": "",
    "username": "user24601",
    "date_created": "2022-07-16T18:03:23.993"
}

Updated 8 months ago