REST Resource: projects.locations.authorizations

Recurso: Authorization

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 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 128 caracteres.
A configuração de autorização. Confira 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,
  "basicAuthenticationEnabled": boolean,
  "privateNetworkConfig": {
    object (PrivateNetworkConfig)
  }
}
Campos
clientId

string

Obrigatório. O ID do cliente OAuth2.
clientSecret

string

Obrigatório. A chave secreta do cliente OAuth2.

Criptografados 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 onde o usuário é direcionado quando precisa autorizar. Inclua 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 escopo extra 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. Indica se a verificação de PKCE precisa ser ativada. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/
basicAuthenticationEnabled

boolean

Opcional. Se a troca de token OAuth usa autenticação básica HTTP (client_secret_basic) em vez de enviar as credenciais do cliente no corpo da solicitação (client_secret_post). Quando true, as credenciais (clientId:clientSecret) são codificadas em Base64 e enviadas no cabeçalho Authorization. Alguns provedores OAuth (por exemplo, Splunk) exigem client_secret_basic. Quando false ou não definido, o client_secret_post padrão é usado.
privateNetworkConfig

object (PrivateNetworkConfig)

Opcional. Definido somente quando o provedor OAuth não publica um endpoint público. Nesse caso, uma troca de token precisa ser encaminhada pela rede particular em que a instância está, em vez de pelo saída pública. Se ela não for definida, a troca vai continuar no encaminhamento público.

PrivateNetworkConfig

Identifica a instância que hospeda um provedor OAuth acessível apenas por uma rede particular.

Representação JSON 
{
  "instanceResource": string
}
Campos
instanceResource

string

Obrigatório. Nome do recurso da instância que hospeda o provedor OAuth. Para o Looker, a instância do Looker, no formato projects/{project}/locations/{location}/instances/{instance}.

Métodos

acquireUserAuthorization

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

create

 Cria um Authorization.

delete

 Exclui um Authorization.

get

 Recebe um Authorization.

list

 Lista todos os Authorizations em um Engine.

patch

 Atualiza um Authorization

storeUserAuthorization

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