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