Method: projects.locations.userStores.batchUpdateUserLicenses

Actualiza la licencia del usuario. Este método se usa para asignar o quitar licencias a los usuarios por lotes.

Solicitud HTTP


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

Las URL usan la sintaxis de transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre del recurso principal UserStore, con el formato projects/{project}/locations/{location}/userStores/{userStoreId}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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.
}
Campos
deleteUnassignedUserLicenses

boolean

Es opcional. Si es verdadero, si el usuario quita las licencias asociadas a la configuración de licencias, se borrará la licencia del usuario. De forma predeterminada, que es falso, la licencia del usuario se actualizará al estado sin asignar.
Obligatorio. Es la fuente de la entrada. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
inlineSource

object (InlineSource)

Es la fuente intercalada del contenido de entrada para la asignación de licencias.
Fin de los campos mutuamente excluyentes.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.userStores.batchUpdateUserLicenses

Para obtener más información, consulta la documentación de IAM.

InlineSource

Es la fuente intercalada de la configuración de entrada para el método userStores.batchUpdateUserLicenses.

Representación JSON 
{
  "userLicenses": [
    {
      object (UserLicense)
    }
  ],
  "updateMask": string
}
Campos
userLicenses[]

object (UserLicense)

Obligatorio. Es una lista de licencias de usuario que se actualizarán. Cada licencia de usuario debe tener un UserLicense.user_principal válido.
updateMask

string (FieldMask format)

Es opcional. La lista de campos que se deben actualizar.

Esta es una lista separada por comas de los nombres de campos completamente calificados. Ejemplo: "user.displayName,photo".