Versions Compared

Key

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

...

  • 'type' – The type of request to be  performed  by the server.  The following types are supported.
  • 'username' – The username (or token for the user) that this action is to be performed on.
  • 'spAccountLoginName'  – Your SurePassId server account name
  • 'spAccountLoginKey' – Your SurePassId server account  key

 

The system supports the following 'type's are allowed:

...

request types:

 

 

typedescriptionoperational 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 device to the user accountdevice 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 accountu2f key/origin management

...

validate_oath_otp

...

validate a dynamic pass code send to the

...

usersecond step user authentication
send_oath_otp

...

send a dynamic pass code send to the

...

usersecond step user authentication
pre_enroll

...

perform the pre-

...

enrollment process required to register

...

a u2f

...

key for an origin u2f key/origin management
enrollregister a u2f key for an origin u2f key/origin management
pre_signperform the pre-

...

sign process

...

to authenticate a u2f key for an origin u2f second step user authentication
'sign' authenticate a u2f key for an origin u2f second step user authentication
'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

 

 

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"
}  

...