REST Resource: projects.locations.authorizations

Ressource: Autorisierung

Discovery Engine-Autorisierungsressource.

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

string

ID. Ressourcenname der Autorisierung. Format: projects/{project}/locations/{location}/authorizations/{authorization}

Es muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.
displayName

string

Erforderlich. Der Anzeigename der Autorisierung.

Es muss ein UTF-8-codierter String mit einer Längenbeschränkung von 128 Zeichen sein.
Die Autorisierungskonfiguration. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
serverSideOauth2

object (ServerSideOAuth2)

Serverseitige OAuth2-Konfiguration.
Ende der sich gegenseitig ausschließenden Felder.

ServerSideOAuth2

OAuth-Konfiguration.

JSON-Darstellung 
{
  "clientId": string,
  "clientSecret": string,
  "tokenUri": string,
  "authorizationUri": string,
  "scopes": [
    string
  ],
  "pkceVerificationEnabled": boolean
}
Felder
clientId

string

Erforderlich. Die OAuth2-Client-ID.
clientSecret

string

Erforderlich. Der OAuth2-Clientschlüssel.

Im Ruhezustand verschlüsselt.
tokenUri

string

Erforderlich. Der HTTP-Endpunkt, der eine Clientautorisierung gegen ein Zugriffstoken tauscht.
authorizationUri

string

Erforderlich. Die URI, zu der der Nutzer weitergeleitet wird, wenn er sich autorisieren muss. Sie sollte alle Angaben für die erfolgreiche Autorisierung enthalten, also OAuth-ID, zusätzliche Flags usw. Beispiel: 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

Der Parameter redirectUri wird vom Vertex AI Search-Frontend überschrieben.
scopes[]

string

Optional. Die Bereiche, die angefordert werden sollen. Beispiel: https://www.googleapis.com/auth/calendar.events Wenn dieser Parameter nicht angegeben wird, werden keine zusätzlichen Bereiche angefordert, die über die für die Autorisierungs-URI erforderlichen Bereiche hinausgehen. Wenn dieser Parameter festgelegt ist, werden die Bereiche in der Autorisierungs-URI überschrieben, wenn die Nutzerautorisierung erworben wird.
pkceVerificationEnabled

boolean

Optional. Gibt an, ob die PKCE-Überprüfung aktiviert werden soll. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/

Methoden

acquireUserAuthorization

 Verwendet das gespeicherte Aktualisierungstoken für den Nutzer, der durch seine Endnutzeranmeldedaten und die angegebene Ressource identifiziert wird, und gibt das generierte Zugriffstoken und seine Details zurück.

create

 Erstellt eine Authorization.

delete

 Löscht einen Authorization.

get

 Ruft einen Authorization ab.

list

 Listet alle Authorizations unter einer Engine auf.

patch

 Aktualisiert einen Authorization.

storeUserAuthorization

 Tauscht OAuth-Anmeldedaten für die Autorisierung gegen ein Aktualisierungstoken ein und speichert das Aktualisierungstoken und die Bereiche.