The API for requesting authentication services from the SurePassId Authentication Server. The following API functions are available.
add_u2f_account | add user account with U2F device to your SurepassID installation | user management |
add_oath_account | add user account with OATH device to your SurepassID installation | user management |
find_user | retrieve meta data about a user | user management |
find_users | retrieve a list of users based on a set of search criteria | user management |
delete_user | delete a user from the system | user management |
update_user | update a user in the system | user management |
add_user | add a user in the system | user management |
add_u2f_device | add a U2F 2FA device to a user account | device management |
add_oath_device | add an OATH 2FA device to user account | device management |
validate_user | query user meta data/authenticate user name and password | user validation/authentication |
find_device | query device meta data by serial number | device management |
assign_device | assign a device to a user account | device management |
unassign_device | detach a device form a user account | device management |
active_oath_device | activate an OATH device | device management |
sync_oath_device | synchronize clock for OATH HOTP/TOTP device | device management |
validate_oath_otp | validate a dynamic pass code send to the user | validate Oath OTP |
validate_csc | validate cards security code (dCVx) | validate card security code |
send_oath_otp | send a dynamic pass code send to the user | send Oath OTP |
push_oath_otp | push authentication request to the user | push authentication |
pre_enroll | FIDO - pre-enroll U2F key for an origin | fido u2f register step 1 |
enroll | FIDO - enroll a U2F key for an origin | fido u2f register step 2 |
pre_sign | FIDO - pre-sign process U2F key for an origin | fide u2f authentication step 1 |
sign | FIDO - authenticate a U2F key for an origin | fido u2f authentication step 2 |
delete_key | FIDO - delete a specific U2F security key from the users account | fido u2f key/origin management |
delete_all_keys | FIDO - delete all U2F security keys from the users account | fido u2f key/origin management |
create_session_token | create a session token for a particular user | mobile device state management |
expire_session_token | expire (make unusable) 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 |