Get Factors and multi-factor authentication details

Retrieve details of all multi-factor authentication factors associated with your tenant.

GET https://{tenantDomain}/api/v2/guardian/factors

Go

Go

package example

import (
    context "context"

    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    client.Guardian.Factors.List(
        context.TODO(),
    )
}

200

[
  {
    "enabled": true,
    "trial_expired": true,
    "name": "sms"
  }
]

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Response

200

application/json

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