REST Resource: projects.locations.authorizations

Recurso: Authorization

Recurso de autorização do Discovery Engine.

Representação 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. Nome do recurso da autorização. Formato: projects/{project}/locations/{location}/authorizations/{authorization}

Tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
displayName

string

Obrigatório. O nome a apresentar da autorização.

Tem de ser uma string codificada em UTF-8 com um limite de 128 carateres.
Campo de união authorization_config. A configuração de autorização. authorization_config só pode ser uma das seguintes opções:
serverSideOauth2

object (ServerSideOAuth2)

Configuração do OAuth2 do lado do servidor.

ServerSideOAuth2

Configuração do OAuth2.

Representação JSON 
{
  "clientId": string,
  "clientSecret": string,
  "tokenUri": string,
  "authorizationUri": string,
  "scopes": [
    string
  ]
}
Campos
clientId

string

Obrigatório. O ID de cliente OAuth2.
clientSecret

string

Obrigatório. O segredo do cliente OAuth2.

Encriptados em repouso.
tokenUri

string

Obrigatório. O ponto final HTTP que troca uma autorização de cliente por um token de acesso.
authorizationUri

string

Obrigatório. O URI para o qual o utilizador é direcionado quando precisa de autorização. Deve incluir tudo o que é necessário para uma autorização bem-sucedida: ID de OAuth, flags adicionais, etc. Exemplo: 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

O parâmetro redirectUri é substituído pelo front-end do Vertex AI Search.
scopes[]

string

Obrigatório. Os âmbitos a pedir. Exemplo: https://www.googleapis.com/auth/calendar.events

Métodos

acquireUserAuthorization

 Usa o token de atualização armazenado para o utilizador identificado pelas respetivas credenciais de utilizador final e o recurso fornecido, e devolve o token de acesso gerado e os respetivos detalhes.

create

 Cria um Authorization.

delete

 Elimina um Authorization.

get

 Obtém um Authorization.

list

 Apresenta todos os Authorizations num Engine.

patch

 Atualiza um Authorization

storeUserAuthorization

 Troca as credenciais de autorização OAuth por um símbolo de atualização e armazena o símbolo de atualização e os âmbitos.