Method: projects.locations.collections.dataConnector.acquireAndStoreRefreshToken

Intercambia las credenciales de autorización de OAuth por un token de actualización y almacena el token de actualización y los permisos. Los datos almacenados se asociarán con el nombre del conector y el identificador de usuario de la EUC.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
name

string

Obligatorio. Recurso de conector.

El nombre del conector identifica el sistema de terceros que se va a usar para la autorización. También se usa como clave para almacenar el token de actualización.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos que presentan la siguiente estructura:

Representación JSON 
{
  "scopes": [
    string
  ],
  "fullRedirectUri": string
}
Campos
scopes[]

string

Los permisos del código de autorización y del token de actualización.
fullRedirectUri

string

Obligatorio. El URI al que se redirige al usuario después de la autorización, incluidos todos los parámetros. Por ejemplo, https://example.com/redir?code=5

Cuerpo de la respuesta

Mensaje de respuesta del método DataConnectorService.AcquireAndStoreRefreshToken.

Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:

Representación JSON 
{
  "additionalOauthResponses": [
    {
      object (AdditionalOAuthResponse)
    }
  ]
}
Campos
additionalOauthResponses[]

object (AdditionalOAuthResponse)

Opcional. Respuestas de OAuth adicionales de la respuesta de autorización. Este campo es opcional y no siempre se rellenará. Depende del tipo de conector y de la respuesta de autorización.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso name:

  • discoveryengine.dataConnectors.acquireAndStoreRefreshToken

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

AdditionalOAuthResponse

Respuestas de OAuth adicionales de la respuesta de autorización.

Representación JSON 
{
  "key": string,

  // Union field value can be only one of the following:
  "stringValue": string,
  "intValue": string,
  "boolValue": boolean
  // End of list of possible types for union field value.
}
Campos
key

string

Clave de la respuesta OAuth adicional.
Campo de unión value. Valor de la respuesta de OAuth adicional. value solo puede ser una de estas dos opciones:
stringValue

string

Valor de cadena de la respuesta de OAuth adicional.
intValue

string (int64 format)

Valor entero de la respuesta de OAuth adicional.
boolValue

boolean

Valor booleano de la respuesta de OAuth adicional.