Compartilhar via


driveItem: assignSensitivityLabel

Namespace: microsoft.graph

Atribua de forma assíncrona uma etiqueta de confidencialidade a um driveItem.

Esta API faz parte das APIs do Microsoft SharePoint e do OneDrive que executam funções administrativas premium avançadas e são consideradas uma API protegida. As APIs protegidas exigem que tenha validação adicional, para além da permissão e do consentimento, antes de poder utilizá-las. Antes de chamar esta API, tem de Ativar apIs e serviços com tráfego limitado no Microsoft Graph.

Para obter mais informações sobre etiquetas de confidencialidade da perspetiva de um administrador, consulte Ativar etiquetas de confidencialidade para ficheiros do Office no SharePoint e no OneDrive.

Observação

Trata-se de uma API com tráfego limitado e podem aplicar-se alguns custos de utilização. Para obter detalhes, consulte Descrição geral das APIs do Microsoft 365 com tráfego limitado no Microsoft Graph.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) Files.ReadWrite.All Sites.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application Files.ReadWrite.All Sites.ReadWrite.All

Observação

O SharePoint Embedded requer a FileStorageContainer.Selected permissão para aceder ao conteúdo do contentor. Esta permissão é diferente das mencionadas anteriormente. Além das permissões do Microsoft Graph, a sua aplicação tem de ter as permissões de tipo de contentor necessárias para chamar esta API. Para obter mais informações, veja Autorização e autenticação do SharePoint Embedded.

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 do pedido, forneça o ID para a etiqueta de confidencialidade que deve ser atribuída a um determinado ficheiro. A tabela seguinte lista os parâmetros de entrada obrigatórios e opcionais.

Nome Valor Descrição
sensitivityLabelId Cadeia de caracteres Obrigatório. ID da etiqueta de confidencialidade a atribuir ou cadeia vazia para remover a etiqueta de confidencialidade.
assignmentMethod sensitivityLabelAssignmentMethod Opcional. O método de atribuição da etiqueta no documento. Indica se a atribuição da etiqueta foi efetuada automaticamente, padrão ou como uma operação com privilégios (o equivalente a uma operação de administrador).
justificaçãoTexto String Opcional. Texto de justificação para fins de auditoria e é necessário ao mudar para uma versão degradada/remover uma etiqueta.

Resposta

Se for bem-sucedida, a API devolve um 202 Accepted código de resposta HTTP com um corpo de resposta vazio. O Location cabeçalho fornece o URL para obter os detalhes da operação. Para obter mais informações sobre como monitorizar o progresso de uma operação de atribuição de etiqueta de confidencialidade, veja Monitorizar operações de execução prolongada.

Além dos erros gerais que se aplicam ao Microsoft Graph, esta API devolve o 423 Locked código de resposta, o que indica que o ficheiro que está a ser acedido está bloqueado. Nestes casos, a propriedade de código do objeto de resposta indica o tipo de erro que bloqueia a operação. Além disso, poucas etiquetas de confidencialidade Protegidas por Irm não podem ser atualizadas pela Aplicação e precisam de acesso de utilizador delegado para validar se o utilizador tem direitos adequados e, para estes cenários, a API devolve um Not Supported código de resposta.

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

Valor Descrição
fileDoubleKeyEncrypted Indica que o ficheiro está protegido através da encriptação de chave dupla; portanto, não pode ser aberto.
fileDecryptionNotSupported Indica que o ficheiro encriptado tem propriedades específicas que não permitem que estes ficheiros sejam abertos pelo SharePoint.
fileDecryptionDeferred Indica que o ficheiro está a ser processado para desencriptação; portanto, não pode ser aberto.
unknownFutureValue Valor da sentinela de enumeração evoluível. Não usar.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

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

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

Resposta

Segue-se um exemplo da 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 um URL para um serviço que devolve o estado atual da operação atribuir etiqueta de confidencialidade. Pode utilizar estas informações para determinar quando a operação atribuir etiqueta de confidencialidade foi concluída.

Comentários

A resposta da API indica apenas que a operação atribuir etiqueta de confidencialidade foi aceite ou rejeitada. A operação pode ser rejeitada, por exemplo, se o tipo de ficheiro não for suportado ou se o ficheiro for encriptado duas vezes. São registados eventos de auditoria para casos de êxito e falha. Para obter mais informações, veja Atividades de registo de auditoria.