driveItem: assignSensitivityLabel

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Atribuir assíncronamente um rótulo de confidencialidade a um driveItem.

Essa API faz parte das APIs do Microsoft SharePoint e do OneDrive que executam funções administrativas premium avançadas e é considerada uma API protegida. As APIs protegidas exigem que você tenha mais validação, além da permissão e do consentimento, antes de poder usá-las.

Observação

Esta é uma API limitada e alguns encargos para uso podem ser aplicados. Para obter detalhes, confira Visão geral das APIs do Microsoft 365 limitadas no Microsoft Graph. Antes de chamar essa API, você deve habilitar APIs e serviços medidos no Microsoft Graph.

Essa API aplica rótulos de confidencialidade a arquivos em repouso. Os clientes do Office não aplicam marcas d'água, cabeçalhos ou rodapés a arquivos que contêm as informações do rótulo. Para obter mais informações sobre rótulos de confidencialidade da perspectiva de um administrador, consulte Habilitar rótulos de confidencialidade para arquivos do Office no SharePoint e no OneDrive.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global	Governo dos EUA L4	GOVERNO DOS EUA L5 (DOD)	China operada pela 21Vianet
✅	❌	❌	❌

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão	Permissões menos privilegiadas	Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante)	Files.ReadWrite.All	Sites.ReadWrite.All
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Aplicativo	Files.ReadWrite.All	Sites.ReadWrite.All

Solicitação HTTP

POST /drives/{drive-id}/items/{item-id}/assignSensitivityLabel
POST /drives/{drive-id}/root:/{item-path}:/assignSensitivityLabel
POST /groups/{group-id}/drive/items/{item-id}/assignSensitivityLabel
POST /groups/{group-id}/drive/root:/{item-path}:/assignSensitivityLabel
POST /me/drive/items/{item-id}/assignSensitivityLabel
POST /me/drive/root:/{item-path}:/assignSensitivityLabel
POST /sites/{site-id}/drive/items/{item-id}/assignSensitivityLabel
POST /sites/{site-id}/drive/root:/{item-path}:/assignSensitivityLabel
POST /users/{user-id}/drive/items/{item-id}/assignSensitivityLabel
POST /users/{user-id}/drive/root:/{item-path}:/assignSensitivityLabel

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

No corpo da solicitação, forneça a ID para o rótulo de confidencialidade que deve ser atribuído a um determinado arquivo. A tabela a seguir lista os parâmetros de entrada necessários e opcionais.

Nome	Valor	Descrição
sensitivityLabelId	Cadeia de caracteres	Obrigatório. ID do rótulo de confidencialidade a ser atribuído ou cadeia de caracteres vazia para remover o rótulo de confidencialidade.
assignmentMethod	sensitivityLabelAssignmentMethod	Opcional. O método de atribuição do rótulo no documento. Indica se a atribuição do rótulo foi feita automaticamente, padrão ou como uma operação privilegiada (o equivalente a uma operação de administrador).
justificationText	String	Opcional. Texto de justificativa para fins de auditoria. Necessário ao rebaixar ou remover um rótulo.

Resposta

Se for bem-sucedida, a API retornará um 202 Accepted código de resposta HTTP com um corpo de resposta vazio. O Location cabeçalho fornece a URL para obter detalhes da operação. Para obter mais informações sobre como monitorar o progresso de uma operação de rótulo de confidencialidade de atribuição, consulte monitoramento de operações de execução longa.

Além dos erros gerais que se aplicam ao Microsoft Graph, essa API retorna o código de 423 Locked resposta, o que indica que o arquivo acessado está bloqueado. Nesses casos, a propriedade de código do objeto de resposta indica o tipo de erro que bloqueia a operação. Além disso, poucos rótulos de confidencialidade protegidos por irm não podem ser atualizados pelo Aplicativo e precisam de acesso delegado do usuário para validar se o usuário tiver direitos adequados. Para esses cenários, a API gera código de Not Supported resposta.

A tabela a seguir lista os valores possíveis para os tipos de erro.

Valor	Descrição
fileDoubleKeyEncrypted	Indica que o arquivo está protegido por meio de criptografia de chave dupla; Portanto, ele não pode ser aberto.
fileDecryptionNotSupported	Indica que o arquivo criptografado tem propriedades específicas que não permitem que esses arquivos sejam abertos pelo SharePoint.
fileDecryptionDeferred	Indica que o arquivo está sendo processado para descriptografia; Portanto, ele não pode ser aberto.
unknownFutureValue	Valor sentinela de enumeração evoluível. Não usar.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

HTTP

POST https://graph.microsoft.com/beta/drive/root/items/016GVDAP3RCQS5VBQHORFIVU2ZMOSBL25U/assignSensitivityLabel
Content-Type: application/json

{
  "sensitivityLabelId": "5feba255-812e-446a-ac59-a7044ef827b5",
  "assignmentMethod": "standard",
  "justificationText": "test_justification"
}

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const assignSensitivityLabel = {
  sensitivityLabelId: '5feba255-812e-446a-ac59-a7044ef827b5',
  assignmentMethod: 'standard',
  justificationText: 'test_justification'
};

await client.api('/drive/root/items/016GVDAP3RCQS5VBQHORFIVU2ZMOSBL25U/assignSensitivityLabel')
	.version('beta')
	.post(assignSensitivityLabel);

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 202 Accepted
Location: https://contoso.sharepoint.com/_api/v2.0/monitor/QXNzaWduU2Vuc2l0aXZpdHlMYWJlbCxiMzc3ODY3OS04OWQ3LTRkYmYtYjg0MC1jYWM1NzRhY2FlNmE?tempAuth=eyJ0eXAiOiJKV1QiLCJhb....

O valor do Location cabeçalho fornece uma URL para um serviço que retornará o estado atual da operação de rótulo de confidencialidade de atribuição. Você pode usar essas informações para determinar quando a operação atribuir rótulo de confidencialidade foi concluída.

Comentários

A resposta da API indica apenas que a operação atribuir rótulo de confidencialidade foi aceita ou rejeitada. A operação poderá ser rejeitada, por exemplo, se o tipo de arquivo não tiver suporte ou o arquivo for criptografado duas vezes.