REST Resource: projects.locations.authorizations

Ressource : Authorization

Ressource d'autorisation Discovery Engine.

Représentation JSON 
{
  "name": string,
  "displayName": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "serverSideOauth2": {
    object (ServerSideOAuth2)
  }
  // End of mutually exclusive fields.
}
Champs
name

string

Identifiant. Nom de ressource de l'autorisation. Format: projects/{project}/locations/{location}/authorizations/{authorization}

Il doit s'agir d'une chaîne encodée au format UTF-8 d'une longueur maximale de 1 024 caractères.
displayName

string

Obligatoire. Nom à afficher de l'autorisation.

Il doit s'agir d'une chaîne encodée au format UTF-8 d'une longueur maximale de 128 caractères.
Configuration de l'autorisation. Voici une liste de champs mutuellement exclusifs. Au maximum, un seul de ces champs sera défini dans une réponse :
serverSideOauth2

object (ServerSideOAuth2)

Configuration OAuth2 côté serveur.
Fin des champs mutuellement exclusifs.

ServerSideOAuth2

Configuration OAuth2.

Représentation JSON 
{
  "clientId": string,
  "clientSecret": string,
  "tokenUri": string,
  "authorizationUri": string,
  "scopes": [
    string
  ],
  "pkceVerificationEnabled": boolean
}
Champs
clientId

string

Obligatoire. ID client OAuth2.
clientSecret

string

Obligatoire. Code secret du client OAuth2.

Chiffré au repos.
tokenUri

string

Obligatoire. Point de terminaison HTTP qui échange une autorisation client contre un jeton d'accès.
authorizationUri

string

Obligatoire. URI vers laquelle l'utilisateur est redirigé lorsqu'il doit autoriser. Doit inclure tout ce qui est nécessaire pour une autorisation réussie : ID OAuth, indicateurs supplémentaires, etc. Exemple : https://accounts.google.com/o/oauth2/v2/auth?clientId=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&responseType=code&access_type=offline&prompt=consent

Le paramètre redirectUri sera remplacé par l'interface utilisateur de Vertex AI Search.
scopes[]

string

Facultatif. Habilitations à demander. Exemple : https://www.googleapis.com/auth/calendar.events. Si ce champ est omis, aucune habilitation supplémentaire n'est demandée au-delà de celles requises par l'URI d'autorisation. Si ce champ est défini, il remplace les habilitations de l'URI d'autorisation lors de l'acquisition de l'autorisation utilisateur.
pkceVerificationEnabled

boolean

Facultatif. Indique s'il faut activer la validation PKCE. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/

Méthodes

acquireUserAuthorization

 Utilise le jeton d'actualisation stocké pour l'utilisateur identifié par ses identifiants d'utilisateur final et la ressource donnée, puis renvoie le jeton d'accès généré et ses détails.

create

 Crée une Authorization.

delete

 Supprime une Authorization.

get

 Récupère une Authorization.

list

 Répertorie toutes les Authorization sous un Engine.

patch

 Met à jour une Authorization.

storeUserAuthorization

 Échange les identifiants d'autorisation OAuth contre un jeton d'actualisation, puis stocke le jeton d'actualisation et les habilitations.