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,
  "basicAuthenticationEnabled": boolean,
  "privateNetworkConfig": {
    object (PrivateNetworkConfig)
  }
}
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 ausgelassen, werden keine zusätzlichen Bereiche angefordert, die über die vom Autorisierungs-URI erforderlichen Bereiche hinausgehen. Wenn diese Option festgelegt ist, werden die Bereiche in der Autorisierungs-URI beim Einholen der Nutzerautorisierung überschrieben.
pkceVerificationEnabled

boolean

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

boolean

Optional. Gibt an, ob für den OAuth-Tokenaustausch die HTTP-Basisauthentifizierung (client_secret_basic) verwendet wird, anstatt die Clientanmeldedaten im Anfragetext (client_secret_post) zu senden. Wenn true, werden die Anmeldedaten (clientId:clientSecret) Base64-codiert und im Authorization-Header gesendet. Für einige OAuth-Anbieter (z.B. Splunk) ist client_secret_basic erforderlich. Wenn false oder nicht festgelegt, wird die Standard-client_secret_post verwendet.
privateNetworkConfig

object (PrivateNetworkConfig)

Optional. Wird nur festgelegt, wenn der OAuth-Anbieter keinen öffentlichen Endpunkt veröffentlicht. In diesem Fall muss ein Tokenaustausch über das private Netzwerk erfolgen, in dem sich die Instanz befindet, und nicht über den öffentlichen Egress. Wenn Sie sie nicht festlegen, bleibt der Austausch im öffentlichen Ausgang.

PrivateNetworkConfig

Gibt die Instanz an, auf der ein OAuth-Anbieter gehostet wird, der nur über ein privates Netzwerk erreichbar ist.

JSON-Darstellung 
{
  "instanceResource": string
}
Felder
instanceResource

string

Erforderlich. Der Ressourcenname der Instanz, auf der der OAuth-Anbieter gehostet wird. Bei Looker die Looker-Instanz im Format projects/{project}/locations/{location}/instances/{instance}.

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.