REST Resource: projects.locations.authorizations

Resource: Authorization

Resource Authorization 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 diisi. Nama tampilan otorisasi.

Harus berupa string berenkode UTF-8 dengan batas panjang 128 karakter.
Konfigurasi otorisasi. Berikut adalah daftar kolom yang saling eksklusif. Paling banyak 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
}
Kolom
clientId

string

Wajib diisi. ID klien OAuth2.
clientSecret

string

Wajib diisi. Rahasia klien OAuth2.

Di-enkripsi dalam penyimpanan.
tokenUri

string

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

string

Wajib diisi. URI yang dituju pengguna saat mereka perlu mengotorisasi. Harus menyertakan semua yang diperlukan untuk otorisasi yang berhasil: ID OAuth, flag 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 ditimpa oleh frontend Vertex AI Search.
scopes[]

string

Opsional. Cakupan yang akan diminta. Contoh: https://www.googleapis.com/auth/calendar.events Jika dihilangkan, tidak ada cakupan tambahan yang diminta selain yang diperlukan oleh URI otorisasi. Jika ditetapkan, cakupan ini akan menimpa cakupan dalam URI otorisasi saat memperoleh otorisasi pengguna.
pkceVerificationEnabled

boolean

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

Metode

acquireUserAuthorization

 Menggunakan token refresh tersimpan 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 di bawah Engine.

patch

 Mengupdate Authorization

storeUserAuthorization

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