REST Resource: projects.locations.authorizations

資源：Authorization

Discovery Engine 授權資源。

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.
}
欄位
name

string

ID。授權的資源名稱。格式：projects/{project}/locations/{location}/authorizations/{authorization}

必須是 UTF-8 編碼的字串，長度上限為 1024 個字元。
displayName

string

這是必要旗標，授權的顯示名稱。

必須是 UTF-8 編碼的字串，長度上限為 128 個字元。
授權設定。以下列出互斥的欄位。回應中最多只會設定一個欄位：
serverSideOauth2

object (ServerSideOAuth2)

伺服器端 OAuth2 設定。
互斥欄位的結尾。

ServerSideOAuth2

OAuth2 設定。

JSON 表示法 
{
  "clientId": string,
  "clientSecret": string,
  "tokenUri": string,
  "authorizationUri": string,
  "scopes": [
    string
  ],
  "pkceVerificationEnabled": boolean
}
欄位
clientId

string

這是必要旗標，OAuth2 用戶端 ID。
clientSecret

string

這是必要旗標，OAuth2 用戶端密鑰。

靜態資料加密。
tokenUri

string

這是必要旗標，這個 HTTP 端點會將用戶端授權換成存取權杖。
authorizationUri

string

這是必要旗標，使用者需要授權時會前往的 URI。應包含授權成功所需的一切資訊：OAuth ID、額外標記等。範例：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

redirectUri 參數會遭到 Vertex AI Search 前端覆寫。
scopes[]

string

選用。要要求的範圍。示例：https://www.googleapis.com/auth/calendar.events如果省略，系統不會要求授權 URI 以外的其他範圍。如果設定，系統在取得使用者授權時，會覆寫授權 URI 中的範圍。
pkceVerificationEnabled

boolean

選用。是否啟用 PKCE 驗證機制。https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/

方法

acquireUserAuthorization

 使用儲存的更新權杖，找出以使用者憑證和指定資源識別的使用者，並傳回產生的存取權杖及其詳細資料。

create

 建立 Authorization。

delete

 刪除 Authorization。

get

 取得 Authorization。

list

 列出 Engine 下的所有 Authorization。

patch

 更新 Authorization

storeUserAuthorization

 將 OAuth 授權憑證換成更新權杖，並儲存更新權杖和範圍。