Method: projects.locations.collections.dataConnector.acquireAndStoreRefreshToken

OAuth 認証情報を更新トークンと交換し、更新トークンとスコープを保存します。保存されたデータは、EUC のコネクタ名とユーザー ID をキーとして使用します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
name

string

必須。コネクタ リソース。

コネクタ名は、認可に使用するサードパーティ システムを識別します。これは更新トークンを保存するためのキーとしても使用されます。

リクエストの本文

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

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

string

認証コードと更新トークンのスコープ。
fullRedirectUri

string

必須。認可後にユーザーがリダイレクトされる URI（すべてのパラメータを含む）。例: https://example.com/redir?code=5
instanceUri

string

省略可。コネクタのインスタンス URI が指定されている場合、サポートされているコネクタはこのインスタンス URI を使用してトークン交換 URL を構築します。たとえば、Shopify インスタンス URI はショップ URL です。

レスポンスの本文

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

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "additionalOauthResponses": [
    {
      object (AdditionalOAuthResponse)
    }
  ]
}
フィールド
additionalOauthResponses[]

object (AdditionalOAuthResponse)

省略可。認可レスポンスからの追加の OAuth レスポンス。このフィールドは省略可能で、必ずしも入力されるとは限りません。コネクタのタイプと認可レスポンスによって異なります。

認可スコープ

次の 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.acquireAndStoreRefreshToken

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

AdditionalOAuthResponse

認可レスポンスからの追加の OAuth レスポンス。

JSON 表現 
{
  "key": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringValue": string,
  "intValue": string,
  "boolValue": boolean
  // End of mutually exclusive fields.
}
フィールド
key

string

追加の OAuth レスポンスのキー。
追加の OAuth レスポンスの値。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
stringValue

string

追加の OAuth レスポンスの文字列値。
intValue

string (int64 format)

追加の OAuth レスポンスの整数値。
boolValue

boolean

追加の OAuth レスポンスのブール値。
相互に排他的なフィールドの終了。