How to make an Auth request – Auth Armor

Endpoint(s):

SYNChronous: https://api.autharmor.com/v2/auth/request/async
ASYNChronous: https://api.autharmor.com/v2/auth/request

Method: POST

ASYNChronous vs SYNChronous:

Auth Armor supports two methods for requesting auth, both ASYNChornus and SYNChronous.

The ASYNChronous is an advanced way to use the API and supports multiple features. With ASYNC, the first call starts the auth request and you instantly get back a response. This response contains things like the QR code, visual verify values, an auth request ID and more. You then need to call a GET route that will return the status and information about your auth request, such as if it has timed out, been declined or it has been authorized and authenticated.
The SYNChronous method is much more simple, but supports less features. SYNChronous does not support QR codes, visual verify or usernameless features. When using the SYNChronous method, the API will hold the connection until there is a response. You can compare our SYNChronous method to HTTP long-polling. Once the user has approved or declined the request, or the request has timed out, the API will return the data.

We recommend using the ASYNC version of the API to get all features. Please be sure to checkout our SDKs and libraries that can help with the ASYNC methods and make integration a breeze.

JSON Body Payload Samples:

Requesting a push message:

Auth Armor supports sending a push message directly to your user. To do this, you must specify a nickname, then set the property send_push to true.

Requesting Targeted QR Code:

Auth Armor supports creating a QR code with each request. You can then choose to not send a push message, and only the user you have specified can scan the QR code.

Requesting usernameless QR code:

Auth Armor supports created a QR code that can be scanned by any user that is registered to the project. This is called a "Usernameless" QR code request. To do this, do not specify a nickname in the request. Usernameless requests do not work with push messages. Once a user has scanned and authenticated and authorized, the user nickname will be included in the response.

Make a request that sends a push message and includes lat/lon location data:

Make a request that sends a push message and includes ip data (this will get location from the ip address):

Make a request

{
  "nickname": "sample_user",
  "action_name": "Login",
  "short_msg": "Login pending - please authorize",
  "nonce": "some unique value of your choice here",
  "accepted_auth_methods": [
    {
      "name": "SecurityKey"      
    }
  ],
  "timeout_in_seconds": 60,
  "origin_location_data": {
    "latitude": "34.05349",
    "longitude": "-118.24532"
  }  
}

xxxxxxxxxx

{
  "nickname": "sample_user",
  "action_name": "Login",
  "short_msg": "Login pending - please authorize",
  "nonce": "some unique value of your choice here"
}

JSON body Example (advanced - Security Key Required):

xxxxxxxxxx

{
  "nickname": "sample_user",
  "action_name": "Login",
  "short_msg": "Login pending - please authorize",
  "nonce": "some unique value of your choice here",
  "accepted_auth_methods": [
    {
      "name": "SecurityKey"      
    }
  ],
  "timeout_in_seconds": 60,
  "origin_location_data": {
    "latitude": "34.05349",
    "longitude": "-118.24532"
  }  
}

JSON Body Example (advanced - Mobile Device with Biometric Required):

xxxxxxxxxx

{
  "nickname": "sample_user",
  "action_name": "Login",
  "short_msg": "Login pending - please authorize",
  "nonce": "some unique value of your choice here",
  "accepted_auth_methods": [
    {
      "name": "MobileDevice",
      "rules": [
        {
          "name": "ForceBiometric",
          "value": true
        }
      ]
    }