Method: projects.locations.collections.dataConnector.acquireAndStoreRefreshToken

Menukarkan kredensial otorisasi OAuth untuk token refresh dan menyimpan token refresh serta cakupannya. Data yang disimpan akan diberi kunci berdasarkan nama konektor dan ID pengguna dari EUC.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib diisi. Resource konektor.

Nama konektor mengidentifikasi sistem pihak ketiga yang akan digunakan untuk otorisasi. Nama ini juga digunakan sebagai kunci untuk menyimpan token refresh.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "scopes": [
    string
  ],
  "fullRedirectUri": string,
  "instanceUri": string
}
Kolom
scopes[]

string

Cakupan kode otorisasi dan token refresh.
fullRedirectUri

string

Wajib diisi. URI yang menjadi tujuan pengalihan pengguna setelah otorisasi, termasuk semua parameter. Misalnya, https://example.com/redir?code=5
instanceUri

string

Opsional. URI instance untuk konektor, jika disediakan, konektor yang didukung akan menggunakan URI instance ini untuk membuat URL pertukaran token. Misalnya, URI instance Shopify adalah URL toko.

Isi respons

Pesan respons untuk metode DataConnectorService.AcquireAndStoreRefreshToken.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "additionalOauthResponses": [
    {
      object (AdditionalOAuthResponse)
    }
  ]
}
Kolom
additionalOauthResponses[]

object (AdditionalOAuthResponse)

Opsional. Respons OAuth tambahan dari respons otorisasi. Kolom ini bersifat opsional dan tidak akan selalu diisi. Kolom ini bergantung pada jenis konektor dan respons otorisasi.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource name:

  • discoveryengine.dataConnectors.acquireAndStoreRefreshToken

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

AdditionalOAuthResponse

Respons OAuth tambahan dari respons otorisasi.

Representasi 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.
}
Kolom
key

string

Kunci respons OAuth tambahan.
Kolom union value. Nilai respons OAuth tambahan. value hanya ada berupa salah satu diantara berikut:
stringValue

string

Nilai string dari respons OAuth tambahan.
intValue

string (int64 format)

Nilai bilangan bulat dari respons OAuth tambahan.
boolValue

boolean

Nilai boolean dari respons OAuth tambahan.