Documentation home page

Dashboard
Support
Dashboard

MFA

Sign In TOTP

Community
Blog

API Documentation

Backend Services

Authentication

Email and Password
Passwordless
OAuth
WebAuthn
Anonymous
MFA
User
POST
Sign Out

Storage

GraphQL

AI

Client Libraries

JavaScript

React

Next.js

Vue

React Native

MFA

Sign In TOTP

Sign In with a Time-based One-Time Password (TOTP)

POST

/

signin

/

mfa

/

totp

object

*

otp

string

*

otp

Required

string

ticket

string

*

ticket

Required

string

Add Example Value

Body

application/json

otp

string

required

ticket

string

required

Response

200 - application/json

mfa

object

mfa.ticket

string

session

object

session.accessToken

string

required

session.accessTokenExpiresIn

number

required

session.refreshToken

string

required

Refresh token during authentication or when refreshing the JWT

session.user

object

session.user.activeMfaType

required

Multi-factor authentication type. A null value deactivates MFA

Available options:

totp

session.user.avatarUrl

string

required

session.user.createdAt

string

required

session.user.defaultRole

enum<string>

default: userrequired

Available options:

me,

user

session.user.displayName

string

required

session.user.email

string

required

A valid email

session.user.emailVerified

boolean

default: falserequired

session.user.id

string

Id of the user

session.user.isAnonymous

boolean

default: falserequired

session.user.locale

string

default: enrequired

A two-characters locale

session.user.metadata

object

required

session.user.phoneNumber

string

required

session.user.phoneNumberVerified

boolean

default: falserequired

session.user.roles

enum<string>[]

required

Available options:

me

TOTP Secret Toogle MFA

twitter github linkedin

Powered by Mintlify