Method: projects.locations.collections.dataConnector.acquireAndStoreRefreshToken

Scambia le credenziali di autorizzazione OAuth con un token di aggiornamento e memorizza il token di aggiornamento e gli ambiti. I dati memorizzati verranno identificati dal nome del connettore e dall'identificatore utente dell'EUC.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatorio. Risorsa del connettore.

Il nome del connettore identifica il sistema di terze parti da utilizzare per l'autorizzazione. Viene utilizzato anche come chiave per memorizzare il token di aggiornamento.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "scopes": [
    string
  ],
  "fullRedirectUri": string,
  "instanceUri": string
}
Campi
scopes[]

string

Gli ambiti del codice di autorizzazione e del token di aggiornamento.
fullRedirectUri

string

Obbligatorio. L'URI a cui l'utente viene reindirizzato dopo l'autorizzazione, inclusi tutti i parametri. Ad esempio, https://example.com/redir?code=5
instanceUri

string

Facoltativo. L'URI dell'istanza per il connettore, se fornito, i connettori supportati utilizzeranno questo URI dell'istanza per creare l'URL di scambio dei token. Ad esempio, l'URI dell'istanza di Shopify è l'URL del negozio.

Corpo della risposta

Messaggio di risposta per il metodo DataConnectorService.AcquireAndStoreRefreshToken.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "additionalOauthResponses": [
    {
      object (AdditionalOAuthResponse)
    }
  ]
}
Campi
additionalOauthResponses[]

object (AdditionalOAuthResponse)

Facoltativo. Risposte OAuth aggiuntive dalla risposta di autorizzazione. Questo campo è facoltativo e non verrà sempre compilato. Dipende dal tipo di connettore e dalla risposta di autorizzazione.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti 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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • discoveryengine.dataConnectors.acquireAndStoreRefreshToken

Per saperne di più, consulta la documentazione di IAM.

AdditionalOAuthResponse

Risposte OAuth aggiuntive dalla risposta di autorizzazione.

Rappresentazione 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.
}
Campi
key

string

La chiave della risposta OAuth aggiuntiva.
Campo unione value. Il valore della risposta OAuth aggiuntiva. value può essere solo uno dei seguenti tipi:
stringValue

string

Il valore stringa della risposta OAuth aggiuntiva.
intValue

string (int64 format)

Il valore intero della risposta OAuth aggiuntiva.
boolValue

boolean

Il valore booleano della risposta OAuth aggiuntiva.