Versions Compared

Key

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

The tThe API for requesting authentication services from the SurePassId Authentication Server. The following API functions are available.


API typeDescription
New MFA Server API Endpoint
add_u2f_accountadd user account with U2F device to your
SurepassId
SurepassID installationuser management/api/admin/user/create
add_oath_accountadd user account with
Oath
OATH device to your
SurepassId installationuser management
SurepassID installationuser management/api/admin/user/create
find_userretrieve meta data about a useruser management/api/admin/user/find
find_usersretrieve a list of users based on a set of search criteriauser management/api/admin/user/find
delete_userdelete a user from the systemuser management/api/admin/user/delete
update_userupdate a user in the systemuser management/api/admin/user/update
add_useradd a user in the systemuser management/api/admin/user/create
add_u2f_deviceadd a
u2f  2fa
U2F  2FA device to a user accountdevice management/api/admin/token/create
add_oath_deviceadd
an oath 2fa
an OATH 2FA device to user accountdevice management/api/admin/token/create
validate_userquery user meta data/authenticate user name and passworduser validation/authentication/api/auth/authenticate-user
find_devicequery device meta data by serial numberdevice management
delete_key delete a specific fido u2f security key from the users accountfido u2f key/origin managementdelete_all_keysdelete all fido u2f security key from the users accountfido u2f key/origin management
/api/admin/token/find
assign_deviceassign a device to a user accountdevice management/api/admin/token/assign
unassign_devicedetach a device form a user accountdevice management/api/admin/token/unassign
active_oath_deviceactivate an OATH devicedevice management/api/admin/token/activate
sync_oath_devicesynchronize clock for OATH HOTP/TOTP devicedevice management/api/admin/token/synchronize
validate_oath_otp validate a dynamic pass code send to the uservalidate Oath OTP/api/auth/otp/validate
validate_cscvalidate cards security code (dCVx)validate card security code/api/auth/csc/validate
send_oath_otpsend a dynamic pass code send to the usersend Oath OTP/api/auth/otp/request
push_oath_otppush authentication request to the userpush authentication/api/auth/otp/push
pre_enroll
fido
FIDO - pre-enroll
u2f
U2F key for an origin fido u2f register step 1/api/fido/u2f/register/request
enroll
fido
FIDO - enroll a
u2f
U2F key for an origin fido u2f register step 2/api/fido/u2f/register/response
pre_sign
fido
FIDO - pre-sign
process u2f
process U2F key for an origin fide u2f authentication step 1/api/fido/u2f/sign/request
sign
fido
FIDO - authenticate a
u2f sync_oath_devicesynchronize clock for Oath HOTP/TOTP devicedevice management
U2F 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 accountfido u2f key/origin management/api/fido/u2f/key/delete
delete_all_keysFIDO - delete all U2F security keys from the users accountfido u2f key/origin management/api/fido/u2f/key/delete
create_session_token create a session token for a particular  usermobile device state management/api/admin/user/session/create
expire_session_tokenexpire (make unusable) a session token for a particular usermobile 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 usermobile device state management
active_oath_deviceactivate an Oath devicedevice management
/api/admin/user/session/validate