REST Resource: projects.locations.userStores

Ressource : UserStore

Configure les métadonnées utilisées pour les entités d'utilisateur final.

Représentation JSON
{
  "name": string,
  "displayName": string,
  "defaultLicenseConfig": string,
  "enableLicenseAutoRegister": boolean,
  "enableExpiredLicenseAutoUpdate": boolean
}
Champs
name

string

Immuable. Nom complet de la ressource User Store, au format projects/{project}/locations/{location}/userStores/{userStore}.

Ce champ doit être une chaîne encodée au format UTF-8 d'une longueur maximale de 1 024 caractères.

displayName

string

Nom à afficher de l'User Store.

defaultLicenseConfig

string

Facultatif. Abonnement LicenseConfig par défaut pour l'UserStore. Si UserStore.enable_license_auto_register est défini sur "true", les nouveaux utilisateurs s'enregistrent automatiquement avec l'abonnement par défaut.

Si la LicenseConfig par défaut ne dispose plus de licences, les nouveaux utilisateurs ne se verront pas attribuer de licence et ne pourront pas utiliser les fonctionnalités de Vertex AI Search. Ce paramètre est utilisé si licenseAssignmentTierRules n'est pas configuré.

enableLicenseAutoRegister

boolean

Facultatif. Indique si l'enregistrement automatique des licences est activé pour les utilisateurs de cet User Store. Si la valeur est "true", les nouveaux utilisateurs s'enregistrent automatiquement avec la configuration de licence par défaut tant qu'il reste des licences.

enableExpiredLicenseAutoUpdate

boolean

Facultatif. Indique si la mise à jour automatique des licences est activée pour les utilisateurs de cet User Store. Si la valeur est "true", les utilisateurs dont la licence a expiré seront automatiquement mis à jour pour utiliser la configuration de licence par défaut tant qu'il reste des licences.

Méthodes

batchUpdateUserLicenses

Met à jour la licence utilisateur.

get

Obtient l'User Store.

patch

Met à jour l'User Store.