6 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

Roblox.TwoStepVerification.Api.MetadataResponse — openapi

Two step verification system metadata.

Properties

Complete Schema

{
  "description": "Two step verification system metadata.",
  "type": "object",
  "properties": {
    "twoStepVerificationEnabled": {
      "description": "Whether or not two step verification is globally enabled.",
      "type": "boolean"
    },
    "authenticatorQrCodeSize": {
      "description": "Authenticator QR code image dimensions.",
      "type": "string"
    },
    "emailCodeLength": {
      "format": "int32",
      "description": "Number of characters in an email-based two step verification code.",
      "type": "integer"
    },
    "authenticatorCodeLength": {
      "format": "int32",
      "description": "Number of characters in an authenticator-based two step verification code.",
      "type": "integer",
      "readOnly": true
    },
    "authenticatorHelpSiteAddress": {
      "description": "Address of the help site provided to users to help them with authenticator.",
      "type": "string"
    },
    "isPasswordRequiredForEnablingAuthenticator": {
      "description": "Whether or not a password is required for enabling authenticator.",
      "type": "boolean"
    },
    "isPasswordRequiredForEnablingEmailTwoStepVerification": {
      "description": "Whether or not a password is required for enabling email 2sv.",
      "type": "boolean"
    },
    "isUsingTwoStepWebviewComponent": {
      "description": "Whether or not we're using the new 2sv webview component or the manual pop up",
      "type": "boolean"
    },
    "isTwoStepEnabledRequiredForEmailPasswordRequirement": {
      "description": "Whether or not a 2sv method has to be enabled to require password when enabling email two step verification.",
      "type": "boolean"
    },
    "isTwoStepEnabledRequiredForAuthenticatorPasswordRequirement": {
      "description": "Whether or not a 2sv method has to be enabled to require password when enabling authenticator.",
      "type": "boolean"
    },
    "isSingleMethodEnforcementEnabled": {
      "description": "Whether or not the frontend should enforce single method logic.",
      "type": "boolean"
    },
    "isSmsTwoStepVerificationAvailable": {
      "description": "Whether or not sms two step verification is available for the user.",
      "type": "boolean"
    },
    "isSecurityKeyTwoStepVerificationAvailable": {
      "description": "Whether or not security key two step verification is available for the user.",
      "type": "boolean"
    },
    "isAuthenticatorWithVerifiedPhoneEnabled": {
      "description": "Whether or not someone can enable authenticator with just a verified phone number.",
      "type": "boolean"
    },
    "isPasswordRequiredForEnablingSecurityKey": {
      "description": "Whether or not a password is required for enabling Security Key 2SV.",
      "type": "boolean"
    },
    "isPasswordRequiredForEnablingSms2SV": {
      "description": "Whether or not a password is required for enabling SMS 2SV.",
      "type": "boolean"
    },
    "isPasswordRequiredForChangingRecoveryCodes": {
      "description": "Whether or not a password is required for making updates to recovery codes.",
      "type": "boolean"
    },
    "isPasswordRequiredForDisablingAuthenticator": {
      "description": "Whether or not a password is required for disabling authenticator.",
      "type": "boolean"
    },
    "isPasswordRequiredForDisablingEmailTwoStepVerification": {
      "description": "Whether or not a password is required for disabling email 2sv.",
      "type": "boolean"
    },
    "isPasswordRequiredForDisablingSms2SV": {
      "description": "Whether or not a password is required for disabling SMS 2SV.",
      "type": "boolean"
    },
    "isRecoveryCodeGenerationForAuthenticatorSetupEnabled": {
      "description": "Whether recovery code generation is attempted upon completion of authenticator setup.",
      "type": "boolean"
    },
    "isSecurityKeyOnAllPlatformsEnabled": {
      "description": "Whether security keys on all platforms is enabled.",
      "type": "boolean"
    },
    "receiveWarningsOnDisableTwoStep": {
      "description": "Whether users should receive additional warnings when disabling 2SV.",
      "type": "boolean"
    },
    "isAndroidSecurityKeyEnabled": {
      "description": "Whether Android security keys is enabled.",
      "type": "boolean"
    },
    "isSettingsTabRedesignEnabled": {
      "description": "Whether the settings tab redesign is enabled.",
      "type": "boolean"
    },
    "twoStepCopyTextEnrollmentStatus": {
      "format": "int32",
      "description": "The enum representing which experiment group the user is in.",
      "type": "integer"
    },
    "isEppUIEnabled": {
      "description": "Whether the EPP UI is enabled.",
      "type": "boolean"
    },
    "isEppRecoveryCodesEnabled": {
      "description": "Whether the EPP recovery codes UI is enabled.",
      "type": "boolean"
    },
    "maskedUserEmail": {
      "description": "The masked email for the authenticated user. Typically used in Email 2SV challenges after\r\nthe challenge has been verified to match the target user.",
      "type": "string"
    },
    "isUserU13": {
      "description": "Whether the user is O13.",
      "type": "boolean"
    },
    "isDelayedUiEnabled": {
      "description": "Whether the delayed UI is enabled.",
      "type": "boolean"
    },
    "is2svRecoveryEnabled": {
      "description": "Whether to expose 2SV recovery through the 2SV challenge modal.",
      "type": "boolean"
    }
  },
  "additionalProperties": false
}