API Methods

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
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
delete_key	fido - delete a specific fido u2f security key from the users account	fido u2f key/origin management
delete_all_keys	fido - delete all fido u2f security key from the users account	fido u2f key/origin management
validate_oath_otp	validate a dynamic pass code send to the user	validate Oath OTP
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
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
active_oath_device	activate an Oath device	device management
sync_oath_device	synchronize clock for Oath HOTP/TOTP device	device management