Skip to main content
GET/gate/mfa/methods

List MFA Methods

Returns the active MFA factor enrollments for the authenticated end-user, including TOTP and WebAuthn factors.

Each entry reflects an mfa_-prefixed factor record with factor_type drawn from {totp, sms, email, webauthn}.

Requires a valid end-user JWT.

Parameters
projectSlug *path

The project's slug: the path segment after @.

It is unique within the org.

Responses
HTTPK9O CodeDescription
200Success
401K9O_SESSION_EXPIREDYour session has expired or been revoked. Sign in again to continue.
404K9O_END_USER_NOT_FOUNDNo account was found for the provided identity.
Response body (200)
data *object

The end user's second factors.

methods *object[]

The end user's second factors, oldest first, pending ones included.

Empty when there are none.

id *string

The authenticator's id (eumf_...).

type *"totp" | "sms" | "email" | "webauthn"

The kind of second factor.

Authenticator apps are totp.

label *any

The name given at enrolment, or null if none was stored.

One of: string
or: null
verifiedAt *any

When it was confirmed, or null if it was enrolled but never confirmed (a pending authenticator is not asked for at sign-in).

One of: string <date-time>
or: null
createdAt *string <date-time>

When it was enrolled.

meta *any

Request metadata: cost, timing and the request and trace ids.

TypeScript
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.gate.mfa.methods.list()

Showing example in TypeScript

Response example (200)
{
  "data": {
    "methods": [
      {
        "id": "string",
        "type": "totp",
        "label": "string",
        "verifiedAt": "string",
        "createdAt": "string"
      }
    ]
  }
}

More in Sign-in & Sessions