Inviting users to your project is simple, quick and easy. There are several ways you can invite users giving you flexibility in how you would like to implement flows for your integration.
Some useful tips
Workforce vs Consumer
This article is specifically for the Workforce edition of Auth Anywhere.
Adding users works differently in Workforce edition than is does in Consumer edition.
With Workforce edition, you are adding a user for your entire organization. This means you just need to invite your users once, then you can assign different projects to that user, without having to enroll again.
Consumer edition does not work like this - each project has it's own unique collection of users.
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, something that will not and can not change. Auth Armor recommends using the username of your user to make things simple. When sending an auth request, you will have to provide the nickname of the user you want to send the request to.
Reference ID
You can also set an optional reference ID for with your invite. This reference ID is just for reference.
Invite Methods
QR Code Invite
QR Codes are familiar and common place for 2FA/MFA apps today. Auth Armor supports that 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.
Invite Generation
Invite via the Dashboard
The easiest way to invite a user is using the developer dashboard. This method requires no code and you can get started right away. In the dashboard, select your project, then select Manage Users. On this screen, you will see all your users for your project, including an Invite User tile. Click the invite user tile and you'll be asked for some information. You need to provide a nickname here. After you click the submit button, an invite will be generated and you will be presented with all the invite details, including an invite link and a QR code that can be scanned.
Invite via the API
The other way to generate invites 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 to use. You can learn more about working the API by viewing these articles
Re-Inviting Users
In the event you need to re-invite a user, you can do so using the dashboard or the API. Using the API, there is a flag you can set called "reset_and_reinvite". On the dashboard, there is a button when viewing the user that will allow you to Reset and Reinvite.
If the user is in a Pending Invite status, then the current invite will be invalidated and a new invite will be created.
If the user is in an Active status, then all current enrollments will be removed, all devices linked to the profile will be removed, and the Auth Armor user will be un-associated to the profile. Re-Inviting an active user should only be done if the user is unable to access his or her account and you need to manually re-invite the user. History will remain on the account.
In closing
Now you know more about inviting users to your project. Below are some additional articles you may be interested in.
Comments
0 comments
Please sign in to leave a comment.