REST Resource: projects.locations.userStores

Recurso: UserStore

Configura metadados usados para entidades de usuário final.

Representação JSON
{
  "name": string,
  "displayName": string,
  "defaultLicenseConfig": string,
  "enableLicenseAutoRegister": boolean,
  "enableExpiredLicenseAutoUpdate": boolean
}
Campos
name

string

Imutável. O nome completo do recurso do armazenamento de usuários, no formato projects/{project}/locations/{location}/userStores/{userStore}.

Esse campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.

displayName

string

O nome de exibição da loja de usuários.

defaultLicenseConfig

string

Opcional. A assinatura padrão LicenseConfig para o UserStore. Se UserStore.enable_license_auto_register for verdadeiro, os novos usuários vão se registrar automaticamente na assinatura padrão.

Se o LicenseConfig padrão não tiver mais assentos de licença disponíveis, os novos usuários não receberão uma licença e serão bloqueados para os recursos da Vertex AI Search. Isso será usado se licenseAssignmentTierRules não estiver configurado.

enableLicenseAutoRegister

boolean

Opcional. Se o registro automático de licenças para usuários nesta loja de usuários está ativado. Se for "true", os novos usuários vão se registrar automaticamente na configuração de licença padrão, desde que ela tenha vagas disponíveis.

enableExpiredLicenseAutoUpdate

boolean

Opcional. Se a atualização automática de licenças deve ser ativada para usuários nesta UserStore. Se for "true", os usuários com licenças expiradas serão atualizados automaticamente para usar a configuração de licença padrão, desde que ela tenha assentos disponíveis.

Métodos

batchUpdateUserLicenses

Atualiza a licença do usuário.

create

Cria um novo User Store.

delete

Exclui o repositório de usuários.

get

Recebe o User Store.

patch

Atualiza o User Store.