API Methods
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 user account with U2F device to your SurepassID installation | user management | /api/admin/user/create | |
add user account with OATH device to your SurepassID installation | user management | /api/admin/user/create | |
retrieve meta data about a user | user management | /api/admin/user/find | |
retrieve a list of users based on a set of search criteria | user management | /api/admin/user/find | |
delete a user from the system | user management | /api/admin/user/delete | |
update a user in the system | user management | /api/admin/user/update | |
add a user in the system | user management | /api/admin/user/create | |
add a U2F 2FA device to a user account | device management | /api/admin/token/create | |
add an OATH 2FA device to user account | device management | /api/admin/token/create | |
query user meta data/authenticate user name and password | user validation/authentication | /api/auth/authenticate-user | |
query device meta data by serial number | device management | /api/admin/token/find | |
assign a device to a user account | device management | /api/admin/token/assign | |
detach a device form a user account | device management | /api/admin/token/unassign | |
activate an OATH device | device management | /api/admin/token/activate | |
synchronize clock for OATH HOTP/TOTP device | device management | /api/admin/token/synchronize | |
validate a dynamic pass code send to the user | validate Oath OTP | /api/auth/otp/validate | |
validate cards security code (dCVx) | validate card security code | /api/auth/csc/validate | |
send a dynamic pass code send to the user | send Oath OTP | /api/auth/otp/request | |
push authentication request to the user | push authentication | /api/auth/otp/push | |
FIDO - pre-enroll U2F key for an origin | fido u2f register step 1 | /api/fido/u2f/register/request | |
FIDO - enroll a U2F key for an origin | fido u2f register step 2 | /api/fido/u2f/register/response | |
FIDO - pre-sign process U2F key for an origin | fide u2f authentication step 1 | /api/fido/u2f/sign/request | |
FIDO - authenticate a U2F key for an origin | fido u2f authentication step 2 | /api/fido/u2f/sign/response | |
FIDO - delete a specific U2F security key from the users account | fido u2f key/origin management | /api/fido/u2f/key/delete | |
FIDO - delete all U2F security keys from the users account | fido u2f key/origin management | /api/fido/u2f/key/delete | |
create a session token for a particular user | mobile device state management | /api/admin/user/session/create | |
expire (make unusable) a session token for a particular user | mobile device state management | /api/admin/user/session/expire | |
check to see if a session token is still valid for a particular user | mobile device state management | /api/admin/user/session/validate |