Method: projects.locations.userStores.batchUpdateUserLicenses

Actualiza la licencia de usuario. Este método se usa para asignar o anular la asignación de licencias a los usuarios por lotes.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. El nombre del recurso UserStore superior, 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,

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

boolean

Es opcional. Si es verdadero, si las licencias de usuario quitan la configuración de licencia asociada, se borrará la licencia de usuario. De forma predeterminada, que es falsa, la licencia de usuario se actualizará al estado sin asignar.
Campo de unión source. Obligatorio. La fuente de la entrada. source puede ser solo uno de los parámetros siguientes:
inlineSource

object (InlineSource)

La fuente intercalada para el contenido de entrada de las incorporaciones de documentos.

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

La fuente intercalada para la configuración de entrada del método userStores.batchUpdateUserLicenses.

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

object (UserLicense)

Obligatorio. Una lista de licencias de usuario para actualizar. 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".