名前空間: microsoft.graph
driveItem に秘密度ラベルを非同期的に割り当てます。
この API は、高度な Premium 管理機能を実行する Microsoft SharePoint API と OneDrive API の一部であり、保護された API と見なされます。 保護された API を使用するには、アクセス許可と同意を超えて追加の検証を行う必要があります。 この API を呼び出す前に、 Microsoft Graph で従量制課金 API とサービスを有効にする必要があります。
管理者の観点からの秘密度ラベルの詳細については、「 SharePoint および OneDrive で Office ファイルの秘密度ラベルを有効にする」を参照してください。
注:
これは従量制課金 API であり、一部の使用料金が適用される場合があります。 詳細については、「 Microsoft Graph の従量制課金 Microsoft 365 API の概要」を参照してください。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ❌ | ❌ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | Files.ReadWrite.All | Sites.ReadWrite.All |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | Files.ReadWrite.All | Sites.ReadWrite.All |
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
要求ヘッダー
| 名前 | 説明 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
要求本文
要求本文で、特定のファイルに割り当てる秘密度ラベルの ID を指定します。 次の表に、必要な入力パラメーターと省略可能な入力パラメーターを示します。
| 名前 | 値 | 説明 |
|---|---|---|
| sensitivityLabelId | String | 必須です。 割り当てる秘密度ラベルの ID、または秘密度ラベルを削除する空の文字列。 |
| assignmentMethod | sensitivityLabelAssignmentMethod | 省略可能。 ドキュメントのラベルの割り当て方法。 ラベルの割り当てが自動的に行われたか、標準か、または特権操作 (管理者操作と同等) として行われたかを示します。 |
| justificationText | String | 省略可能。 監査目的の理由付けテキスト。ラベルをダウングレードまたは削除する場合に必要です。 |
応答
成功した場合、API は空の応答本文を持つ 202 Accepted HTTP 応答コードを返します。
Location ヘッダーには、操作の詳細を取得するための URL が用意されています。
秘密度ラベルの割り当て操作の進行状況を監視する方法の詳細については、「 実行時間の長い操作の監視」を参照してください。
この API は、Microsoft Graph に適用される一般的なエラーに加えて、 423 Locked 応答コードを返します。これは、アクセスされているファイルがロックされていることを示します。 このような場合、応答オブジェクトの code プロパティは、操作をブロックするエラーの種類を示します。
また、アプリケーションによって更新できない Irm Protected 秘密度ラベルがいくつかあり、ユーザーが適切な権限を持っているかどうかを検証するために委任されたユーザー アクセスが必要であり、これらのシナリオでは API は応答コード Not Supported スローします。
次の表に、エラーの種類に使用できる値を示します。
| 値 | 説明 |
|---|---|
| fileDoubleKeyEncrypted | ファイルが二重キー暗号化によって保護されていることを示します。そのため、開くできません。 |
| fileDecryptionNotSupported | 暗号化されたファイルに、これらのファイルを SharePoint で開くことができない特定のプロパティがあることを示します。 |
| fileDecryptionDeferred | 暗号化解除のためにファイルが処理されていることを示します。そのため、開くできません。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
例
要求
次の例は要求を示しています。
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"
}
応答
応答の例を次に示します。
HTTP/1.1 202 Accepted
Location: https://contoso.sharepoint.com/_api/v2.0/monitor/QXNzaWduU2Vuc2l0aXZpdHlMYWJlbCxiMzc3ODY3OS04OWQ3LTRkYmYtYjg0MC1jYWM1NzRhY2FlNmE?tempAuth=eyJ0eXAiOiJKV1QiLCJhb....
Location ヘッダーの値は、秘密度ラベルの割り当て操作の現在の状態を返すサービスの URL を提供します。
この情報を使用して、 秘密度ラベルの割り当て操作がいつ終了したかを判断できます。
解説
API からの応答は、秘密度ラベルの割り当て操作が受け入れられたか拒否されたことを示すだけです。 たとえば、ファイルの種類がサポートされていない場合や、ファイルが二重に暗号化されている場合など、操作が拒否される可能性があります。 成功と失敗の両方のケースの監査イベントがログに記録されます。 詳細については、「 監査ログ アクティビティ」を参照してください。