REST Resource: projects.locations.userStores

Recurso: UserStore

Configura los metadatos que se usan para las entidades de usuarios finales.

Representación JSON
{
  "name": string,
  "displayName": string,
  "defaultLicenseConfig": string,
  "enableLicenseAutoRegister": boolean,
  "enableExpiredLicenseAutoUpdate": boolean
}
Campos
name

string

Inmutable. Es el nombre completo del recurso de User Store, con el formato projects/{project}/locations/{location}/userStores/{userStore}.

Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 1,024 caracteres.

displayName

string

Es el nombre visible del almacén de usuarios.

defaultLicenseConfig

string

Es opcional. Es la suscripción predeterminada LicenseConfig para UserStore. Si UserStore.enable_license_auto_register es verdadero, los usuarios nuevos se registrarán automáticamente con la suscripción predeterminada.

Si el valor predeterminado de LicenseConfig no tiene licencias disponibles, no se les asignará una licencia a los usuarios nuevos y se bloquearán las funciones de Vertex AI Search. Se usa si no se configura licenseAssignmentTierRules.

enableLicenseAutoRegister

boolean

Es opcional. Indica si se debe habilitar el registro automático de licencias para los usuarios de este almacén de usuarios. Si es verdadero, los usuarios nuevos se registrarán automáticamente con la configuración de licencia predeterminada, siempre y cuando esta tenga lugares disponibles.

enableExpiredLicenseAutoUpdate

boolean

Es opcional. Indica si se debe habilitar la actualización automática de licencias para los usuarios de este almacén de usuarios. Si es verdadero, los usuarios con licencias vencidas se actualizarán automáticamente para usar la configuración de licencias predeterminada, siempre y cuando esta tenga lugares disponibles.

Métodos

batchUpdateUserLicenses

Actualiza la licencia de usuario.

create

Crea un nuevo almacén de usuarios.

delete

Borra el almacén de usuarios.

get

Obtiene el almacén de usuarios.

patch

Actualiza el almacén de usuarios.