Frontend Driver Interface

These are the APIs exposed by our backend SDK. To be consumed by the frontend only. {tenantId} in all the APIs are optional. Its default value is public

MultiFactorAuth Recipe

• PUT
  Get MFA factors information/{apiBasePath}/mfa/info

TOTP Recipe

• GET
  List TOTP devices/{apiBasePath}/totp/device/list
• POST
  Create TOTP device/{apiBasePath}/totp/device
• POST
  Remove TOTP device/{apiBasePath}/totp/device/remove
• POST
  Verify TOTP device/{apiBasePath}/totp/device/verify
• POST
  Verify TOTP code/{apiBasePath}/totp/verify

Passwordless Recipe

• POST
  Start passwordless sign in/up/{apiBasePath}/{tenantId}/signinup/code
• POST
  Resend passwordless code/{apiBasePath}/{tenantId}/signinup/code/resend
• POST
  Complete passwordless sign in/up/{apiBasePath}/{tenantId}/signinup/code/consume
• GET
  Check email exists (deprecated)/{apiBasePath}/{tenantId}/signup/email/exists⠀⠀
• GET
  Check email exists/{apiBasePath}/{tenantId}/passwordless/email/exists
• GET
  Check phone exists (deprecated)/{apiBasePath}/{tenantId}/signup/phoneNumber/exists
• GET
  Check phone exists/{apiBasePath}/{tenantId}/passwordless/phoneNumber/exists

Session Recipe

• POST
  Sign out user/{apiBasePath}/signout
• POST
  Refresh user session/{apiBasePath}/session/refresh

EmailPassword Recipe

• POST
  Sign in with email/{apiBasePath}/{tenantId}/signin
• POST
  Sign up with email/{apiBasePath}/{tenantId}/signup
• GET
  Check email exists (deprecated)/{apiBasePath}/{tenantId}/signup/email/exists
• GET
  Check email exists/{apiBasePath}/{tenantId}/emailpassword/email/exists
• POST
  Generate password reset token/{apiBasePath}/{tenantId}/user/password/reset/token
• POST
  Reset user password/{apiBasePath}/{tenantId}/user/password/reset

ThirdParty Recipe

• POST
  Sign in/up with third party/{apiBasePath}/{tenantId}/signinup
• GET
  Get third party auth URL/{apiBasePath}/{tenantId}/authorisationurl
• POST
  Handle Apple sign in/{apiBasePath}/callback/apple

Multitenancy Recipe

• GET
  Get enabled login methods/{apiBasePath}/{tenantId}/loginmethods

EmailVerification Recipe

• POST
  Send email verification/{apiBasePath}/{tenantId}/user/email/verify/token
• POST
  Verify email address/{apiBasePath}/{tenantId}/user/email/verify
• GET
  Check email verification status/{apiBasePath}/user/email/verify

JWT Recipe

• GET
  Get JWT keys/{apiBasePath}/jwt/jwks.json

OpenId Recipe

• GET
  Get OpenID config/{apiBasePath}/.well-known/openid-configuration

OAuth2Provider Recipe

• GET
  Continue OAuth login/{apiBasePath}/oauth/login
• GET
  Start OAuth login/{apiBasePath}/oauth/auth
• POST
  Exchange OAuth grant/{apiBasePath}/oauth/token
• GET
  Get OAuth user info/{apiBasePath}/oauth/userinfo
• POST
  Revoke OAuth token/{apiBasePath}/oauth/revoke
• POST
  Introspect OAuth token/{apiBasePath}/oauth/introspect
• GET
  End session redirect/{apiBasePath}/oauth/end_session
• POST
  End OAuth session/{apiBasePath}/oauth/end_session
• GET
  Get OAuth login info/{apiBasePath}/oauth/logininfo
• POST
  Logout OAuth user/{apiBasePath}/oauth/logout

App API

• GET
  Test authentication/example

WebAuthn Recipe

• POST
  Get WebAuthn registration options/{apiBasePath}/{tenantId}/webauthn/register/options
• POST
  Get WebAuthn sign in options/{apiBasePath}/{tenantId}/webauthn/signin/options
• POST
  Sign up with WebAuthn/{apiBasePath}/{tenantId}/webauthn/signup
• POST
  Sign in with WebAuthn/{apiBasePath}/{tenantId}/webauthn/signin
• POST
  Generate WebAuthn recovery token/{apiBasePath}/{tenantId}/webauthn/recover/account/token
• POST
  Recover WebAuthn account/{apiBasePath}/{tenantId}/webauthn/recover/account
• POST
  Register WebAuthn credential/{apiBasePath}/{tenantId}/webauthn/credential
• GET
  Check WebAuthn email exists/{apiBasePath}/{tenantId}/webauthn/email/exists