REST Resource: projects.locations.authorizations

リソース: Authorization

Discovery Engine 承認リソース。

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.
}
フィールド
name

string

ID。認可のリソース名。形式: projects/{project}/locations/{location}/authorizations/{authorization}

長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
displayName

string

必須。認可の表示名。

長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。
共用体フィールド authorization_config。承認構成。authorization_config は次のいずれかになります。
serverSideOauth2

object (ServerSideOAuth2)

サーバーサイドの OAuth2 構成。

ServerSideOAuth2

OAuth2 構成。

JSON 表現 
{
  "clientId": string,
  "clientSecret": string,
  "tokenUri": string,
  "authorizationUri": string,
  "scopes": [
    string
  ]
}
フィールド
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

メソッド

acquireUserAuthorization

 エンドユーザーの認証情報と指定されたリソースで識別されるユーザーの保存済み更新トークンを使用して、生成されたアクセス トークンとその詳細を返します。

create

 Authorization を作成します。

delete

 Authorization を削除します。

get

 Authorization を取得します。

list

 Engine のすべての Authorization を一覧表示します。

patch

 Authorization を更新します

storeUserAuthorization

 OAuth 認証情報を更新トークンと交換し、更新トークンとスコープを保存します。