Method: projects.locations.authorizations.acquireUserAuthorization

エンドユーザーの認証情報と指定されたリソースで識別されるユーザーの保存済み更新トークンを使用して、生成されたアクセス トークンとその詳細を返します。使用可能な場合は、キャッシュからアクセス トークンを取得します。必要に応じて、保存されている更新トークンをローテーションします。

HTTP リクエスト

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/authorizations/*}:acquireUserAuthorization

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

パスパラメータ

パラメータ
name

string

必須。Authorization のリソース名。形式: projects/{project}/locations/{location}/authorizations/{authorization}

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

[AuthorizationService.AcquireAuthorization][] メソッドのレスポンス メッセージ。

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

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

object (RefreshTokenInfo)

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

accessToken

string

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

authorizationUri

string

認可フローをトリガーする URI。ユーザーを(再)承認する必要があるタイミングを設定します。

認可スコープ

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

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

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

RefreshTokenInfo

更新トークンについて説明します。

JSON 表現
{
  "scopes": [
    string
  ]
}
フィールド
scopes[]

string

このトークンのスコープのリスト。