...
type | description | operational area |
---|---|---|
add_u2f_account' | add user account to your Surepass account | user management |
validate_u2f_user | authenticate the user name and password of the user | first step user authentication |
add_u2f_device | add an additional u2f 2fa device to the user to an account | device management |
delete_key | delete a specific fido u2f security key from the users account | u2f key/origin management |
delete_all_keys | delete all fido u2f security key from the users account | u2f key/origin management |
validate_oath_otp | validate a dynamic pass code send to the user | second step user OTP authentication |
send_oath_otp | send a dynamic pass code send to the usersecond step user authentication | OTP code request |
pre_enroll | perform the pre-enrollment process required to register a u2f key for an origin | u2f key/origin managementregister step 1 |
enroll | register a u2f key for an origin | u2f key/origin managementregister step 2 |
pre_sign | perform 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 user | mobile device state management |
'delete_session_token' | delete a session token for a particular user | mobile device state management |
'is_session_token_valid' | check to see if a session token is still valid for a particular user | mobile device state management |
'active_oath_device' | activate an Oath device | device management |
'sync_oath_device' | synchronize clock for Oath HOTP/TOTP device | device management |
A sample REST request body is a json request and looks like this:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "type": "send_oath_otp", "username": "Manny", "spAccountLoginName": "accountname", "spAccountLoginKey": "accountkey", "deliveryMethod": "sms" } |
...