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 clavearán por 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 usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
name

string

Obligatorio. Recurso del conector.

El nombre del conector identifica el sistema de terceros que se 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 con la siguiente estructura:

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

string

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

string

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

string

Es opcional. El URI de la instancia para el conector. Si se proporciona, los conectores compatibles usarán este URI de instancia para construir la URL de intercambio de tokens. Por ejemplo, el URI de instancia de Shopify es la URL de la tienda.

Cuerpo de la respuesta

Mensaje de respuesta para el método DataConnectorService.AcquireAndStoreRefreshToken.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

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

object (AdditionalOAuthResponse)

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

Permisos de autorización

Se necesita uno de los siguientes permisos de 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

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

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • discoveryengine.dataConnectors.acquireAndStoreRefreshToken

Para obtener más información, consulta la documentación de IAM.

AdditionalOAuthResponse

Respuestas adicionales de OAuth 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

La clave de la respuesta adicional de OAuth.
Campo de unión value. El valor de la respuesta adicional de OAuth. value puede ser solo uno de los parámetros siguientes:
stringValue

string

El valor de cadena de la respuesta adicional de OAuth.
intValue

string (int64 format)

El valor entero de la respuesta adicional de OAuth.
boolValue

boolean

El valor booleano de la respuesta adicional de OAuth.