driveItem: assignSensitivityLabel

Namespace: microsoft.graph

Weisen Sie einem driveItem asynchron eine Vertraulichkeitsbezeichnung zu.

Diese API ist Teil der Microsoft SharePoint- und OneDrive-APIs, die erweiterte Premium-Verwaltungsfunktionen ausführen, und gilt als geschützt. Geschützte APIs erfordern weitere Überprüfungen, die über die Berechtigung und Zustimmung hinausgehen, bevor Sie sie verwenden können.

Weitere Informationen zu Vertraulichkeitsbezeichnungen aus Administratorsicht finden Sie unter Aktivieren von Vertraulichkeitsbezeichnungen für Office-Dateien in SharePoint und OneDrive.

Hinweis

Dies ist eine getaktete API, und es können einige Gebühren für die Nutzung anfallen. Weitere Informationen finden Sie unter Übersicht über getaktete Microsoft 365-APIs in Microsoft Graph. Bevor Sie diese API aufrufen, müssen Sie getaktete APIs und Dienste in Microsoft Graph aktivieren.

Diese API wendet Vertraulichkeitsbezeichnungen auf ruhende Dateien an. Office-Clients wenden keine Wasserzeichen, Kopf- oder Fußzeilen auf Dateien an, die die Bezeichnungsinformationen enthalten. Weitere Informationen zu Vertraulichkeitsbezeichnungen aus Administratorsicht finden Sie unter Aktivieren von Vertraulichkeitsbezeichnungen für Office-Dateien in SharePoint und OneDrive.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) Files.ReadWrite.All Sites.ReadWrite.All
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Anwendung Files.ReadWrite.All Sites.ReadWrite.All

Hinweis

Für Microsoft SharePoint Embedded-Container ist für reine Anwendungsanforderungen der Parameter erforderlich appliedByUser .

HTTP-Anforderung

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

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.

Anforderungstext

Geben Sie im Anforderungstext die ID für die Vertraulichkeitsbezeichnung an, die einer bestimmten Datei zugewiesen werden soll. In der folgenden Tabelle sind die erforderlichen und optionalen Eingabeparameter aufgeführt.

Name Wert Beschreibung
sensitivityLabelId Zeichenfolge Erforderlich. ID der zuzuweisenden Vertraulichkeitsbezeichnung oder leere Zeichenfolge, um die Vertraulichkeitsbezeichnung zu entfernen.
assignmentMethod sensitivityLabelAssignmentMethod Optional. Die Zuweisungsmethode der Bezeichnung auf dem Dokument. Gibt an, ob die Zuweisung der Bezeichnung automatisch, als Standard- oder als privilegierter Vorgang (das Äquivalent zu einem Administratorvorgang) erfolgt ist.
justificationText Zeichenfolge Optional. Begründungstext zu Prüfungszwecken. Erforderlich beim Downgrade oder Entfernen einer Bezeichnung.
appliedByUser userIdentity Optional. Die Identität des Benutzers, in dessen Namen die Bezeichnung angebracht ist. Nur im Anwendungskontext (nur App) unterstützt. Geben Sie entweder id (Microsoft Entra-Objekt-ID) oder userPrincipalNamean.

Antwort

Bei erfolgreicher Ausführung gibt die API einen 202 Accepted HTTP-Antwortcode mit einem leeren Antworttext zurück. Die Location Kopfzeile enthält die URL zum Abrufen von Vorgangsdetails. Weitere Informationen zum Überwachen des Fortschritts eines assignSensitivityLabel-Vorgangs finden Sie unter Überwachen von zeitintensiven Vorgängen.

Zusätzlich zu allgemeinen Fehlern, die für Microsoft Graph gelten, gibt diese API den 423 Locked Antwortcode zurück, der angibt, dass die Datei, auf die zugegriffen wird, gesperrt ist. In solchen Fällen gibt die Code-Eigenschaft des Antwortobjekts den Fehlertyp an, der den Vorgang blockiert. Außerdem können einige IRM-geschützte Vertraulichkeitsbezeichnungen nicht im Nur-App-Modus aktualisiert werden und benötigen delegierten Benutzerzugriff, um zu überprüfen, ob der Benutzer über die richtigen Rechte verfügt. Für diese Szenarien gibt die API einen Not Supported Antwortcode zurück.

In der folgenden Tabelle sind die möglichen Werte für die Fehlertypen aufgeführt.

Wert Beschreibung
fileDoubleKeyEncrypted Gibt an, dass die Datei durch eine Doppelschlüsselverschlüsselung geschützt ist; Daher kann sie nicht geöffnet werden.
fileDecryptionNotSupported Gibt an, dass die verschlüsselte Datei bestimmte Eigenschaften besitzt, die das Öffnen dieser Dateien durch SharePoint nicht zulassen.
fileDecryptionDeferred Gibt an, dass die Datei für die Entschlüsselung verarbeitet wird; Daher kann sie nicht geöffnet werden.
unknownFutureValue Evolvable Enumeration Sentinel-Wert. Nicht verwenden.

Beispiele

Beispiel 1: Zuweisen einer Vertraulichkeitsbezeichnung

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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"
}

Antwort

Das folgende Beispiel zeigt die Antwort.

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

Der Wert des Location Headers stellt eine URL für einen Dienst bereit, der den aktuellen Status des assignSensitivityLabel-Vorgangs zurückgibt. Sie können anhand dieser Informationen bestimmen, wann der assignSensitivityLabel-Vorgang beendet ist.

Beispiel 2: Zuweisen einer Vertraulichkeitsbezeichnung im Namen eines Benutzers (nur App)

Anforderung

Das folgende Beispiel zeigt eine Nur-App-Anforderung, die eine Bezeichnung im Namen eines bestimmten Benutzers zuweist, der durch die Microsoft Entra-Objekt-ID identifiziert wird.

POST https://graph.microsoft.com/v1.0/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"
  }
}

Antwort

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

Beispiel 3: Zuweisen einer Vertraulichkeitsbezeichnung im Namen eines Benutzers mit einem Benutzerprinzipalnamen (nur App)

Anforderung

Das folgende Beispiel zeigt eine Nur-App-Anforderung, die den Benutzer anhand seines Benutzerprinzipalnamens identifiziert.

POST https://graph.microsoft.com/v1.0/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"
  }
}

Antwort

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

Hinweise

Die Antwort von der API gibt nur an, ob der assignSensitivityLabel-Vorgang akzeptiert oder abgelehnt wurde. Der Vorgang kann beispielsweise abgelehnt werden, wenn der Dateityp nicht unterstützt wird oder die Datei doppelt verschlüsselt ist. Überwachungsereignisse für Erfolgs- und Fehlerfälle werden protokolliert. Weitere Informationen finden Sie unter Überwachungsprotokollaktivitäten.