REST Resource: projects.locations.authorizations

リソース: Authorization

ディスカバリー エンジン承認リソース。

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}

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

string

必須。認可の表示名。

長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。
認可の構成を表します。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
serverSideOauth2

object (ServerSideOAuth2)

サーバーサイドの OAuth2 構成。
相互に排他的なフィールドの終わり。

ServerSideOAuth2

OAuth の構成。

JSON 表現 
{
  "clientId": string,
  "clientSecret": string,
  "tokenUri": string,
  "authorizationUri": string,
  "scopes": [
    string
  ],
  "pkceVerificationEnabled": boolean,
  "basicAuthenticationEnabled": boolean,
  "privateNetworkConfig": {
    object (PrivateNetworkConfig)
  }
}
フィールド
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/
basicAuthenticationEnabled

boolean

省略可。OAuth トークン交換で、リクエスト本文（client_secret_post）でクライアント認証情報を送信する代わりに、HTTP 基本認証（client_secret_basic）を使用するかどうか。true の場合、認証情報（clientId:clientSecret）は Base64 でエンコードされ、Authorization ヘッダーで送信されます。一部の OAuth プロバイダ（Splunk など）では client_secret_basic が必要です。false または未設定の場合、デフォルトの client_secret_post が使用されます。
privateNetworkConfig

object (PrivateNetworkConfig)

省略可。OAuth プロバイダがパブリック エンドポイントを公開していない場合にのみ設定します。この場合、トークン交換はパブリック下り（外向き）ではなく、インスタンスが配置されているプライベート ネットワーク経由でルーティングする必要があります。このポリシーを未設定のままにすると、交換はパブリック下り（外向き）のままになります。

PrivateNetworkConfig

プライベート ネットワーク経由でのみアクセス可能な OAuth プロバイダをホストするインスタンスを識別します。

JSON 表現 
{
  "instanceResource": string
}
フィールド
instanceResource

string

必須。OAuth プロバイダをホストするインスタンスのリソース名。Looker の場合は、Looker インスタンス（projects/{project}/locations/{location}/instances/{instance} 形式）。

メソッド

acquireUserAuthorization

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

create

 Authorization を作成します。

delete

 Authorization を削除します。

get

 Authorization を取得します。

list

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

patch

 Authorization を更新します。

storeUserAuthorization

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