Method: projects.locations.collections.dataConnector.checkRefreshToken

非推奨: 指定された接続の EUC ユーザーの更新トークンの有無を確認し、その詳細を返します。代わりに dataConnector.acquireAccessToken を使用し、サードパーティ システムに問い合わせて返されたトークンの有効性を確認します。サードパーティ システムに問い合わせることなく、更新トークンが有効かどうかを確実に知る方法はありません。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
name

string

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

リクエストの本文

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

レスポンスの本文

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

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

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

object (RefreshTokenInfo)

保存された更新トークンに関する情報。

認可スコープ

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

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

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

IAM 権限

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

  • discoveryengine.dataConnectors.checkRefreshToken

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