Method: projects.locations.collections.dataConnector.acquireAndStoreRefreshToken

Tauscht OAuth-Autorisierungsanmeldedaten gegen ein Aktualisierungstoken ein und speichert das Aktualisierungstoken und die Bereiche. Die gespeicherten Daten werden anhand des Connectornamens und der Nutzer-ID aus der Einwilligungserklärung für Nutzer in der EU indexiert.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Connector-Ressource.

Der Connector-Name gibt das Drittanbietersystem an, das für die Autorisierung verwendet werden soll. Er wird auch als Schlüssel zum Speichern des Aktualisierungstokens verwendet.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "scopes": [
    string
  ],
  "fullRedirectUri": string
}
Felder
scopes[]

string

Die Bereiche des Autorisierungscodes und des Aktualisierungstokens.
fullRedirectUri

string

Erforderlich. Die URI, zu der der Nutzer nach der Autorisierung weitergeleitet wird, einschließlich aller Parameter. z. B. https://example.com/redir?code=5

Antworttext

Antwortnachricht für die Methode DataConnectorService.AcquireAndStoreRefreshToken.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "additionalOauthResponses": [
    {
      object (AdditionalOAuthResponse)
    }
  ]
}
Felder
additionalOauthResponses[]

object (AdditionalOAuthResponse)

Optional. Zusätzliche OAuth-Antworten aus der Autorisierungsantwort. Dieses Feld ist optional und wird nicht immer ausgefüllt. Das hängt vom Typ des Connectors und der Autorisierungsantwort ab.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource name:

  • discoveryengine.dataConnectors.acquireAndStoreRefreshToken

Weitere Informationen finden Sie in der IAM-Dokumentation.

AdditionalOAuthResponse

Zusätzliche OAuth-Antworten aus der Autorisierungsantwort.

JSON-Darstellung 
{
  "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.
}
Felder
key

string

Der Schlüssel der zusätzlichen OAuth-Antwort.
Union-Feld value. Der Wert der zusätzlichen OAuth-Antwort. Für value ist nur einer der folgenden Werte zulässig:
stringValue

string

Der Stringwert der zusätzlichen OAuth-Antwort.
intValue

string (int64 format)

Der Ganzzahlwert der zusätzlichen OAuth-Antwort.
boolValue

boolean

Der boolesche Wert der zusätzlichen OAuth-Antwort.