REST Resource: projects.locations.userStores

リソース: UserStore

エンドユーザー エンティティに使用されるメタデータを構成します。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "defaultLicenseConfig": string,
  "enableLicenseAutoRegister": boolean,
  "enableExpiredLicenseAutoUpdate": boolean
}
フィールド
name

string

変更不可。ユーザーストアの完全なリソース名（形式: projects/{project}/locations/{location}/userStores/{userStore}）。

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

string

ユーザーストアの表示名です。
defaultLicenseConfig

string

省略可。UserStore のデフォルトのサブスクリプション LicenseConfig。UserStore.enable_license_auto_register が true の場合、新規ユーザーはデフォルトのサブスクリプションに自動的に登録されます。

デフォルトの LicenseConfig にライセンス シートの残りがなくなると、新規ユーザーにライセンスが割り当てられず、Vertex AI Search 機能がブロックされます。これは、licenseAssignmentTierRules が構成されていない場合に使用されます。
enableLicenseAutoRegister

boolean

省略可。このユーザーストアのユーザーに対してライセンスの自動登録を有効にするかどうか。true の場合、デフォルトのライセンス構成にシートが残っている限り、新規ユーザーはデフォルトのライセンス構成に自動的に登録されます。
enableExpiredLicenseAutoUpdate

boolean

省略可。このユーザーストアのユーザーに対してライセンスの自動更新を有効にするかどうか。true の場合、デフォルトのライセンス構成にシートが残っている限り、ライセンスの有効期限が切れたユーザーが、デフォルトのライセンス構成を使用するように自動的に更新されます。

メソッド

batchUpdateUserLicenses

 ユーザー ライセンスを更新します。

create

 新規ユーザーストアを作成します。

delete

 ユーザーストアを削除します。

get

 ユーザーストアを取得します。

patch

 ユーザーストアを更新します。