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.
Atribua de forma assíncrona 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 protegida. As APIs protegidas exigem que você tenha mais validações, além da permissão e do consentimento, antes de poder usá-las.
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 aplica rótulos de confidencialidade a arquivos inativos. Os clientes do Office não aplicam marcas d'água, cabeçalhos ou rodapés a arquivos que contêm as informações de rótulos. 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 de nuvem nacional.
| Serviço global |
Governo dos EUA L4 |
US Government L5 (DOD) |
China operada pela 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Permissões
Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos 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 com privilégios mais elevados |
| 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
Para contêineres do Microsoft SharePoint Embedded, as solicitações somente de aplicativo exigem o appliedByUser parâmetro.
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
Corpo da solicitação
No corpo da solicitação, forneça a ID do rótulo de confidencialidade que deve ser atribuído a um determinado arquivo. A tabela a seguir lista os parâmetros de entrada obrigató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 da etiqueta 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 fazer downgrade ou remover um rótulo. |
| appliedByUser |
userIdentity |
Opcional. A identidade do usuário em nome do qual o rótulo é aplicado. Com suporte apenas no contexto do aplicativo (somente aplicativo). Especifique (idID do objeto do Microsoft Entra) ou userPrincipalName. |
Resposta
Se for bem-sucedida, a API retornará um código de 202 Accepted resposta HTTP com um corpo de resposta vazio. O Location cabeçalho fornece a URL para obter os detalhes da operação.
Para obter mais informações sobre como monitorar o progresso de uma operação de atribuição de rótulo de confidencialidade, consulte monitoramento de operações de longa execução.
Além dos erros gerais que se aplicam ao Microsoft Graph, essa API retorna o 423 Locked código de resposta, que indica que o arquivo que está sendo acessado está bloqueado. Nesses casos, a propriedade code do objeto de resposta indica o tipo de erro que bloqueia a operação.
Além disso, alguns rótulos de confidencialidade protegidos por IRM não podem ser atualizados no modo somente aplicativo e precisam de acesso de usuário delegado para validar se o usuário tem os direitos adequados. Para esses cenários, a API gera um 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 é protegido por criptografia de chave dupla; portanto, ela não pode ser aberta. |
| 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, ela não pode ser aberta. |
| unknownFutureValue |
Valor sentinela de enumeração evolutiva. Não usar. |
Exemplos
Exemplo 1: atribuir um rótulo de confidencialidade
Solicitação
O exemplo a seguir mostra uma solicitação.
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"
}
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);
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 assignSensitivityLabel.
Você pode usar essas informações para determinar quando a operação assignSensitivityLabel foi concluída.
Exemplo 2: atribuir um rótulo de confidencialidade em nome de um usuário (somente aplicativo)
Solicitação
O exemplo a seguir mostra uma solicitação somente de aplicativo que atribui um rótulo em nome de um usuário específico, identificado pela ID do objeto do Microsoft Entra.
POST https://graph.microsoft.com/beta/drives/{drive-id}/items/016GVDAP3RCQS5VBQHORFIVU2ZMOSBL25U/assignSensitivityLabel
Content-Type: application/json
{
"sensitivityLabelId": "5feba255-812e-446a-ac59-a7044ef827b5",
"assignmentMethod": "standard",
"justificationText": "test_justification",
"appliedByUser": {
"id": "4a2ec3c4-1b2d-3e4f-5a6b-7c8d9e0f1a2b"
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Drives.Item.Items.Item.AssignSensitivityLabel;
using Microsoft.Graph.Beta.Models;
var requestBody = new AssignSensitivityLabelPostRequestBody
{
SensitivityLabelId = "5feba255-812e-446a-ac59-a7044ef827b5",
AssignmentMethod = SensitivityLabelAssignmentMethod.Standard,
JustificationText = "test_justification",
AppliedByUser = new UserIdentity
{
Id = "4a2ec3c4-1b2d-3e4f-5a6b-7c8d9e0f1a2b",
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Drives["{drive-id}"].Items["{driveItem-id}"].AssignSensitivityLabel.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphdrives "github.com/microsoftgraph/msgraph-beta-sdk-go/drives"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphdrives.NewAssignSensitivityLabelPostRequestBody()
sensitivityLabelId := "5feba255-812e-446a-ac59-a7044ef827b5"
requestBody.SetSensitivityLabelId(&sensitivityLabelId)
assignmentMethod := graphmodels.STANDARD_SENSITIVITYLABELASSIGNMENTMETHOD
requestBody.SetAssignmentMethod(&assignmentMethod)
justificationText := "test_justification"
requestBody.SetJustificationText(&justificationText)
appliedByUser := graphmodels.NewUserIdentity()
id := "4a2ec3c4-1b2d-3e4f-5a6b-7c8d9e0f1a2b"
appliedByUser.SetId(&id)
requestBody.SetAppliedByUser(appliedByUser)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Drives().ByDriveId("drive-id").Items().ByDriveItemId("driveItem-id").AssignSensitivityLabel().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.drives.item.items.item.assignsensitivitylabel.AssignSensitivityLabelPostRequestBody assignSensitivityLabelPostRequestBody = new com.microsoft.graph.beta.drives.item.items.item.assignsensitivitylabel.AssignSensitivityLabelPostRequestBody();
assignSensitivityLabelPostRequestBody.setSensitivityLabelId("5feba255-812e-446a-ac59-a7044ef827b5");
assignSensitivityLabelPostRequestBody.setAssignmentMethod(SensitivityLabelAssignmentMethod.Standard);
assignSensitivityLabelPostRequestBody.setJustificationText("test_justification");
UserIdentity appliedByUser = new UserIdentity();
appliedByUser.setId("4a2ec3c4-1b2d-3e4f-5a6b-7c8d9e0f1a2b");
assignSensitivityLabelPostRequestBody.setAppliedByUser(appliedByUser);
graphClient.drives().byDriveId("{drive-id}").items().byDriveItemId("{driveItem-id}").assignSensitivityLabel().post(assignSensitivityLabelPostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const assignSensitivityLabel = {
sensitivityLabelId: '5feba255-812e-446a-ac59-a7044ef827b5',
assignmentMethod: 'standard',
justificationText: 'test_justification',
appliedByUser: {
id: '4a2ec3c4-1b2d-3e4f-5a6b-7c8d9e0f1a2b'
}
};
await client.api('/drives/{drive-id}/items/016GVDAP3RCQS5VBQHORFIVU2ZMOSBL25U/assignSensitivityLabel')
.version('beta')
.post(assignSensitivityLabel);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Drives\Item\Items\Item\AssignSensitivityLabel\AssignSensitivityLabelPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\SensitivityLabelAssignmentMethod;
use Microsoft\Graph\Beta\Generated\Models\UserIdentity;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new AssignSensitivityLabelPostRequestBody();
$requestBody->setSensitivityLabelId('5feba255-812e-446a-ac59-a7044ef827b5');
$requestBody->setAssignmentMethod(new SensitivityLabelAssignmentMethod('standard'));
$requestBody->setJustificationText('test_justification');
$appliedByUser = new UserIdentity();
$appliedByUser->setId('4a2ec3c4-1b2d-3e4f-5a6b-7c8d9e0f1a2b');
$requestBody->setAppliedByUser($appliedByUser);
$graphServiceClient->drives()->byDriveId('drive-id')->items()->byDriveItemId('driveItem-id')->assignSensitivityLabel()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Files
$params = @{
sensitivityLabelId = "5feba255-812e-446a-ac59-a7044ef827b5"
assignmentMethod = "standard"
justificationText = "test_justification"
appliedByUser = @{
id = "4a2ec3c4-1b2d-3e4f-5a6b-7c8d9e0f1a2b"
}
}
Set-MgBetaDriveItemSensitivityLabel -DriveId $driveId -DriveItemId $driveItemId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.drives.item.items.item.assign_sensitivity_label.assign_sensitivity_label_post_request_body import AssignSensitivityLabelPostRequestBody
from msgraph_beta.generated.models.sensitivity_label_assignment_method import SensitivityLabelAssignmentMethod
from msgraph_beta.generated.models.user_identity import UserIdentity
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = AssignSensitivityLabelPostRequestBody(
sensitivity_label_id = "5feba255-812e-446a-ac59-a7044ef827b5",
assignment_method = SensitivityLabelAssignmentMethod.Standard,
justification_text = "test_justification",
applied_by_user = UserIdentity(
id = "4a2ec3c4-1b2d-3e4f-5a6b-7c8d9e0f1a2b",
),
)
await graph_client.drives.by_drive_id('drive-id').items.by_drive_item_id('driveItem-id').assign_sensitivity_label.post(request_body)
Resposta
HTTP/1.1 202 Accepted
Location: https://contoso.sharepoint.com/_api/v2.0/monitor/QXNzaWduU2Vuc2l0aXZpdHlMYWJlbCxiMzc3ODY3OS04OWQ3LTRkYmYtYjg0MC1jYWM1NzRhY2FlNmE?tempAuth=******
Exemplo 3: atribuir um rótulo de confidencialidade em nome de um usuário usando um nome UPN (somente aplicativo)
Solicitação
O exemplo a seguir mostra uma solicitação somente de aplicativo que identifica o usuário pelo nome UPN.
POST https://graph.microsoft.com/beta/drives/{drive-id}/items/016GVDAP3RCQS5VBQHORFIVU2ZMOSBL25U/assignSensitivityLabel
Content-Type: application/json
{
"sensitivityLabelId": "5feba255-812e-446a-ac59-a7044ef827b5",
"assignmentMethod": "standard",
"justificationText": "test_justification",
"appliedByUser": {
"userPrincipalName": "adelev@contoso.com"
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Drives.Item.Items.Item.AssignSensitivityLabel;
using Microsoft.Graph.Beta.Models;
var requestBody = new AssignSensitivityLabelPostRequestBody
{
SensitivityLabelId = "5feba255-812e-446a-ac59-a7044ef827b5",
AssignmentMethod = SensitivityLabelAssignmentMethod.Standard,
JustificationText = "test_justification",
AppliedByUser = new UserIdentity
{
UserPrincipalName = "adelev@contoso.com",
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Drives["{drive-id}"].Items["{driveItem-id}"].AssignSensitivityLabel.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphdrives "github.com/microsoftgraph/msgraph-beta-sdk-go/drives"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphdrives.NewAssignSensitivityLabelPostRequestBody()
sensitivityLabelId := "5feba255-812e-446a-ac59-a7044ef827b5"
requestBody.SetSensitivityLabelId(&sensitivityLabelId)
assignmentMethod := graphmodels.STANDARD_SENSITIVITYLABELASSIGNMENTMETHOD
requestBody.SetAssignmentMethod(&assignmentMethod)
justificationText := "test_justification"
requestBody.SetJustificationText(&justificationText)
appliedByUser := graphmodels.NewUserIdentity()
userPrincipalName := "adelev@contoso.com"
appliedByUser.SetUserPrincipalName(&userPrincipalName)
requestBody.SetAppliedByUser(appliedByUser)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Drives().ByDriveId("drive-id").Items().ByDriveItemId("driveItem-id").AssignSensitivityLabel().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.drives.item.items.item.assignsensitivitylabel.AssignSensitivityLabelPostRequestBody assignSensitivityLabelPostRequestBody = new com.microsoft.graph.beta.drives.item.items.item.assignsensitivitylabel.AssignSensitivityLabelPostRequestBody();
assignSensitivityLabelPostRequestBody.setSensitivityLabelId("5feba255-812e-446a-ac59-a7044ef827b5");
assignSensitivityLabelPostRequestBody.setAssignmentMethod(SensitivityLabelAssignmentMethod.Standard);
assignSensitivityLabelPostRequestBody.setJustificationText("test_justification");
UserIdentity appliedByUser = new UserIdentity();
appliedByUser.setUserPrincipalName("adelev@contoso.com");
assignSensitivityLabelPostRequestBody.setAppliedByUser(appliedByUser);
graphClient.drives().byDriveId("{drive-id}").items().byDriveItemId("{driveItem-id}").assignSensitivityLabel().post(assignSensitivityLabelPostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const assignSensitivityLabel = {
sensitivityLabelId: '5feba255-812e-446a-ac59-a7044ef827b5',
assignmentMethod: 'standard',
justificationText: 'test_justification',
appliedByUser: {
userPrincipalName: 'adelev@contoso.com'
}
};
await client.api('/drives/{drive-id}/items/016GVDAP3RCQS5VBQHORFIVU2ZMOSBL25U/assignSensitivityLabel')
.version('beta')
.post(assignSensitivityLabel);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Drives\Item\Items\Item\AssignSensitivityLabel\AssignSensitivityLabelPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\SensitivityLabelAssignmentMethod;
use Microsoft\Graph\Beta\Generated\Models\UserIdentity;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new AssignSensitivityLabelPostRequestBody();
$requestBody->setSensitivityLabelId('5feba255-812e-446a-ac59-a7044ef827b5');
$requestBody->setAssignmentMethod(new SensitivityLabelAssignmentMethod('standard'));
$requestBody->setJustificationText('test_justification');
$appliedByUser = new UserIdentity();
$appliedByUser->setUserPrincipalName('adelev@contoso.com');
$requestBody->setAppliedByUser($appliedByUser);
$graphServiceClient->drives()->byDriveId('drive-id')->items()->byDriveItemId('driveItem-id')->assignSensitivityLabel()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Files
$params = @{
sensitivityLabelId = "5feba255-812e-446a-ac59-a7044ef827b5"
assignmentMethod = "standard"
justificationText = "test_justification"
appliedByUser = @{
userPrincipalName = "adelev@contoso.com"
}
}
Set-MgBetaDriveItemSensitivityLabel -DriveId $driveId -DriveItemId $driveItemId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.drives.item.items.item.assign_sensitivity_label.assign_sensitivity_label_post_request_body import AssignSensitivityLabelPostRequestBody
from msgraph_beta.generated.models.sensitivity_label_assignment_method import SensitivityLabelAssignmentMethod
from msgraph_beta.generated.models.user_identity import UserIdentity
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = AssignSensitivityLabelPostRequestBody(
sensitivity_label_id = "5feba255-812e-446a-ac59-a7044ef827b5",
assignment_method = SensitivityLabelAssignmentMethod.Standard,
justification_text = "test_justification",
applied_by_user = UserIdentity(
user_principal_name = "adelev@contoso.com",
),
)
await graph_client.drives.by_drive_id('drive-id').items.by_drive_item_id('driveItem-id').assign_sensitivity_label.post(request_body)
Resposta
HTTP/1.1 202 Accepted
Location: https://contoso.sharepoint.com/_api/v2.0/monitor/QXNzaWduU2Vuc2l0aXZpdHlMYWJlbCxiMzc3ODY3OS04OWQ3LTRkYmYtYjg0MC1jYWM1NzRhY2FlNmE?tempAuth=******
A resposta da API indica apenas que a operação assignSensitivityLabel foi aceita ou rejeitada. A operação poderá ser rejeitada, por exemplo, se o tipo de arquivo não tiver suporte ou se o arquivo for criptografado duas vezes. Os eventos de auditoria para casos de sucesso e falha são registrados. Para obter mais informações, consulte Atividades de log de auditoria.