Method: projects.locations.userStores.batchUpdateUserLicenses

Atualiza a licença de utilizador. Este método é usado para atribuir/anular a atribuição de licenças em lote a utilizadores.

Pedido HTTP

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

O URL usa a sintaxe de transcodificação de gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso principal UserStore, formato: projects/{project}/locations/{location}/userStores/{userStoreId}.

Corpo do pedido

O corpo do pedido contém dados com a seguinte estrutura:

Representação 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

Opcional. Se for verdadeiro, se as licenças de utilizador removidas tiverem uma configuração de licença associada, a licença de utilizador é eliminada. Por predefinição, que é falso, a licença do utilizador é atualizada para o estado não atribuído.
Campo de união source. Obrigatório. A origem da entrada. source só pode ser uma das seguintes opções:
inlineSource

object (InlineSource)

A origem inline do conteúdo de entrada para incorporações de documentos.

Corpo da resposta

Se for bem-sucedido, o corpo da resposta contém uma instância de Operation.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • discoveryengine.userStores.batchUpdateUserLicenses

Para mais informações, consulte a documentação do IAM.

InlineSource

A origem inline para a configuração de entrada do método userStores.batchUpdateUserLicenses.

Representação JSON 
{
  "userLicenses": [
    {
      object (UserLicense)
    }
  ],
  "updateMask": string
}
Campos
userLicenses[]

object (UserLicense)

Obrigatório. Uma lista de licenças de utilizador a atualizar. Cada licença de utilizador tem de ter um UserLicense.user_principal válido.
updateMask

string (FieldMask format)

Opcional. A lista de campos a atualizar.

Esta é uma lista separada por vírgulas de nomes totalmente qualificados de campos. Exemplo: "user.displayName,photo".