View a markdown version of this page

例: ゲートウェイを呼び出すときの認可コード許可による認証 - Amazon Bedrock AgentCore

例: ゲートウェイを呼び出すときの認可コード許可による認証

認可コード付与を使用してゲートウェイターゲットをセットアップした場合 (詳細については、OAuth 認可」を参照）、ゲートウェイの作成時にdefaultReturnUrl指定した は、認証後にユーザーのブラウザがリダイレクトするリンクになります。

リクエスト本文の params オブジェクトの _metaフィールドを使用して、デフォルト設定を変更できます。3LO 認証では、 _metaフィールドを次のオブジェクトにマッピングします。

{
    "aws.bedrock-agentcore.gateway/credentialProviderConfiguration": {
        "oauthcredentialProvider": {
            "returnUrl": "string",
            "forceAuthentication": bool
        }
    }
}

以下を行うことができます。

  • デフォルトの戻り URL を別の戻り URL で上書きするには、新しい を指定しますreturnUrl。

  • トークンボールトから以前の認証を削除し、リクエストの実行時に新しい認可 URL を返すには、forceAuthentication値を に設定しますtrue。

たとえば、次のリクエストでは、ゲートウェイターゲットを介してLinkedIn3LO___gateUserInfoツールを呼び出し、ユーザーに新しい認可 URL による認証を強制し、認証https://your-public-domain.com/callback後にユーザーを にリダイレクトします。

{
  "jsonrpc": "2.0",
  "id": 24,
  "method": "tools/call",
  "params": {
    "name": "LinkedIn3LO___getUserInfo",
    "arguments": {},
    "_meta": {
        "aws.bedrock-agentcore.gateway/credentialProviderConfiguration": {
            "oauthCredentialProvider": {
                "returnUrl": "https://your-public-domain.com/callback",
                "forceAuthentication": true
            }
        }
    }
  }
}