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, dont la longueur ne doit pas dépasser 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, dont la longueur ne doit pas dépasser 128 caractères.
Configuration de l'autorisation. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
serverSideOauth2

object (ServerSideOAuth2)

Configuration OAuth2 côté serveur.
Fin des champs qui s'excluent mutuellement.

ServerSideOAuth2

Configuration OAuth2.

Représentation JSON 
{
  "clientId": string,
  "clientSecret": string,
  "tokenUri": string,
  "authorizationUri": string,
  "scopes": [
    string
  ],
  "pkceVerificationEnabled": boolean,
  "basicAuthenticationEnabled": boolean,
  "privateNetworkConfig": {
    object (PrivateNetworkConfig)
  }
}
Champs
clientId

string

Obligatoire. ID client OAuth2.
clientSecret

string

Obligatoire. Code secret du client OAuth2.

Chiffrées 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 lequel l'utilisateur est redirigé lorsqu'il doit autoriser l'accès. 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 le frontend Vertex AI Search.
scopes[]

string

Facultatif. Habilitations à demander. Exemple : https://www.googleapis.com/auth/calendar.events Si cette valeur est omise, aucune habilitation supplémentaire n'est demandée en plus de celles requises par l'URI d'autorisation. Si cette valeur est définie, elle remplace les champs d'application dans l'URI d'autorisation lors de l'obtention de l'autorisation de l'utilisateur.
pkceVerificationEnabled

boolean

Facultatif. Indique si la vérification PKCE doit être activée. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/
basicAuthenticationEnabled

boolean

Facultatif. Indique si l'échange de jetons OAuth utilise l'authentification de base HTTP (client_secret_basic) au lieu d'envoyer les identifiants client dans le corps de la requête (client_secret_post). Lorsque la valeur est true, les identifiants (clientId:clientSecret) sont encodés en Base64 et envoyés dans l'en-tête Authorization. Certains fournisseurs OAuth (par exemple, Splunk) nécessitent client_secret_basic. Lorsque false ou non défini, la client_secret_post par défaut est utilisée.
privateNetworkConfig

object (PrivateNetworkConfig)

Facultatif. Défini uniquement lorsque le fournisseur OAuth ne publie aucun point de terminaison public. Dans ce cas, un échange de jetons doit être acheminé sur le réseau privé sur lequel se trouve l'instance au lieu d'être acheminé sur la sortie publique. Si vous ne la configurez pas, l'échange reste sur la sortie publique.

PrivateNetworkConfig

Identifie l'instance hébergeant un fournisseur OAuth accessible uniquement sur un réseau privé.

Représentation JSON 
{
  "instanceResource": string
}
Champs
instanceResource

string

Obligatoire. Nom de ressource de l'instance hébergeant le fournisseur OAuth. Pour Looker, il s'agit de l'instance Looker, au format projects/{project}/locations/{location}/instances/{instance}.

Méthodes

acquireUserAuthorization

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

create

 Crée un Authorization.

delete

 Supprime un Authorization.

get

 Récupère un Authorization.

list

 Répertorie tous les Authorization d'un Engine.

patch

 Met à jour un Authorization

storeUserAuthorization

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