REST Resource: projects.locations.authorizations

Recurso: Authorization

Recurso de autorización de Discovery Engine.

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

string

Identificador. Nombre de 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 1024 caracteres.
displayName

string

Obligatorio. Nombre visible de la autorización.

Debe ser una cadena codificada en UTF-8 con una longitud máxima de 128 caracteres.
Campo de unión authorization_config. La configuración de autorización. authorization_config solo puede ser una de estas dos opciones:
serverSideOauth2

object (ServerSideOAuth2)

Configuración de OAuth2 del lado del servidor.

ServerSideOAuth2

Configuración de OAuth2.

Representación JSON 
{
  "clientId": string,
  "clientSecret": string,
  "tokenUri": string,
  "authorizationUri": string,
  "scopes": [
    string
  ]
}
Campos
clientId

string

Obligatorio. El ID de cliente de OAuth2.
clientSecret

string

Obligatorio. El secreto de cliente de OAuth 2.0.

Encriptados en reposo.
tokenUri

string

Obligatorio. El punto de conexión HTTP que intercambia una autorización de cliente por un token de acceso.
authorizationUri

string

Obligatorio. URI al que se dirige al usuario cuando necesita autorizar. Debe incluir todo lo necesario para que la autorización se realice correctamente: ID de OAuth, indicadores adicionales, etc. Por 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 frontend de Vertex AI Search sobrescribirá el parámetro redirectUri.
scopes[]

string

Obligatorio. Los permisos que se van a solicitar. Ejemplo: https://www.googleapis.com/auth/calendar.events

Métodos

acquireUserAuthorization

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

create

 Crea un Authorization.

delete

 Elimina un Authorization.

get

 Obtiene un Authorization.

list

 Muestra todos los Authorizations de un Engine.

patch

 Actualiza un Authorization.

storeUserAuthorization

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