driveItem: assignSensitivityLabel

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Асинхронно назначьте метку конфиденциальности объекту driveItem.

Этот API является частью API Microsoft SharePoint и OneDrive, которые выполняют расширенные административные функции уровня "Премиум", и считается защищенным API. Защищенные API-интерфейсы требуют больше проверки, помимо разрешений и согласия, прежде чем вы сможете использовать их.

Примечание.

Это API с лимитным тарифом, и за использование может взиматься определенная плата. Дополнительные сведения см. в статье Обзор лимитных API Microsoft 365 в Microsoft Graph. Перед вызовом этого API необходимо включить лимитные API и службы в Microsoft Graph.

Этот API применяет метки конфиденциальности к неактивным файлам. Клиенты Office не применяют водяные знаки, колонтитулы и колонтитулы к файлам, содержащим сведения о метках. Дополнительные сведения о метках конфиденциальности с точки зрения администратора см. в статье Включение меток конфиденциальности для файлов Office в SharePoint и OneDrive.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	❌	❌	❌

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	Files.ReadWrite.All	Sites.ReadWrite.All
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Приложение	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

Заголовки запросов

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.

Текст запроса

В тексте запроса укажите идентификатор метки конфиденциальности, которая будет назначена заданному файлу. В следующей таблице перечислены обязательные и необязательные входные параметры.

Имя	Значение	Описание
sensitivityLabelId	String	Обязательный. Идентификатор назначенной метки конфиденциальности или пустая строка для удаления метки конфиденциальности.
assignmentMethod	sensitivityLabelAssignmentMethod	Необязательный параметр. Метод присваивания метки в документе. Указывает, было ли присвоение метки выполнено автоматически, стандартно или в качестве привилегированной операции (эквивалент операции администратора).
justificationText	String	Необязательный параметр. Текст обоснования для целей аудита. Требуется при понижении или удалении метки.

Отклик

В случае успешного выполнения API возвращает 202 Accepted код ответа HTTP с пустым текстом ответа. Заголовок Location предоставляет URL-адрес для получения сведений об операции. Дополнительные сведения о мониторинге хода выполнения операции назначения меток конфиденциальности см. в разделе Мониторинг длительных операций.

Помимо общих ошибок, которые применяются к Microsoft Graph, этот API возвращает 423 Locked код ответа, который указывает, что файл, к которому осуществляется доступ, заблокирован. В таких случаях свойство code объекта response указывает тип ошибки, блокирующая операцию. Кроме того, приложение не может обновить метки конфиденциальности С защитой Irm и требует делегированного доступа пользователей, чтобы проверить, имеет ли пользователь надлежащие права. В этих сценариях API выдает Not Supported код ответа.

В следующей таблице перечислены возможные значения для типов ошибок.

Значение	Описание
fileDoubleKeyEncrypted	Указывает, что файл защищен с помощью шифрования с двойным ключом; поэтому его невозможно открыть.
fileDecryptionNotSupported	Указывает, что зашифрованный файл имеет определенные свойства, которые не позволяют открывать эти файлы SharePoint.
fileDecryptionDeferred	Указывает, что файл обрабатывается для расшифровки; поэтому его невозможно открыть.
unknownFutureValue	Изменяемое значение перечисления sentinel. Не используйте.

Примеры

Запрос

Ниже показан пример запроса.

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);

Важно!

Пакеты SDK для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже показан пример отклика.

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

Значение заголовка Location предоставляет URL-адрес службы, которая вернет текущее состояние операции присвоения метки конфиденциальности. Эти сведения можно использовать для определения завершения операции назначения меток конфиденциальности.

Замечания

Ответ api указывает только на то, что операция присвоения метки конфиденциальности была принята или отклонена. Операция может быть отклонена, например, если тип файла не поддерживается или файл имеет двойное шифрование.