Method: projects.locations.collections.dataConnector.acquireAndStoreRefreshToken

Intercambia 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 indexarán según el nombre del conector y el identificador del usuario de la EUC.

Solicitud HTTP


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

Las URL usan la sintaxis de transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. Es el 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

Son los permisos del código de autorización y el token de actualización.

fullRedirectUri

string

Obligatorio. Es 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. Es el URI de la instancia del conector. Si se proporciona, los conectores compatibles usarán este URI para construir la URL de intercambio de tokens. Por ejemplo, el URI de la 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. Son respuestas adicionales de OAuth que se obtienen de la respuesta de autorización. Este campo es opcional y no siempre se completará. 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

Son respuestas adicionales de OAuth que se obtienen de la respuesta de autorización.

Representación 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.
}
Campos
key

string

Es la clave de la respuesta de OAuth adicional.

Es el valor de la respuesta de OAuth adicional. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
stringValue

string

Es el valor de cadena de la respuesta de OAuth adicional.

intValue

string (int64 format)

Es el valor entero de la respuesta de OAuth adicional.

boolValue

boolean

Es el valor booleano de la respuesta de OAuth adicional.

Fin de los campos mutuamente excluyentes.