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/v1beta/{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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "inlineSource": {
    object (InlineSource)
  }
  // End of mutually exclusive fields.
}
Champs
deleteUnassignedUserLicenses

boolean

Facultatif. Si la valeur est "true" et que les licences utilisateur supprimées sont associées à une configuration de licence, la licence utilisateur est supprimée. Par défaut, la valeur est "false" et la licence utilisateur est mise à jour pour indiquer qu'elle n'est pas attribuée.
Obligatoire. Source de l'entrée. Voici une liste de champs mutuellement exclusifs. Au maximum, un seul de ces champs sera défini dans une réponse :
inlineSource

object (InlineSource)

Source intégrée pour le contenu d'entrée destiné à l'attribution de licences.
Fin des champs mutuellement exclusifs.

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 niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la page 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 à mettre à jour. Chaque licence utilisateur doit comporter 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".