OAuth 2.0 アプリ登録

OAuth 2.0 アプリを登録すると、Roblox リソースにアクセスできるようになります。登録後、Roblox はアプリにユニークなクライアント ID とシークレットを割り当て、ユーザーからの承認を取得して、ユーザーの Roblox 情報とリソースにアクセスできるようにします。

アプリを登録する

アプリを登録するには：

1. クリエイターダッシュボードに移動し、OAuth 2.0 アプリページにアクセスします。
2. アプリ作成ボタンをクリックします。
3. 有効かつグローバルでユニークなアプリケーション名を入力します。
4. Roblox 利用規約を読み、同意してから作成をクリックします。
5. クライアント IDとシークレットを安全な場所にコピーして保管します。ページを閉じると、シークレットへのアクセスはできなくなり、新しいものを生成することだけが可能です。アプリの登録が完了した後でも、アプリの他のプロパティにアクセスして編集することはできます。
6. 編集を続けるをクリックして、次のセクションで説明するアプリを構成します。

一般情報を構成する

アプリを登録した後は、次の情報を構成する必要があります。

• Roblox コミュニティ内すべての人に表示される説明。
• アプリのサムネイル画像。推奨ファイルサイズは150x150ピクセル以上です。
• アプリのエントリーポイントとしてのエントリリンク、例えばアプリのウェブサイトのホームページ。
• エンドユーザーがアプリを承認する前に読むためのプライバシー規約 URLと利用規約 URL。各 URL は HTTPS でなければならず、256 文字以内である必要があります。

権限を追加する

アプリ内で適切なアクセス制御とセキュリティを確保するために、パーミッションスコープを追加する必要があります。利用可能なパーミッションスコープには 2 種類あります。

• 認証用のアイデンティティスコープ、例えばユーザー ID 用の openid とフルプロファイル用の profile。profile スコープを選択した場合は、openid も選択する必要があります。
• 資産の読み取り権限のための asset:read など、API 特定のパーミッションスコープ。アプリに必要な最小限のスコープのみを選択してください。

リダイレクト URL を追加する

リダイレクト URLは、ユーザーがアプリの承認を終了したときにリダイレクトされるアプリの再エントリポイントです。リダイレクト URL が以下の要件を満たしていることを確認してください。

• すべてのリダイレクト URL は次の形式のいずれかである必要があります：

  • プレーン HTTPS、例えば：https://www.example.com.
  • ローカルデバッグ目的のための HTTP または HTTPS（自己署名証明書）を使用したローカルホスト上のパス、例えば：

    • http://localhost:80
    • https://localhost:80
  • 特定のアプリケーションや目的のためのカスタムスキーム、例えば：

    • my-app-scheme:/
    • my-app-scheme://foo/bar/...
    • my-app://action?param1=value1&param2=value2
• リダイレクト URL の最大長は 256 文字です。
• 最大 10 のリダイレクト URL を追加できます。複数のリダイレクト URL を持つことで、テスト環境を保持し、ユーザーがダウンタイムなしで 2 つのサイト間を移行できるようになります。

レビューに提出する

悪意のあるアプリがコミュニティに害を及ぼす可能性を最小限に抑えるために、アプリの登録は広くアクセス可能にするものではありません。代わりに、それは プライベートモードに留まり、ユニークなユーザーは 10 人に制限されます。このモードは、チーム内でのテストおよびデバッグに便利です。

アプリのユーザーベースを拡大したい場合は、公開モードでアプリを公開する必要があります。このためにはレビューに提出します：

1. OAuth 2.0 アプリページに移動します。
2. 公開したいアプリの編集して公開ボタンをクリックします。
3. すべての必要な情報を入力し、レビューと公開ボタンをクリックします。保留中のレビュー期間中のアプリの権限に関する制限を示すメッセージが表示されます。
4. レビューに提出をクリックします。

アプリのレビューが保留中の間は、現在のレビューリクエストが承認または拒否されるまで、他のリクエストを編集したり提出したりすることはできません。アプリはレビュー中はプライベートモードのままです。アプリが承認されると、公開モードに移行し、プライベートモードに戻すことはできません。

アプリが承認されたか拒否されたかにかかわらず、レビューが完了した時に結果のメール通知を受け取ります。

アプリを編集または削除する

アプリがレビュー中でない場合、次の手順でアプリを編集または削除できます：

1. OAuth 2.0 アプリページに移動します。

2. 対象のアプリについて編集または削除をクリックします。

   • アプリの編集を選択した場合は、登録と同じ手順と要件に従ってください。
   • アプリの削除を選択した場合は、削除を確認するためにはい、削除をクリックします。アプリを削除した後は、そのアプリを復元することはできません。

アプリの一般情報やリダイレクト URL を変更しても、ユーザーに再承認を求める必要はありません。ただし、パーミッションスコープを追加または変更した場合、新しい権限についてユーザーからの承認を取得し、新しいトークンセットを取得する必要があります。新しいスコープについて承認を取得しない場合、アプリは既存のトークンを引き続き使用できますが、前のスコープに制限されます。

プライベートモードのアプリの場合、システムは自動的にユーザーに対して編集内容を更新します。公開モードのアプリでは、これらの変更を反映するために、再度レビューに提出する必要があります。それ以外の場合、システムは未公開の変更を保存し、コミュニティに公開することはありません。