管理と有効化Consumer modeソリューションのセットアップガイドFoundryでホストされるOAuthアプリケーション

注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

Foundry でホストされる OAuth アプリケーション

OAuth アプリケーションは、Foundry 内でホストされるプロコードのオントロジー SDK アプリケーションで、認可グラントフローを使用した対話型のユーザー認証をサポートします。これらのアプリケーションは、対話型のカスタムアプリケーション向けに Foundry のセキュリティプリミティブを活用します。

Foundry でホストされる OAuth アプリケーションは、次のユースケースに最適です。

  • ユーザー認証を必要とする対話型 Web アプリケーション。
  • ユーザーごとに異なる権限を必要とするマルチユーザーアプリケーション。
  • オントロジー SDK で構築され、Foundry でホストされるプロコードのカスタムアプリケーション。

アーキテクチャ

User → Foundry Subdomain → OAuth Flow → OSDK App → Foundry APIs

Foundry でホストされるアプリケーションは、専用のサブドメイン(たとえば https://subdomain-for-app.your-foundry-domain.com/)にデプロイされ、同意を設定できる OAuth リダイレクトによるログインフローに従います。

前提条件

Foundry でホストされる OAuth アプリケーションをセットアップする前に、次の条件を満たしていることを確認してください。

  • Foundry プラットフォームがコンシューマーモードを使用するように設定されていること。
  • Developer Console アプリケーションの作成とホスティングに必要な適切な権限を持っていること。
  • アプリケーションを構築するためのフロントエンド開発の経験がある、またはその経験を持つ人の支援を受けられること。

セットアップ

ステップ1:オントロジー SDK アプリケーションを作成する

ドキュメントに沿って、新しいオントロジー SDK アプリケーションを作成します。

  1. アプリケーションを作成する: Developer Console を使用して、新しいフロントエンドアプリケーションを作成します。
  2. OAuth 設定を構成する: ユーザー認証にパブリッククライアントを使用します。
  3. アプリケーションの制限を定義する: Foundry リソースへのアクセスに必要な制限を設定します。

ステップ2:オントロジー SDK アプリケーションを開発する

オントロジー SDK フレームワークを使用して、フロントエンドアプリケーションを構築します。オントロジー SDK ドキュメントで TypeScript の例を確認できます。

ステップ3:アプリケーションを Foundry にデプロイする

オントロジー SDK アプリケーションを Foundry でホストするためにデプロイし、サブドメインを控えておきます。

ステップ4:コンシューマーのアクセスを確認する

  1. アプリケーションの権限を構成する: コンシューマーのルールベースグループに、デプロイしたオントロジー SDK アプリケーションへのアクセスを付与します。
  2. Developer Console でコンシューマーのアクセスを確認する: ユーザーに必要な権限がない場合は、そのユーザーをコンシューマースペース内の必要なプロジェクトに追加して、アクセスを付与します。
  3. ユーザーフローをテストする: コンシューマーユーザーが適切な権限でアプリケーションにアクセスできることを確認します。

トラブルシューティング

  • 権限の問題: アクセスを確認パネルで、ユーザーがアプリケーション内のすべてのリソースにアクセスできることを確認します。
  • スコープエラー: Developer Console で、OAuth クライアントに正しいスコープが設定されていることを検証します。

ユーザーエクスペリエンスの問題

これで、外部コンシューマーが安全に利用できる、Foundry でホストされるアプリケーションが稼働しています。このオントロジー SDK アプリケーションは、適切な権限の境界とユーザーの分離を維持しながら、認証済みユーザーに Foundry のデータと機能への安全なアクセスを提供します。