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.

1: Invalid challenge ID.
4: The password is invalid.

Verifies a two step verification challenge with a password (code).

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.

概要

バーチャル空間

Avatar

アセット

Open Cloud

Create

発見

多言語化

解析

デザイン

Scale

Affiliates

Monetize

このメソッドは非同期で、操作の現在の状態を表す `Operation` を返します。このメソッドにはエンドポイントパスが含まれており、これをポーリングすることで実際の応答と該当するメタデータを取得することができます。長時間実行オペレーションについて詳しくは、[ドキュメンテーション]({longRunningOperationsLink})  を参照してください。
            
以下のセクションでは、操作が完了したときに提供される応答とメタデータオブジェクトについて説明します。

ベータエンドポイントが一般向けに使用できるようになりました。破壊的変更は可能ですがまれです。

このフィールドはリソースの作成時に設定できますがその後のリクエストでは変更することはできません。

この欄はリソースの作成時に設定できますがその後のリクエストでは変更することはできません。

このフィールドはリクエスト上で提供されることはあるかもしれませんが、応答に入ることはありません。

各APIキー：各IPアドレスにつき {maxInPeriod} 回のリクエストが {periodInSeconds} 秒ごとに送信されます

このフィールドは応答に設定できますが、リクエストでは無視されます。

このエンドポイントを呼び出すには以下のAPIキー権限が必要です。適切なキーの生成方法についての情報は、 [API キーの管理]({apiKeyReferenceDocLink}) をごらんください。

次のエンドポイントは、ベースのURLに相対するパスで使用できます。

この文字列は [Timestamp](/cloud/reference/types#fieldmask) としてフォーマットされています。

JSON 値は、 `null`、 `boolean`、 `string`、 `number`、 `array`、 `object` にはできません。

あなたのOAuth 2.0 アプリケーションでこのエンドポイントを使用するには以下のスコープが必要です。OAuth 2.0 アプリケーションの登録方法についての情報は、 [アプリ登録とレビュー]({oauth2ReferenceDocLink}) をごらんください。

以下のオブジェクトは、受け入れられたか返されたペイロードの説明です。これらのオブジェクトがいつ使用されるかについて詳しくは、各エンドポイントを参照してください。

この文字列は [Timestamp](/cloud/reference/types#timestamp) としてフォーマットされています。

あなたのOAuth 2.0 アプリケーションでこのエンドポイントを使用するには以下の範囲が必要です。OAuth 2.0 アプリケーションの登録方法についての情報は、 [アプリ登録とレビュー]({oauth2ReferenceDocLink}) をごらんください。

これであなたのアセットについての情報を表示できるようになります。

これでRobloxにアセットをアップロードしたり、アップデートしたりできます。

ユーザー所有のバッジを更新する能力を付与。

あなたのEコマースアイテムについての情報を表示できるようにします。

これでEコマース事業者コネクションを編集できるようになります。

これでクリエーターストアの製品に関する情報を表示できます。

これでクリエーターストアの製品に関する情報を変更できます。

あなたコミュニティについての情報を表示できるようにします。

これでお持ちのアカウントのコミュニティ参加リクエストと低ランクのコミュニティメンバーの役割への更新を管理できるようになります。

これであなたの持ち物についての情報を表示できるようになります。

あなたのバッジ管理へのアクセス権を付与。

バッジ管理とRobuxの使用管理機能へのアクセス権を付与。

あなたの開発者製品の管理機能へのアクセス権を付与。

フォローしているバーチャル空間についての情報を読むためのアクセス権を付与。

あなたに代わってバーチャル空間のフォローとフォロー解除をするアクセス権を付与。

あなたのパス管理へのアクセス権を付与。

あなたのコミュニティ管理へのアクセス権を付与。

コミュニティ情報を読む権限を付与。

コミュニティ管理権限を付与。

多言語化テーブルの読み込みと書き込みへのアクセス権を付与

あなたが所有するすべてのバーチャル空間に関するチーム共同制作管理へのアクセス権を付与。

あなたのバーチャル空間の管理機能と、関連する特定の情報へのアクセス権を付与。（例：多言語化の情報）

バーチャル空間の多言語化情報を読むアクセス権を付与。

バーチャル空間の多言語化設定を変更するためのアクセス権を付与。

あなたのユーザーアカウントへのアクセス権を付与。

ユーザーの多言語化設定を変更するアクセス権を付与。

これでユーザーに代わってメッセージを公開する権限を与えることができます。

これでバーチャル空間からユーザーに通知を送信できるようになります。

これであなたのバーチャル空間に関連した秘密をリストアップできるようになります。

これであなたのバーチャル空間に関連した秘密を作成してアップデートできるようになります。

あなたの定期購入製品についての内容を読む権限を付与。

プレース情報を読み取る能力を付与。

プレース情報を編集する能力を付与。

この操作によって、Robloxに新しいバージョンのバーチャル空間を公開するアクセス権限が与えられます。

バーチャル空間の情報を読む能力を付与。

バーチャル空間の情報を編集する能力を付与。

バーチャル空間内でのユーザー制限を表示できます。

バーチャル空間内でのユーザー制限が編集できるようになります。

ユーザーがプレミアム会員がどうかと認証済みかどうかを読み取る権限を付与。

これでユーザーのSNSアカウントを表示できるようになります。

シングルサインオン機能を有効化。

これにより、あなたのプロフィール情報を読む権限が与えられます。

Two-step verification v1