Validate OTP Authentication API Guide
Introduction
Use this guide to enable the SecureAuth Authentication API to validate generated one-time passcodes (OTPs) via the /otp/validate POST endpoint.
After the /auth endpoint is called and an OTP is generated, the passcode is stored in the designated IdP property and then validated at this endpoint.
Prerequisites
1. Complete the steps in the Authentication API guide.
2. Configure the realm on the SecureAuth IdP v9.1 or later Web Admin, per the SecureAuth IdP Web Admin Configuration Steps below.
SecureAuth IdP Web Admin Configuration Steps
Data
 |
1. In the Profile Fields section, map a Field to a Property to be used for the OTP validation.
Warning
Click Save once the configurations have been completed and before leaving the Data page to avoid losing changes.
Multi-Factor Methods
 |
2. In the Multi-Factor Configuration section, enable at least one OTP option:
One-time Passcode via Phone Call
One-time Passcode via SMS
One-time Passcode via Email
Warning
Click Save once the configurations have been completed and before leaving the Multi-Factor Methods page to avoid losing changes.
System Info
 |
3. In the Links section, select Click to edit Web Config File.
Web Config Editor
 |
4. Search for <appSettings>, and add the following line of code in the App Settings section, replacing <SecureAuth IdP Profile Property> with the property mapped to the directory attribute that contains the OTP information:
<add key="OTPFieldMapping" value="<SecureAuth IdP Profile Property>" />
Warning
Click Save once the configurations have been completed and before leaving the Web Config Editor page to avoid losing changes.
Endpoint
HTTP Method | Endpoint10 | Example |
|---|---|---|
POST | /api/v1/otp/validate | https://secureauth.company.com/secureauth2/api/v1/otp/validate |