Method: projects.locations.collections.dataConnector.acquireAndStoreRefreshToken

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. Os dados armazenados são identificados pelo nome do conector e pelo identificador do utilizador da EUC.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. Recurso de conetor.

O nome do conetor identifica o sistema de terceiros a usar para autorização. Também é usado como uma chave para armazenar o token de atualização.

Corpo do pedido

O corpo do pedido contém dados com a seguinte estrutura:

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

string

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

string

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

Corpo da resposta

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

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

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

object (AdditionalOAuthResponse)

Opcional. Respostas OAuth adicionais da resposta de autorização. Este campo é opcional e nem sempre é preenchido. Depende do tipo de conector e da resposta de autorização.

Âmbitos de autorização

Requer um dos seguintes âmbitos 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 o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso name:

  • discoveryengine.dataConnectors.acquireAndStoreRefreshToken

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

AdditionalOAuthResponse

Respostas OAuth adicionais 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 só pode ser uma das seguintes opções:
stringValue

string

O valor da string da resposta OAuth adicional.
intValue

string (int64 format)

O valor inteiro da resposta OAuth adicional.
boolValue

boolean

O valor booleano da resposta OAuth adicional.