Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

typedescriptionoperational area
add_u2f_account'add user account to your Surepass accountuser management
validate_u2f_userauthenticate the user name and password of the userfirst step user authentication
add_u2f_deviceadd an additional u2f 2fa device to the user to an accountdevice management
delete_key delete a specific fido u2f security key from the users accountu2f key/origin management
delete_all_keysdelete all fido u2f security key from the users accountu2f key/origin management
validate_oath_otp validate a dynamic pass code send to the usersecond step user OTP authentication
send_oath_otpsend a dynamic pass code send to the usersecond step user authenticationOTP code request
pre_enrollperform the pre-enrollment process required to register a u2f key for an origin u2f key/origin managementregister step 1
enrollregister a u2f key for an origin u2f key/origin managementregister step 2
pre_signperform the pre-sign process to authenticate a u2f key for an origin u2f second authentication step user authentication1
'sign' authenticate a u2f key for an origin u2f second step user authentication step 2
'create_session_token' create a session token for a particular  usermobile device state management
'delete_session_token'delete a session token for a particular usermobile device state management
'is_session_token_valid' check to see if a session token is still valid for a particular usermobile device state management
'active_oath_device'activate an Oath devicedevice management
'sync_oath_device'synchronize clock for Oath HOTP/TOTP devicedevice management

 

A sample REST request body is a json request and looks like this:

 

Code Block
languagejs
firstline1
titleRest/Json Request Example - Send Pass Code via SMS
{ 
  "type": "send_oath_otp",
  "username": "Manny",
  "spAccountLoginName": "accountname", 
  "spAccountLoginKey": "accountkey",
  "deliveryMethod": "sms"
}  

...