Method: projects.locations.userStores.batchUpdateUserLicenses

Met à jour la licence utilisateur. Cette méthode permet d'attribuer ou de supprimer des licences à des utilisateurs par lot.

Requête HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/userStores/*}:batchUpdateUserLicenses

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de la ressource UserStore parente, au format projects/{project}/locations/{location}/userStores/{userStoreId}.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "deleteUnassignedUserLicenses": boolean,

  // Union field source can be only one of the following:
  "inlineSource": {
    object (InlineSource)
  }
  // End of list of possible types for union field source.
}
Champs
deleteUnassignedUserLicenses

boolean

Facultatif. Si la valeur est "true", la licence utilisateur sera supprimée si les configurations de licence associées sont supprimées. Par défaut (c'est-à-dire sur "false"), la licence utilisateur sera mise à jour sur l'état "non attribuée".
Champ d'union source. Obligatoire. Source de l'entrée. source ne peut être qu'un des éléments suivants :
inlineSource

object (InlineSource)

Source intégrée du contenu d'entrée pour les embeddings de documents.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • discoveryengine.userStores.batchUpdateUserLicenses

Pour en savoir plus, consultez la documentation IAM.

InlineSource

Source intégrée pour la configuration d'entrée de la méthode userStores.batchUpdateUserLicenses.

Représentation JSON 
{
  "userLicenses": [
    {
      object (UserLicense)
    }
  ],
  "updateMask": string
}
Champs
userLicenses[]

object (UserLicense)

Obligatoire. Liste des licences utilisateur à modifier. Chaque licence utilisateur doit disposer d'un UserLicense.user_principal valide.
updateMask

string (FieldMask format)

Facultatif. Liste des champs à mettre à jour.

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo".