Request information needed to clear existing recovery codes.

Request information needed to disable two step verification.

A array of nicknames of credentials to be deleted.

A re-authentication token redeemable for any password check.

Response parameters for initiating enabling authenticator-based two step verification.

The manual entry key to input into the authenticator app.

The Url to the QR code image to scan into the authenticator app.

The setup token for turning on authenticator.

Response parameters for initiating enabling security key-based two step verification.

The credential registration options for the hardware key.

Request parameters for enabling two step verification.

Request parameters for authenticator enabling-verify.

The setup token from the enable authenticator request.

Response parameters for finishing enabling authenticator-based two-step verification.

Recovery codes automatically generated for the user (when applicable; the user should
not already have a set of recovery codes).

Request information needed to complete the registration of a security key.

Response parameters for listing all credentials under a user.

Number of characters in an authenticator-based two step verification code.

Address of the help site provided to users to help them with authenticator.

Number of characters in an email-based two step verification code.

Whether Android security keys is enabled.

Whether or not someone can enable authenticator with just a verified phone number.

Whether or not a password is required for making updates to recovery codes.

Whether or not a password is required for disabling authenticator.

Whether or not a password is required for disabling email 2sv.

Whether or not a password is required for disabling SMS 2SV.

Whether or not a password is required for enabling authenticator.

Whether or not a password is required for enabling email 2sv.

Whether or not a password is required for enabling Security Key 2SV.

Whether or not a password is required for enabling SMS 2SV.

Whether recovery code generation is attempted upon completion of authenticator setup.

Whether security keys on all platforms is enabled.

Whether or not security key two step verification is available for the user.

Whether or not the frontend should enforce single method logic.

Whether or not sms two step verification is available for the user.

Whether or not a 2sv method has to be enabled to require password when enabling authenticator.

Whether or not a 2sv method has to be enabled to require password when enabling email two step verification.

Whether or not we're using the new 2sv webview component or the manual pop up

Whether users should receive additional warnings when disabling 2SV.

Whether or not two step verification is globally enabled.

The response for getting the status of recovery codes for a user.

The number of unused recovery codes the user has available.

The date time the recovery codes were generated at.

Request information needed to regenerate recovery codes.

The response for regenerating recovery codes.

The collection of generated recovery codes.

Request parameters for retracting a Cross Device dialog from state ACTIVE to PENDING.

The Roblox.TwoStepVerification.Client.TwoStepVerificationActionType associated with the challenge. ['Unknown' = 0, 'Login' = 1, 'RobuxSpend' = 2, 'ItemTrade' = 3, 'Resale' = 4, 'PasswordReset' = 5, 'RevertAccount' = 6, 'Generic' = 7, 'GenericWithRecoveryCodes' = 8]

Result for a successful attempt to retract a Cross Device state from ACTIVE to PENDING.

Request parameters for retrying a Cross Device two step verification approval.

Result for a successful Cross Device approval retry, an empty JSON.

Credential information that includes its nickname and any additional metadata.

Nickname the user has chosen for this credential.

Request parameters for sending a two step verification code.

The users two step verification configuration.

The two step verification methods associated with the user.

The preferred two step verification method for the user.

The Roblox.TwoStepVerification.Client.TwoStepVerificationMediaType for the method. ['Email' = 0, 'SMS' = 1, 'Authenticator' = 2, 'RecoveryCode' = 3, 'SecurityKey' = 4, 'CrossDevice' = 5, 'Password' = 6, 'Passkey' = 7]

The last time this method was updated for the user.

Request parameters for verifying a Cross Device two step verification approval. Does not use verification code.

Result for a successful Cross Device approval verification.

Request parameters for verifying a two step verification code.

The authentication options for the passkey.

The session of the authentication attempt.

The authentication options for the hardware key.

TwoStepVerification Api v1

The metadata endpoint takes in optional request parameters to output additional context
for when the user is unauthenticated but attempting to login with two step verification.

When supplied, all three request parameters must be sent and match up.

userId

The active two step verification challenge ID if there is one.

challengeId

The Roblox.TwoStepVerification.Client.TwoStepVerificationActionType associated with the challenge.

actionType

Gets two step verification system metadata.

The Roblox.TwoStepVerification.Api.VerifyCodeRequest.

request

1: Invalid challenge ID.
2: The user ID is invalid.
10: The two step verification challenge code is invalid.

7: Two step verification is currently under maintenance.

Verifies a two step verification challenge code via authenticator app.

The Roblox.TwoStepVerification.Api.RetractDialogRequest.

1: Invalid challenge ID.
2: The user ID is invalid.

0: Token Validation Failed
19: Challenge denied.

Reverts a user's dialog state from ACTIVE to PENDING.

The Roblox.TwoStepVerification.Api.RetryApprovalRequest.

Retry a Cross Device two step verification approval.

The Roblox.TwoStepVerification.Api.VerifyApprovalRequest.

0: An unknown error occurred with the request.
1: Invalid challenge ID.
2: The user ID is invalid.

Verifies a two step verification approval via Cross Device. Cross Device approval does not use a verification code.

The request body.Roblox.TwoStepVerification.Api.SendCodeRequest.

0: Token Validation Failed
2: The user ID is invalid.

Sends a two step verification challenge code via email.

The request body.Roblox.TwoStepVerification.Api.VerifyCodeRequest.

1: Invalid challenge ID.
10: The two step verification challenge code is invalid.

Verifies a two step verification challenge with a code sent via email.

The request bodyRoblox.TwoStepVerification.Api.VerifyCodeRequest.

Validates the assertion data returned by the passkey.

The request bodyRoblox.TwoStepVerification.Api.SendCodeRequest.

0: Token Validation Failed
8: The user is not allowed to perform the requested action.

Provides a challenge for the passkey to authenticate.

Once a recovery code has been used to verify a challenge it cannot be used again.

Verifies a two step verification challenge via a recovery code.

Validates the assertion data returned by the security key.

Provides a challenge for the security key to authenticate.

Sends a two step verification code via SMS for the specified user.

Verifies a two step verification challenge with a code sent via SMS.

The Id of the user to get the configuration for.

The active challenge for the user (as an alternative when the user is unauthenticated).

The action type the challengeId is associated with.

Gets two step verification configuration for the specified user.

The Roblox.TwoStepVerification.Api.DisableTwoStepVerificationRequest.

2: The user ID is invalid.
4: The password is invalid.

0: Authorization has been denied for this request.

0: Token Validation Failed
6: The account pin is locked.
8: The user is not allowed to perform the requested action.

Disables two step verification via authenticator for the specified user.

The Roblox.TwoStepVerification.Api.EnableTwoStepVerificationRequest.

2: The user ID is invalid.
3: The email is invalid.
4: The password is invalid.

0: Token Validation Failed
6: The account pin is locked.
11: The two step verification configuration is already enabled.

Initiates enabling authenticator-based two step verification for the specified user.

Enabling authenticator-based two step verification requires two parts to help ensure
the user has properly stored the authenticator key in their authenticator app.

The Roblox.TwoStepVerification.Api.EnableVerifyAuthenticatorRequest.

2: The user ID is invalid.
4: The password is invalid.
10: The two step verification challenge code is invalid.
12: Invalid setup token.

0: Token Validation Failed
11: The two step verification configuration is already enabled.

Finishes enabling authenticator-based two step verification for the specified user.

0: Token Validation Failed
2: The user ID is invalid.
6: The account pin is locked.
8: The user is not allowed to perform the requested action.

Disables two step verification via email for the specified user.

3: The email is invalid.
4: The password is invalid.

0: Token Validation Failed
2: The user ID is invalid.
6: The account pin is locked.

Enables two step verification via email for the specified user.

The request bodyRoblox.TwoStepVerification.Api.DisableTwoStepVerificationRequest.

Disables a batch of credentials for the specified user.

The request body.Roblox.TwoStepVerification.Api.EnableTwoStepVerificationRequest.

0: Token Validation Failed
9: The two step verification configuration is invalid for this action.
16: Reached limit of security keys registered.

Initiates security key registration by providing credential creation options.

The request body.Roblox.TwoStepVerification.Api.EnableVerifySecurityKeyRequest.

2: The user ID is invalid.
17: Invalid security key nickname.

0: Token Validation Failed
17: Invalid security key nickname.

Finishes security key registration and stores credential. Enables security key as a 2sv media type if it is a user's first key.

The request body.Roblox.TwoStepVerification.Api.DisableTwoStepVerificationRequest.

Disables two step verification via SMS for the specified user.

4: The password is invalid.
15: The phone number is invalid.

7: Two step verification is currently under maintenance.
8: The user is not allowed to perform the requested action.

Enables two step verification via SMS for the specified user.

Gets the current status of recovery codes for a user.

Clearing recovery codes voids any recovery codes previously generated for the user.
New recovery codes will have to be generated to pass two step verification via recovery code.

The Roblox.TwoStepVerification.Api.ClearRecoveryCodesRequest.

0: Token Validation Failed
6: The account pin is locked.

Clears any existing recovery codes for the user.

Two step verification recovery codes do not enforce that two step verification must be passed when logging in.
At least one two step verification media type must be enabled to trigger the two step verification flow.
Recovery codes are intended to be used to pass two step verification when the enabled media type is unavailable.

Recovery codes generated by this endpoint do not have an expiration.

Once a recovery code generated by this endpoint has been used it cannot be used again.

The user ID to generate recovery codes for.

The Roblox.TwoStepVerification.Api.RegenerateRecoveryCodesRequest.

Clears any existing recovery codes and generates a new batch of recovery codes.

概覽

指南

教學

參考

資源

美術

設計

引擎

虛擬人偶

舊版本

雲端

此方式不同步且返回「操作」，這代表操作的目前狀態。它包含終點路徑，您可以取用以獲得實際回應和適用的中繼資料。詳情請參閱長期執行操作上的 [文件]({longRunningOperationsLink})。
            
以下部分描述操作完成時提供的回應和中繼資料物件。

Beta 測試終點已準備好公開使用。可能出現導致功能無法正常運作的變更，但機率不高。

建立資源時可設定此欄位，但可能無法在後續請求中修改。

此欄位可在請求中提供，但永遠不會包含在回應中。

每個 API 金鑰：每個 IP 位址每 {periodInSeconds} 秒 {maxInPeriod} 個請求

此欄位可在回應中設定，但將在請求中被忽略。

調用此端點需要以下 API 金鑰權限。有關
產生正確金鑰的更多資訊，請查看 [管理 API 金鑰]（{apiKeyReferenceDocLink}）。

根據相對基本網址的路徑，可使用下列終點。

此字串的格式為 [FieldMask](/cloud/reference/types#fieldmask)。

JSON 值可為「null」、「boolean」、「string」、「number」、「array」或「object」。

若想使用此端點，您的 OAuth 2.0 應用程式需要以下範圍。有關如何註冊 OAuth 2.0 應用程式的更多資訊，請查看 [應用程式註冊和審查]（{oauth2ReferenceDocLink}）。

以下物件描述被接受或退回的負載。若要獲得更多關於物件使用時機的資訊，請查看個別終點。

此字串的格式為 [Timestamp](/cloud/reference/types#timestamp)。

這可以查看有關您資產的資訊。

這可以上傳和更新 Roblox 的資產。

授予更新使用者所擁有之徽章的能力。

這會允許查看您商品的相關資訊。

這會允許對您的商務商家連結進行編輯。

這能讓您檢視您創作者商店商品的相關資訊。

這能讓您修改您創作者商店商品的相關資訊。

這會允許查看您社群的相關資訊。

這能讓您管理社群加入申請和您帳號的角色更新。

這可以查看有關您道具欄的資訊。

授予管理您徽章和花費 Robux 的權限。

授予管理您開發者產品的權限。

授予讀取您所追蹤體驗之相關資訊的權限。

授予代您追蹤體驗和取消追蹤的權限。

授予讀取與寫入您在地化表格的權限。

授予管理您擁有之所有體驗的團隊協作權限。

授予管理您的體驗及部分體驗相關資訊（例如：在地化資訊）的權限。

授予讀取您體驗之在地化資訊的權限。

授予修改您體驗在地化偏好的權限。

授予管理您使用者帳號的權限。

授予修改使用者在地化偏好的權限。

給予代替使用者發布訊息的能力。

這能讓您的體驗向使用者傳送通知。

此將允許列出與您的體驗相關的機密資料。

此將允許建立並更新與您的體驗相關的機密資料。

授予讀取您訂閱產品相關資訊的權限。

此操作將會允許發布新版本的體驗到 Roblox。

讓您檢視體驗中的使用者限制。

讓您在體驗中編輯使用者限制。

授予讀取使用者高級會員狀態與驗證狀態的能力。

這能讓您檢視使用者的社群帳號。

這將授予讀取您個人檔案資訊的權限。