Skip to main content
GET
/
guardian
/
factors
TypeScript
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.guardian.factors.list();
}
main();
[
  {
    "enabled": true,
    "trial_expired": true,
    "name": "sms"
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Factors successfully retrieved.

enabled
boolean
default:true
required

Whether this factor is enabled (true) or disabled (false).

trial_expired
boolean
default:true

Whether trial limits have been exceeded.

name
enum<string>
default:sms

Factor name. Can be sms, push-notification, email, duo otp webauthn-roaming, webauthn-platform, or recovery-code.

Available options:
push-notification,
sms,
email,
duo,
otp,
webauthn-roaming,
webauthn-platform,
recovery-code
Minimum string length: 1