users
users

Get current 2FA status, including how many backup codes are left.

get/api/users/{uuid}/two_factor_status/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/users/{uuid}/two_factor_status/
  • Auth: none declared

Path parameters

uuidstring uuid required

Response

is_enabledboolean required

Whether the user has any 2FA method enabled.

backup_codes_remaininginteger required

Number of unused backup codes. The codes themselves are only returned when they are generated.

methodstring nullable required

The primary 2FA method: "TOTP" or "passkey". Null when 2FA is off.

has_passkeysboolean required

Whether the user has at least one verified passkey.

has_totpboolean required

Whether the user has an authenticator app set up.

passkeys_enabled_for_2faboolean required

Whether passkeys count as a 2FA method.

Changes

No recorded changes to this operation across all 1 revision of this API.