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}

此字段必须是采用 UTF-8 编码的字符串,长度上限为 1024 个字符。

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

更新用户存储区。