REST Resource: projects.locations.authorizations

Risorsa: Autorizzazione

Risorsa di autorizzazione Discovery Engine.

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,

  // Union field authorization_config can be only one of the following:
  "serverSideOauth2": {
    object (ServerSideOAuth2)
  }
  // End of list of possible types for union field authorization_config.
}
Campi
name

string

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

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

string

Obbligatorio. Il nome visualizzato dell'autorizzazione.

Deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 128 caratteri.
Campo unione authorization_config. La configurazione dell'autorizzazione. authorization_config può essere solo uno dei seguenti:
serverSideOauth2

object (ServerSideOAuth2)

Configurazione OAuth2 lato server.

ServerSideOAuth2

Configurazione OAuth2.

Rappresentazione JSON 
{
  "clientId": string,
  "clientSecret": string,
  "tokenUri": string,
  "authorizationUri": string,
  "scopes": [
    string
  ]
}
Campi
clientId

string

Obbligatorio. L'ID client OAuth2.
clientSecret

string

Obbligatorio. Il client secret OAuth2.

Crittografati 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 ciò che è 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

Obbligatorio. Gli ambiti da richiedere. Esempio: https://www.googleapis.com/auth/calendar.events

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.