Goldmine
Two Factor

Get two-factor status

POST
/accounts.v1.Accounts/GetTwoFactorStatus

Returns the caller's two-factor configuration, including the active method, which methods are enrolled or available, and how many backup codes remain.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/accounts.v1.Accounts/GetTwoFactorStatus" \  -H "Content-Type: application/json" \  -d '{}'
{
  "activeMethod": "TWO_FACTOR_METHOD_TOTP",
  "totpEnrolled": true,
  "passkeyEnrolled": false,
  "emailAvailable": true,
  "backupCodesRemaining": 7
}
{
  "code": "invalid_argument",
  "message": "The request was malformed, such as a missing required field or an unparseable cursor."
}
{
  "code": "unauthenticated",
  "message": "The request lacks a valid API key in the Authorization header."
}
{
  "code": "permission_denied",
  "message": "The API key is not allowed to perform this action on this workspace."
}
{
  "code": "resource_exhausted",
  "message": "The request was rate limited. Slow down and retry later."
}
{
  "code": "internal",
  "message": "An internal server error occurred."
}

DisableTOTP

Removes the enrolled authenticator app from the account. The caller must supply their password and a current authenticator or backup code to confirm.

RegenerateBackupCodes

Issues a fresh set of one-time backup codes and invalidates the previous set. The caller must supply their password and a current authenticator code to confirm.