Method: projects.locations.collections.dataConnector.acquireAndStoreRefreshToken

Échange les identifiants d'autorisation OAuth contre un jeton d'actualisation, puis stocke le jeton d'actualisation et les habilitations. Les données stockées seront associées au nom du connecteur et à l'identifiant utilisateur de l'EUC.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Ressource de connecteur.

Le nom du connecteur identifie le système tiers à utiliser pour l'autorisation. Il est également utilisé comme clé pour stocker le jeton d'actualisation.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "scopes": [
    string
  ],
  "fullRedirectUri": string
}
Champs
scopes[]

string

Les niveaux d'accès du code d'autorisation et du jeton d'actualisation.
fullRedirectUri

string

Obligatoire. URI vers lequel l'utilisateur est redirigé après l'autorisation, y compris tous les paramètres. Exemple : https://example.com/redir?code=5

Corps de la réponse

Message de réponse pour la méthode DataConnectorService.AcquireAndStoreRefreshToken.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "additionalOauthResponses": [
    {
      object (AdditionalOAuthResponse)
    }
  ]
}
Champs
additionalOauthResponses[]

object (AdditionalOAuthResponse)

Facultatif. Réponses OAuth supplémentaires issues de la réponse d'autorisation. Ce champ est facultatif et ne sera pas toujours renseigné. Cela dépend du type de connecteur et de la réponse d'autorisation.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • discoveryengine.dataConnectors.acquireAndStoreRefreshToken

Pour en savoir plus, consultez la documentation IAM.

AdditionalOAuthResponse

Réponses OAuth supplémentaires issues de la réponse d'autorisation.

Représentation 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.
}
Champs
key

string

Clé de la réponse OAuth supplémentaire.
Champ d'union value. Valeur de la réponse OAuth supplémentaire. value ne peut être qu'un des éléments suivants :
stringValue

string

Valeur de chaîne de la réponse OAuth supplémentaire.
intValue

string (int64 format)

Valeur entière de la réponse OAuth supplémentaire.
boolValue

boolean

Valeur booléenne de la réponse OAuth supplémentaire.