REST Resource: projects.locations.authorizations

Resource: Authorization

Resource Otorisasi Discovery Engine.

Representasi JSON 
{
  "name": string,
  "displayName": string,

  // Union field authorization_config can be only one of the following:
  "serverSideOauth2": {
    object (ServerSideOAuth2)
  }
  // End of list of possible types for union field authorization_config.
}
Kolom
name

string

ID. Nama resource otorisasi. Format: projects/{project}/locations/{location}/authorizations/{authorization}

Harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.
displayName

string

Wajib. Nama tampilan otorisasi.

Harus berupa string berenkode UTF-8 dengan batas panjang 128 karakter.
Kolom union authorization_config. Konfigurasi otorisasi. authorization_config hanya ada berupa salah satu diantara berikut:
serverSideOauth2

object (ServerSideOAuth2)

Konfigurasi OAuth2 sisi server.

ServerSideOAuth2

Konfigurasi OAuth2.

Representasi JSON 
{
  "clientId": string,
  "clientSecret": string,
  "tokenUri": string,
  "authorizationUri": string,
  "scopes": [
    string
  ]
}
Kolom
clientId

string

Wajib. ID klien OAuth2.
clientSecret

string

Wajib. Rahasia klien OAuth2.

Dienkripsi saat dalam penyimpanan.
tokenUri

string

Wajib. Endpoint HTTP yang menukar otorisasi klien dengan token akses.
authorizationUri

string

Wajib. URI tujuan pengguna saat mereka perlu memberikan otorisasi. Harus menyertakan semua yang diperlukan untuk otorisasi yang berhasil: ID OAuth, tanda tambahan, dll. Contoh: 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

Parameter redirectUri akan digantikan oleh frontend Vertex AI Search.
scopes[]

string

Wajib. Cakupan yang akan diminta. Contoh: https://www.googleapis.com/auth/calendar.events

Metode

acquireUserAuthorization

 Menggunakan token refresh yang disimpan untuk pengguna yang diidentifikasi berdasarkan kredensial pengguna akhir dan resource yang diberikan, serta menampilkan token akses yang dibuat dan detailnya.

create

 Membuat Authorization.

delete

 Menghapus Authorization.

get

 Mendapatkan Authorization.

list

 Mencantumkan semua Authorization dalam Engine.

patch

 Memperbarui Authorization

storeUserAuthorization

 Menukar kredensial otorisasi OAuth dengan token refresh dan menyimpan token refresh serta cakupannya.