REST Resource: projects.locations.authorizations

Resource: Authorization

Resource Otorisasi Discovery Engine.

Representasi 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.
}
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.
Konfigurasi otorisasi. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
serverSideOauth2

object (ServerSideOAuth2)

Konfigurasi OAuth2 sisi server.
Akhir kolom yang saling eksklusif.

ServerSideOAuth2

Konfigurasi OAuth2.

Representasi JSON 
{
  "clientId": string,
  "clientSecret": string,
  "tokenUri": string,
  "authorizationUri": string,
  "scopes": [
    string
  ],
  "pkceVerificationEnabled": boolean,
  "basicAuthenticationEnabled": boolean,
  "privateNetworkConfig": {
    object (PrivateNetworkConfig)
  }
}
Kolom
clientId

string

Wajib. Client ID OAuth2.
clientSecret

string

Wajib. Rahasia klien OAuth2.

Dienkripsi dalam penyimpanan.
tokenUri

string

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

string

Wajib. URI yang akan dituju 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

Opsional. Cakupan yang akan diminta. Contoh: https://www.googleapis.com/auth/calendar.events Jika tidak disertakan, tidak ada cakupan tambahan yang diminta selain yang diperlukan oleh URI otorisasi. Jika disetel, cakupan dalam URI otorisasi akan diganti saat mendapatkan otorisasi pengguna.
pkceVerificationEnabled

boolean

Opsional. Apakah akan mengaktifkan verifikasi PKCE atau tidak. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/
basicAuthenticationEnabled

boolean

Opsional. Apakah pertukaran token OAuth menggunakan autentikasi Dasar HTTP (client_secret_basic) alih-alih mengirimkan kredensial klien di isi permintaan (client_secret_post). Jika true, kredensial (clientId:clientSecret) akan dienkode Base64 dan dikirim di header Authorization. Beberapa penyedia OAuth (misalnya, Splunk) memerlukan client_secret_basic. Jika false atau tidak disetel, client_secret_post default akan digunakan.
privateNetworkConfig

object (PrivateNetworkConfig)

Opsional. Hanya disetel jika penyedia OAuth tidak memublikasikan endpoint publik, dalam hal ini pertukaran token harus dirutekan melalui jaringan pribadi tempat instance berada, bukan melalui egress publik. Jika tidak disetel, pertukaran akan tetap dilakukan di egress publik.

PrivateNetworkConfig

Mengidentifikasi instance yang menghosting penyedia OAuth yang hanya dapat dijangkau melalui jaringan pribadi.

Representasi JSON 
{
  "instanceResource": string
}
Kolom
instanceResource

string

Wajib. Nama resource instance yang menghosting penyedia OAuth. Untuk Looker, instance Looker, dalam bentuk projects/{project}/locations/{location}/instances/{instance}.

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

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