Method: projects.locations.userStores.batchUpdateUserLicenses

Atualiza a licença do usuário. Esse método é usado para atribuir/remover licenças em lote aos usuários.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

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

Corpo da solicitação

O corpo da solicitação 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, e as licenças de usuário removidas estiverem associadas à configuração de licença, a licença do usuário será excluída. Por padrão, que é falso, a licença do usuário será atualizada para o estado não atribuído.
Campo de união source. Obrigatório. A origem da entrada. source pode ser apenas de um dos tipos a seguir:
inlineSource

object (InlineSource)

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

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.userStores.batchUpdateUserLicenses

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

InlineSource

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

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

object (UserLicense)

Obrigatório. Uma lista de licenças de usuário a serem atualizadas. Cada licença de usuário precisa ter um UserLicense.user_principal válido.
updateMask

string (FieldMask format)

Opcional. Lista de campos a serem atualizados.

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