Json Body Example:
- nickname - Required
A unique Nickname for your user to easily identify. You will use this value to send auth requests to this user. A Nickname can have whitespace, numbers, letter, symbols and punctuation. A nickname can not have control characters.
- reference_id - Optional
An Optional value you can set to refer to later, such as an internal database id.
- full_reset - Optional
An Optional value you can set to reset and re-invite a user. When you set this to true, the system will remove all enrollments and linked devices and un-associate the user that is currently linked to the invite, then a new invite will be created. If no user is associated (the user/invite is in a pending state), then the existing pending invite will be invalidated and a new invite will be created. This should only be used if you have lost the existing invite, or, if the user account needs to be reset and re-invited due to some other issue.
- revoke_previous_invites - Optional
An optional value you can set to revoke all previous invites when generating a new invite. By default, un-used invites are valid until revoked or the account has been setup.
Echoing back this value from the request
Auth Armor ID for this profile - you can choose to store if you'd like but it is not required
This is the unique invite code for this invite
The UTC date/time when the invite expires. Invites are valid for 24 hours after creation
The type of invite this can be used for. Currently, all invites are valid for both QR codes and invite links
This value helps prevent abuse and is required in both QR codes and invite links
Creating a QR code invite
To create a QR code that the app can scan, you need to create a JSON object like the following:
Convert this JSON text to a QR code, like the following:
Creating an Invite Link
You can also use an invite link instead of a QR code. An invite can be created using this format:
Example with the values populated:
An invite link is a different way to get users invited. There is no difference in how a user gets invited, the invite link and QR code will both do the same thing in the end.
The Invite Link and QR code work with our client SDK and will assist even further in the user experience to ensure a smooth invite process. You can check out the client SDK here: https://github.com/AuthArmor/autharmor-jsclient-sdk