Method: projects.locations.collections.dataConnector.acquireAndStoreRefreshToken

Troca credenciais de autorização do OAuth por um token de atualização e armazena o token de atualização e os escopos. Os dados armazenados serão identificados pelo nome do conector e pelo identificador do usuário da EUC.

Solicitação HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}:acquireAndStoreRefreshToken

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. Recurso do conector.

O nome do conector identifica o sistema de terceiros a ser usado para autorização. Ele também é usado como uma chave para armazenar o token de atualização.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "scopes": [
    string
  ],
  "fullRedirectUri": string
}
Campos
scopes[]

string

Os escopos do código de autorização e do token de atualização.
fullRedirectUri

string

Obrigatório. O URI para o qual o usuário é redirecionado após a autorização, incluindo todos os parâmetros. Exemplo, https://example.com/redir?code=5

Corpo da resposta

Mensagem de resposta para o método DataConnectorService.AcquireAndStoreRefreshToken.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "additionalOauthResponses": [
    {
      object (AdditionalOAuthResponse)
    }
  ]
}
Campos
additionalOauthResponses[]

object (AdditionalOAuthResponse)

Opcional. Outras respostas do OAuth da resposta de autorização. Esse campo é opcional e nem sempre é preenchido. Isso depende do tipo de conector e da resposta de autorização.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • discoveryengine.dataConnectors.acquireAndStoreRefreshToken

Para mais informações, consulte a documentação do IAM.

AdditionalOAuthResponse

Outras respostas do OAuth da resposta de autorização.

Representação JSON 
{
  "key": string,

  // Union field value can be only one of the following:
  "stringValue": string,
  "intValue": string,
  "boolValue": boolean
  // End of list of possible types for union field value.
}
Campos
key

string

A chave da resposta OAuth adicional.
Campo de união value. O valor da resposta OAuth adicional. value pode ser apenas de um dos tipos a seguir:
stringValue

string

O valor da string da resposta OAuth adicional.
intValue

string (int64 format)

O valor inteiro da resposta adicional do OAuth.
boolValue

boolean

O valor booleano da resposta OAuth adicional.