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.

ภาพรวม

คำแนะนำ

คู่มือการใช้งาน

การอ้างอิง

แหล่งข้อมูล

งานศิลป์

การออกแบบ

เอ็นจิน

อวาตาร์

ไม่ใช้แล้ว

คลาวด์

This method is asynchronous and returns an `Operation`, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the [documentation]({longRunningOperationsLink}) on long-running operations for more information.
            
The following sections describe the response and metadata objects that are provided when an operation completes.

Endpoint เวอร์ชัน Beta พร้อมสำหรับการใช้งานทั่วไปแล้ว อาจมีการเปลี่ยนแปลงที่ทำให้ใช้งานไม่ได้ แต่ก็เป็นไปได้ยาก

ตั้งค่าฟิลด์นี้ตอนสร้างแหล่งข้อมูลได้ แต่จะแก้ไขโดยคำขอหลังจากนั้นไม่ได้

อาจมีช่องข้อมูลนี้ในคำขอ แต่จะไม่รวมอยู่ในการตอบกลับโดยเด็ดขาด

ต่อคีย์ API: {maxInPeriod} คำขอทุกๆ {periodInSeconds} วินาทีต่อที่อยู่ IP

อาจใช้ช่องข้อมูลนี้การตอบกลับ แต่จะเว้นไว้ในคำขอ

ต้องมีสิทธิ์เข้าถึงคีย์ API ต่อไปนี้เพื่อเรียกใช้ Endpoint นี้ ดูข้อมูล
เพิ่มเติมเกี่ยวกับการสร้างคีย์ที่เหมาะสมได้ที่[การจัดการคีย์ API]({apiKeyReferenceDocLink})

Endpoints ต่อไปนี้พร้อมใช้งานที่เส้นทางที่สัมพันธ์กับ URL หลัก

สตริงนี้มีรูปแบบ [FieldMask](/cloud/reference/types#fieldmask)

ค่า JSON จะเป็น `null`, `boolean`, `string`, `number`, `array` หรือ `object` ก็ได้

ต้องมีขอบเขตต่อไปนี้สำหรับแอปพลิเคชัน OAuth 2.0 ของคุณเพื่อใช้ Endpoint นี้ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีลงทะเบียนแอปพลิเคชัน OAuth 2.0 ได้ที่[การลงทะเบียนและการตรวจสอบแอป]({oauth2ReferenceDocLink})

วัตถุต่อไปนี้ใช้บรรยายเพย์โหลดที่ยอมรับหรือส่งคืน ดูข้อมูลเพิ่มเติมว่าจะใช้วัตถุเหล่านี้ตอนไหนที่ Endpoint แต่ละจุด

เนื้อหาคำขอเป็น

สตริงนี้มีรูปแบบ[ประทับเวลา](/cloud/reference/types#timestamp)

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

This allows editing of your commerce merchant connections.

This allows you to view information about your Creator Store products.

This allows you to modify information about your Creator Store products.

This allows viewing information about your communities.

This allows you to manage community join requests for your account.

This allows viewing information about your inventory.

Grants access to mange your badges and spend robux.

Grants access to manage your developer products.

Grants access to read information about the experiences you follow.

Grants access to follow and unfollow experiences on your behalf.

Grants access to manage your communities.

Grants permission to read community information.

Grants access to read and write your localization tables

Grants access to manage team collaboration for all experiences you own.

Grants access to manage your experiences and certain information associated with your experiences (e.g. localization information).

Grants access to read your experiences' localization information.

Grants access to modify your experiences' localization preferences.

Grants access to manage your user account.

Grants access to modify user localization preferences.

This grants the ability to publish messages on behalf of users.

This allows sending notifications from your experience to users.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

Grants access to read about your subscription products.

Grants the ability to read place information.

Grants the ability to edit place information.

This operation grants access to publish new versions of experiences to Roblox.

Grants the ability to read experience information.

Grants the ability to edit experience information.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

Grants the ability to read user's premium and verified status.

This allows you to view a user's social accounts.

This enables Single Sign-On functionality.

This grants access to read your profile information.