Method: projects.locations.collections.dataConnector.checkRefreshToken

Deprecated: Checks the existence of a refresh token for the EUC user for a given connection and returns its details. Use dataConnector.acquireAccessToken instead and then check the validity of the returned token by asking the 3rd party system. There's no way to know for sure if a refresh token is valid without asking the 3rd party system.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the connector for which a token is queried.

Request body

The request body must be empty.

Response body

Response message for the DataConnectorService.CheckRefreshToken method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "refreshTokenInfo": {
    object (RefreshTokenInfo)
  }
}
Fields
refreshTokenInfo

object (RefreshTokenInfo)

Info about the stored refresh token.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.dataConnectors.checkRefreshToken

For more information, see the IAM documentation.