REST Resource: projects.locations.authorizations

Risorsa: Authorization

Risorsa di autorizzazione Discovery Engine.

Rappresentazione 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.
}
Campi
name

string

Identificatore. Nome risorsa dell'autorizzazione. Formato: projects/{project}/locations/{location}/authorizations/{authorization}

Deve essere una stringa con codifica UTF-8 con un limite di lunghezza di 1024 caratteri.
displayName

string

Obbligatorio. Il nome visualizzato dell'autorizzazione.

Deve essere una stringa con codifica UTF-8 con un limite di lunghezza di 128 caratteri.
La configurazione dell'autorizzazione. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
serverSideOauth2

object (ServerSideOAuth2)

Configurazione OAuth2 lato server.
Fine dei campi che si escludono a vicenda.

ServerSideOAuth2

Configurazione OAuth2.

Rappresentazione JSON 
{
  "clientId": string,
  "clientSecret": string,
  "tokenUri": string,
  "authorizationUri": string,
  "scopes": [
    string
  ],
  "pkceVerificationEnabled": boolean,
  "basicAuthenticationEnabled": boolean,
  "privateNetworkConfig": {
    object (PrivateNetworkConfig)
  }
}
Campi
clientId

string

Obbligatorio. L'ID client OAuth2.
clientSecret

string

Obbligatorio. Il client secret OAuth2.

Criptati at-rest.
tokenUri

string

Obbligatorio. L'endpoint HTTP che scambia un'autorizzazione client con un token di accesso.
authorizationUri

string

Obbligatorio. L'URI a cui viene indirizzato l'utente quando deve autorizzare. Deve includere tutto il necessario per un'autorizzazione riuscita: ID OAuth, flag aggiuntivi e così via. Esempio: 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

Il parametro redirectUri verrà sovrascritto dal frontend di Vertex AI Search.
scopes[]

string

Facoltativo. Gli ambiti da richiedere. Esempio: https://www.googleapis.com/auth/calendar.events Se omesso, non vengono richiesti ambiti aggiuntivi oltre a quelli richiesti dall'URI di autorizzazione. Se impostato, sovrascriverà gli ambiti nell'URI di autorizzazione durante l'acquisizione dell'autorizzazione utente.
pkceVerificationEnabled

boolean

Facoltativo. Indica se abilitare la verifica PKCE. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/
basicAuthenticationEnabled

boolean

Facoltativo. Indica se lo scambio di token OAuth utilizza l'autenticazione di base HTTP (client_secret_basic) anziché inviare le credenziali client nel corpo della richiesta (client_secret_post). Quando true, le credenziali (clientId:clientSecret) vengono codificate in Base64 e inviate nell'intestazione Authorization. Alcuni provider OAuth (ad es. Splunk) richiedono client_secret_basic. Quando false o non è impostato, viene utilizzato il valore predefinito client_secret_post.
privateNetworkConfig

object (PrivateNetworkConfig)

Facoltativo. Impostato solo quando il provider OAuth non pubblica alcun endpoint pubblico, nel qual caso lo scambio di token deve essere instradato sulla rete privata in cui si trova l'istanza anziché sull'uscita pubblica. Se non viene configurato, lo scambio rimane sull'uscita pubblica.

PrivateNetworkConfig

Identifica l'istanza che ospita un provider OAuth raggiungibile solo tramite una rete privata.

Rappresentazione JSON 
{
  "instanceResource": string
}
Campi
instanceResource

string

Obbligatorio. Nome della risorsa dell'istanza che ospita il provider OAuth. Per Looker, l'istanza Looker, nel formato projects/{project}/locations/{location}/instances/{instance}.

Metodi

acquireUserAuthorization

 Utilizza il token di aggiornamento memorizzato per l'utente identificato dalle credenziali dell'utente finale e dalla risorsa specificata e restituisce il token di accesso generato e i relativi dettagli.

create

 Crea un Authorization.

delete

 Elimina un Authorization.

get

 Riceve un Authorization.

list

 Elenca tutti i Authorization in un Engine.

patch

 Aggiorna un Authorization

storeUserAuthorization

 Scambia le credenziali di autorizzazione OAuth con un token di aggiornamento e memorizza il token di aggiornamento e gli ambiti.