REST Resource: projects.locations.authorizations

Recurso: autorização

Recurso de autorização do Discovery Engine.

Representação 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

Identificador. Nome do recurso da autorização. Formato: projects/{project}/locations/{location}/authorizations/{authorization}

Precisa ser uma string codificada em UTF-8 com um limite de comprimento de 1.024 caracteres.
displayName

string

Obrigatório. O nome de exibição da autorização.

Precisa ser uma string codificada em UTF-8 com um limite de comprimento de 128 caracteres.
A configuração de autorização. A seguir, uma lista de campos mutuamente exclusivos. No máximo, um dos campos será definido em uma resposta:
serverSideOauth2

object (ServerSideOAuth2)

Configuração do OAuth2 do lado do servidor.
Fim dos campos mutuamente exclusivos.

ServerSideOAuth2

Configuração do OAuth2.

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

string

Obrigatório. O ID do cliente OAuth2.
clientSecret

string

Obrigatório. O chave secreta do cliente OAuth2.

Criptografado em repouso.
tokenUri

string

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

string

Obrigatório. O URI para o qual o usuário é direcionado quando precisa autorizar. Inclui tudo o que é necessário para uma autorização bem-sucedida: ID do OAuth, flags extras 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 será substituído pelo front-end da Vertex AI para Pesquisa.
scopes[]

string

Opcional. Os escopos a serem solicitados. Exemplo: https://www.googleapis.com/auth/calendar.events. Se omitido, nenhum outro escopo será solicitado além daqueles exigidos pelo URI de autorização. Se definido, ele vai substituir os escopos no URI de autorização ao adquirir a autorização do usuário.
pkceVerificationEnabled

boolean

Opcional. Se a verificação de PKCE deve ser ativada. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/

Métodos

acquireUserAuthorization

 Usa o token de atualização armazenado para o usuário identificado pelas credenciais do usuário final e o recurso fornecido e retorna o token de acesso gerado e os detalhes dele.

create

 Cria uma Authorization.

delete

 Exclui uma Authorization.

get

 Recebe uma Authorization.

list

 Lista todas as Authorizations em uma Engine.

patch

 Atualiza uma Authorization

storeUserAuthorization

 Troca as credenciais de autorização do OAuth por um token de atualização e armazena o token de atualização e os escopos.