Inviting and Adding users

Tip: Invite yourself!

You can invite yourself to your project once you create it. This will let you send yourself push auth requests using your own project and test out the system easily. To invite yourself, simple create an invite and scan the QR code using the Auth Armor Authenticator

Nicknames

A nickname is required when adding users. The nickname is the unique value that identifies your user. It is recommended you set this to your unique user identifier in your system, such as a username or email address. When sending auth requests, you will need to provide the nickname of the user.

Reference ID

You can also set an optional reference ID for with your invite. This reference ID is just for reference. 

QR Codes

QR Codes are familiar and common place many today. Auth Armor supports the same idea. The Auth Armor authenticator app can scan invite QR codes that will then instruct the user how to enroll their device to your project. Our QR codes are supported by the camera app in the mobile device, or can be scanned directly from the app. When generating an invite from the API, a field called "qr_code_data" will be returned and this is the data you should use to generate a QR code. 

Creating Invites

Using the Dashboard

You can easily generate an invite from the developer dashboard. This requires no code and you can get started right away. To add a user, first login to the dashboard and select your project. Be sure you are using consumer edition.

Next, click the "Invite User" tile. This will open a modal window that will ask for a nickname and reference_id (optional)

After entering the nickname and optional reference_id, click "Generate Invite" - this will then show a QR code on the screen. You can scan this directly, or copy the QR code invite image and send/share how you see fit. 

Using the API

The other way to add users to your project is using the API. This method is more flexible and can be programmed into your project for automation. To generate an invite via the API, you'll first need to generate some API credentials so you can access the API. You can learn more about working the API by viewing this article: Connecting to the Auth Anywhere API

Properties:

reset_and_reinvite

In the event you need to re-invite a user, such as the user has lost access to the app, or some other reason, you can set the "reset_and_reinvite" flag. This will generate a brand-new invite for this user. This would be used in place of a "forgot your password?" - as there are no passwords with Auth Armor, this is the way you would reset a user.

revoke_previous_invites

You can create set this flag to true, and this will revoke all previous invites that have not yet been accepted and generate a new invite. 

Additional Info:

The Auth Armor API also supports viewing invites for a user, revoke a specific invite, and getting invite information by the invite code. Below are some more articles you might find useful: 

• Connecting to the Auth Anywhere API