REST Resource: projects.locations.userStores

Ressource : UserStore

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

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

string

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

Ce champ doit être une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères.

displayName

string

Nom à afficher de l'User Store.

defaultLicenseConfig

string

Facultatif. Abonnement par défaut LicenseConfig pour 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 le groupe par défaut LicenseConfig ne dispose plus de sièges de licence, les nouveaux utilisateurs ne se verront pas attribuer de licence et seront bloqués pour les fonctionnalités Vertex AI Search. Cette valeur est utilisée si licenseAssignmentTierRules n'est pas configuré.

enableLicenseAutoRegister

boolean

Facultatif. Indique si l'enregistrement automatique des licences doit être activé pour les utilisateurs de ce User Store. Si la valeur est "true", les nouveaux utilisateurs seront automatiquement enregistrés avec la configuration de licence par défaut, à condition qu'il reste des sièges.

enableExpiredLicenseAutoUpdate

boolean

Facultatif. Indique si la mise à jour automatique des licences doit être activée pour les utilisateurs de ce User Store. Si la valeur est "true", les utilisateurs dont les licences ont expiré seront automatiquement mis à jour pour utiliser la configuration de licence par défaut, à condition qu'il reste des sièges dans cette configuration.

Méthodes

batchUpdateUserLicenses

Met à jour la licence utilisateur.

create

Crée un magasin d'utilisateurs.

delete

Supprime le User Store.

get

Récupère le User Store.

patch

Met à jour le User Store.