Token2 TOTPRadius appliance Web API
Token2 API is a RESTful API for enabling two-factor authentication of users of a website or a web application. To start using Token2 TOTPRadius appliance Web API, you will need to have the TOTPRadius appliance installed and reachable. This API uses keys that can be set on TOTPRadius admin panel. The web API is implemented for TOTPRadius appliance v0.2.1 and above.
Create a user
http[s]://totpradius_appliance_ip/createuser?api_key
=[api_key]&phone
=[mobile_phone]&type
=[authentication type]&pin
=[pin code]&format
=[response format]
This API call requires the following arguments to be provided:
api
- the API key for the website. Can be obtained or set in the admin panel of the appliancephone
- the mobile phone number of the user in e.164 format.email
- User's email addresstype
- Authentication type to be used. Following values are possible: 0 - mobile application only (default). There is no other options for TOTPRadius appliance Web API . Kept for backward compatibility with Token2 Cloud API.pin
- PIN code, not required for TOTPRadius appliance Web API. Kept for backward compatibility with Token2 Cloud API.format
- format of the response data. Values: 1- json, 2- xml, 3- simplified plain text (true or false, no details or description), 0- serialized data (default)
This call return the following data upon successful execution:
response
- result's description (e.g. "user created")userid
- user's unique ID. This ID will need to be stored and associated with your local user database. User ID is required to validate/generate/send OTP codessuccess
- returns "true" if the user was successfully created and assigned a unique Token2 IDhash
- User's secret key to be added to the Token2 Mobile Application or any other TOTP Mobile applicationhashqr
- QR Code image URL of user's secret key to be scanned using Token2 Mobile Application
Validate an OTP
API call to validate an OTP password provided by user.http[s]://totpradius_appliance_ip/validate?api_key
=[api key]&token
=[OTP]&userid
=[User's Token2 ID]&format
=[response format]
This API call requires the following arguments to be provided:
api
- the API key for the website.userid
- User's Token2 ID.token
- OTP to be verifiedformat
- format of the response data. Values: 1- json, 2- xml, 3- simplified plain text (true or false, no details or description), 0- serialized data (default)
This call return the following data upon successful execution:
response
- result's description in English (e.g. "OTP generated and sent by SMS")userid
- User's Token2 IDvalidation
- returns "true" if OTP provided via API is valid, or "false" if not valid. Use this value to check if a user should be authenticated.
List current users
[this API call is available from v0.2.8 ]
http[s]://totpradius_appliance_ip/validate?api_key
=[api key]&actionlistusers
This API returns the list of current users in JSON format only, containing the userid, username and the registration timestamp
About
Installation and configuration
- Installation and initial configuration
- Network configuration
- Migrating from older versions
- LDAP Configuration
- Azure AD Configuration
- Self-service enrollment portal
- Web and LDAPS Certificates
- Syslog configuration
- Single-factor authentication exceptions
- Slave appliance mode
- Dynamic RADIUS Attributes
Integration guides
Blog
18-08-2023
Introducing the New Python-Powered TOTP tool for Token2 FIDO2 Security Keys!
Manage and use TOTP/HOTP codes via Python CLI script using a PC/SC device (USB NFC) or directly via USB. A cross-platform solution that works under Windows, macOS and Linux platforms.
Python-based tools are essential not only for their cross-platform compatibility, but also because their source-available nature allows experts/developers to examine the source code, ensuring transparency and minimizing the risk of hidden vulnerabilities or malicious elements. A GUI wrapper for the script is also available.
23-06-2023
Mass Production of Token2's PIN+ Series: Enhanced FIDO2 Security Keys
Token2 is excited to announce the upcoming mass production of their revolutionary PIN+ series, a line of FIDO2 Security keys. These security keys feature advanced PIN complexity rules that set a new standard for security. The firmware development for the PIN+ series is now complete, and the company is currently making preparations for mass production.
08-06-2023
Azure AD Now Supports FIDO2 Security Keys on Safari on iOS
In a significant development for iOS users, Microsoft Azure Active Directory (AD) has expanded its support for FIDO2 security keys on the Safari browser. This advancement is a crucial step towards enhancing security and usability on Apple's mobile devices, ensuring seamless authentication experiences for Azure AD users. With FIDO2 security keys, users can now enjoy passwordless access to their Azure AD accounts, boosting convenience and significantly reducing the risk of password-related attacks. Let's dive deeper into this exciting development and explore the benefits it brings to iOS users.