REST Resource: projects.locations.authorizations

Recurso: Authorization

Es el recurso de autorización de Discovery Engine.

Representación 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.
}
Campos
name

string

Es el identificador. Es el nombre del recurso de la autorización. Formato: projects/{project}/locations/{location}/authorizations/{authorization}

Debe ser una cadena codificada en UTF-8 con un límite de 1,024 caracteres.
displayName

string

Obligatorio. Es el nombre visible de la autorización.

Debe ser una cadena codificada en UTF-8 con un límite de 128 caracteres.
Es la configuración de autorización. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
serverSideOauth2

object (ServerSideOAuth2)

Es la configuración de OAuth2 del servidor.
Fin de los campos mutuamente excluyentes.

ServerSideOAuth2

Es la configuración de OAuth2.

Representación JSON 
{
  "clientId": string,
  "clientSecret": string,
  "tokenUri": string,
  "authorizationUri": string,
  "scopes": [
    string
  ],
  "pkceVerificationEnabled": boolean,
  "basicAuthenticationEnabled": boolean,
  "privateNetworkConfig": {
    object (PrivateNetworkConfig)
  }
}
Campos
clientId

string

Obligatorio. Es el ID de cliente de OAuth2.
clientSecret

string

Obligatorio. Es el secreto del cliente de OAuth2.

Los datos se encriptan en reposo.
tokenUri

string

Obligatorio. Es el extremo HTTP que intercambia una autorización del cliente por un token de acceso.
authorizationUri

string

Obligatorio. Es el URI al que se dirige al usuario cuando necesita autorizar. Debe incluir todo lo necesario para una autorización exitosa: ID de OAuth, marcas adicionales, etcétera. Ejemplo: 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

El parámetro redirectUri se anulará con el frontend de Vertex AI Search.
scopes[]

string

Es opcional. Son los permisos que se solicitarán. Ejemplo: https://www.googleapis.com/auth/calendar.events Si se omite, no se solicitan permisos adicionales más allá de los que requiere el URI de autorización. Si se configura, se reemplazarán los alcances en el URI de autorización cuando se adquiera la autorización del usuario.
pkceVerificationEnabled

boolean

Es opcional. Indica si se debe habilitar la verificación de PKCE. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/
basicAuthenticationEnabled

boolean

Es opcional. Indica si el intercambio de tokens de OAuth usa la autenticación básica HTTP (client_secret_basic) en lugar de enviar las credenciales del cliente en el cuerpo de la solicitud (client_secret_post). Cuando es true, las credenciales (clientId:clientSecret) se codifican en Base64 y se envían en el encabezado Authorization. Algunos proveedores de OAuth (p.ej., Splunk) requieren client_secret_basic. Cuando false o no se establece, se usa el client_secret_post predeterminado.
privateNetworkConfig

object (PrivateNetworkConfig)

Es opcional. Solo se configura cuando el proveedor de OAuth no publica ningún extremo público, en cuyo caso el intercambio de tokens debe enrutarse a través de la red privada en la que se encuentra la instancia en lugar de a través de la salida pública. Si no se configura, el intercambio se mantiene en la salida pública.

PrivateNetworkConfig

Identifica la instancia que aloja un proveedor de OAuth al que solo se puede acceder a través de una red privada.

Representación JSON 
{
  "instanceResource": string
}
Campos
instanceResource

string

Obligatorio. Es el nombre del recurso de la instancia que aloja el proveedor de OAuth. En el caso de Looker, la instancia de Looker, con el formato projects/{project}/locations/{location}/instances/{instance}.

Métodos

acquireUserAuthorization

 Usa el token de actualización almacenado para el usuario identificado por sus credenciales de usuario final y el recurso determinado, y devuelve el token de acceso generado y sus detalles.

create

 Crea un Authorization.

delete

 Borra un Authorization.

get

 Obtiene un Authorization.

list

 Enumera todos los Authorization en un Engine.

patch

 Actualiza un Authorization

storeUserAuthorization

 Intercambia credenciales de autorización de OAuth por un token de actualización y almacena el token de actualización y los permisos.