Method: projects.locations.collections.dataConnector.acquireAccessToken

dataConnector.acquireAndStoreRefreshToken で生成されたユーザーごとの更新トークンを使用して、新しいアクセス トークンとその詳細を生成して返します。利用可能であればキャッシュからアクセス トークンを取得します。必要に応じて、保存されている更新トークンをローテーションします。エンドユーザー ID を使用して、そのユーザー固有のアクセス トークンを返します。管理者が構成した認証情報は返されません。アクションの実行と UI で使用されます。

HTTP リクエスト

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}:acquireAccessToken

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。トークンがクエリされるコネクタのリソース名。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "scope": string,
  "action": string
}
フィールド
scope

string

省略可。アクセス トークンをリクエストするスコープ。指定した場合、scope はデフォルトのスコープをオーバーライドします。
action

string

省略可。実行中のツール/アクションの名前。指定すると、サーバーはアクションに必要なスコープを確認し、不足している場合は増分認可を動的にトリガーします。

レスポンスの本文

DataConnectorService.AcquireAccessToken メソッドに対するレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "refreshTokenInfo": {
    object (RefreshTokenInfo)
  },
  "accessToken": string
}
フィールド
refreshTokenInfo

object (RefreshTokenInfo)

アクセス トークンの作成に使用された保存済みの更新トークンに関する情報。
accessToken

string

作成されたアクセス トークン。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • discoveryengine.dataConnectors.acquireAccessToken

詳細については、IAM のドキュメントをご覧ください。