driveItem : assignSensitivityLabel

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Affectez de façon asynchrone une étiquette de confidentialité à un élément driveItem.

Cette API fait partie des API Microsoft SharePoint et OneDrive qui exécutent des fonctions d’administration Premium avancées et est considérée comme une API protégée. Les API protégées nécessitent davantage de validation, au-delà de l’autorisation et du consentement, avant de pouvoir les utiliser.

Remarque

Il s’agit d’une API limitée et certains frais d’utilisation peuvent s’appliquer. Pour plus d’informations, consultez Vue d’ensemble des API Microsoft 365 limitées dans Microsoft Graph. Avant d’appeler cette API, vous devez activer les API et les services limités dans Microsoft Graph.

Cette API applique des étiquettes de confidentialité aux fichiers au repos. Les clients Office n’appliquent pas de filigranes, d’en-têtes ou de pieds de page aux fichiers qui contiennent les informations d’étiquette. Pour plus d’informations sur les étiquettes de confidentialité du point de vue d’un administrateur, voir Activer les étiquettes de confidentialité pour les fichiers Office dans SharePoint et OneDrive.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	❌	❌	❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	Files.ReadWrite.All	Sites.ReadWrite.All
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	Files.ReadWrite.All	Sites.ReadWrite.All

Requête 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

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.

Corps de la demande

Dans le corps de la demande, fournissez l’ID de l’étiquette de confidentialité qui doit être affectée à un fichier donné. Le tableau suivant répertorie les paramètres d’entrée obligatoires et facultatifs.

Nom	Valeur	Description
sensitivityLabelId	Chaîne	Obligatoire. ID de l’étiquette de confidentialité à affecter ou chaîne vide pour supprimer l’étiquette de confidentialité.
assignmentMethod	sensitivityLabelAssignmentMethod	Optional. Méthode d’affectation de l’étiquette sur le document. Indique si l’attribution de l’étiquette a été effectuée automatiquement, standard ou en tant qu’opération privilégiée (l’équivalent d’une opération administrateur).
justificationText	String	Facultatif. Texte de justification à des fins d’audit. Obligatoire lors de la rétrogradation ou de la suppression d’une étiquette.

Réponse

Si elle réussit, l’API renvoie un 202 Accepted code de réponse HTTP avec un corps de réponse vide. L’en-tête Location fournit l’URL pour obtenir les détails de l’opération. Pour plus d’informations sur la façon de surveiller la progression d’une opération d’attribution d’étiquette de confidentialité, consultez Surveillance des opérations de longue durée.

En plus des erreurs générales qui s’appliquent à Microsoft Graph, cette API retourne le 423 Locked code de réponse, qui indique que le fichier accessible est verrouillé. Dans ce cas, la propriété de code de l’objet response indique le type d’erreur qui bloque l’opération. En outre, quelques étiquettes de confidentialité protégées par Irm ne peuvent pas être mises à jour par l’application et nécessitent un accès utilisateur délégué pour vérifier si l’utilisateur dispose des droits appropriés. Pour ces scénarios, l’API lève le Not Supported code de réponse.

Le tableau suivant répertorie les valeurs possibles pour les types d’erreur.

Valeur	Description
fileDoubleKeyEncrypted	Indique que le fichier est protégé par le chiffrement à double clé ; par conséquent, il ne peut pas être ouvert.
fileDecryptionNotSupported	Indique que le fichier chiffré a des propriétés spécifiques qui n’autorisent pas l’ouverture de ces fichiers par SharePoint.
fileDecryptionDeferred	Indique que le fichier est en cours de traitement pour le déchiffrement ; par conséquent, il ne peut pas être ouvert.
unknownFutureValue	Valeur sentinel de l’énumération évolutive. Ne pas utiliser.

Exemples

Demande

L’exemple suivant illustre une demande.

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

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Réponse

L’exemple suivant illustre la réponse.

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

La valeur de l’en-tête Location fournit une URL pour un service qui retourne l’état actuel de l’opération d’attribution d’étiquette de confidentialité. Vous pouvez utiliser ces informations pour déterminer quand l’opération d’attribution d’étiquette de confidentialité est terminée.

Remarques

La réponse de l’API indique uniquement que l’opération d’attribution d’étiquette de confidentialité a été acceptée ou rejetée. L’opération peut être rejetée, par exemple, si le type de fichier n’est pas pris en charge ou si le fichier est doublement chiffré.