Поделиться через

Создание subjectRightsRequest

  • Статья

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

Важно!

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

Создайте объект subjectRightsRequest .

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

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

Разрешения

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

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) SubjectRightsRequest.ReadWrite.All Недоступно.
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Для приложений Не поддерживается. Не поддерживается.

HTTP-запрос

Предостережение

API запроса прав субъекта на /privacy узле не рекомендуется и перестанет возвращать данные 30 марта 2025 г. Используйте новый путь в разделе /security.

POST /security/subjectRightsRequests
POST /privacy/subjectRightsRequests

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

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

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

В тексте запроса укажите представление объекта subjectRightsRequest в формате JSON.

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

Свойство Тип Описание
Утверждающих Коллекция объектов user Коллекция пользователей, которые могут утвердить запрос. Утверждающие в настоящее время поддерживаются только для delete типа запроса.
Сотрудников Коллекция объектов user Коллекция пользователей, которые могут совместно выполнять запрос.
contentQuery String Запрос содержимого на основе KQL, который следует использовать для поиска. Это свойство определяется только для API, к которому осуществляется доступ по \security пути запроса, а не \privacy по пути запроса.
dataSubject dataSubject Содержит свойства субъекта данных для запроса.
dataSubjectType dataSubjectType Тип субъекта данных. Возможные значения: customer, currentEmployee, formerEmployee, prospectiveEmployee, student, teacher, faculty, other, unknownFutureValue.
description String Описание запроса.
displayName String Имя запроса.
externalId String Внешний идентификатор запроса, который неизменяем после создания и используется для отслеживания запроса внешней системы. Это свойство определяется только для API, к которому осуществляется доступ по \security пути запроса, а не \privacy по пути запроса.
includeAllVersions Логический Включите все версии документов. По умолчанию возвращаются текущие копии документов. Если на сайтах SharePoint включено управление версиями, все версии автоматически включают исторические копии документов. Это свойство определяется только для API, к которому осуществляется доступ по \security пути запроса, а не \privacy по пути запроса.
includeAuthoredContent Логический Включите содержимое, созданное субъектом данных. Это свойство определяется только для API, к которому осуществляется доступ по \security пути запроса, а не \privacy по пути запроса.
internalDueDateTime DateTimeOffset Внутренняя дата выполнения, используемая для отслеживания завершения запроса.
mailboxLocations subjectRightsRequestMailboxLocation Расположения почтовых ящиков, в которые необходимо выполнить поиск. Это свойство определяется только для API, к которому осуществляется доступ по \security пути запроса, а не \privacy по пути запроса.
pauseAfterEstimate Логический Приостановите запрос после завершения оценки. По умолчанию оценка данных выполняется, а затем приостанавливается, что позволяет просмотреть результаты, а затем выбрать параметр для извлечения данных в пользовательском интерфейсе. Для этого свойства можно присвоить значение , false если вы хотите, чтобы оно выполняло оценку, а затем автоматически начинается с извлечения содержимого. Это свойство определяется только для API, к которому осуществляется доступ по \security пути запроса, а не \privacy по пути запроса.
Правила Коллекция строк Одно или несколько правил для запроса.
siteLocations subjectRightsRequestSiteLocation Расположения сайтов SharePoint и OneDrive, в которые следует искать. Это свойство определяется только для API, к которому осуществляется доступ по \security пути запроса, а не \privacy по пути запроса.
type subjectRightsRequestType Тип запроса. Возможные значения: export, access, delete, tagForAction, unknownFutureValue.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 201 Created и объект subjectRightsRequest в теле отклика.

Примеры

Запрос

POST https://graph.microsoft.com/beta/privacy/subjectRightsRequests
Content-Type: application/json

{
    "type": "export",
    "contentQuery": "((\"Diego Siciliani\" OR \"Diego.Siciliani@contoso.com\") OR (participants:\"Diego.Siciliani@contoso.com\"))",
    "dataSubjectType": "customer",
    "externalId": "F53BF2DA-607D-412A-B568-FAA0F023AC0B",
    "displayName": "Export report for customer Id: 12345",
    "description": "This is a export request",
    "includeAllVersions": false,
    "includeAuthoredContent": true,
    "internalDueDateTime": "2022-07-20T22:42:28Z",
    "dataSubject": {
        "firstName": "Diego",
        "lastName": "Siciliani",
        "email": "Diego.Siciliani@contoso.com",
        "residency": "USA"
    },
    "mailboxLocations": null,
    "pauseAfterEstimate": true,
    "regulations": [
        "CCPA"
    ],
    "siteLocations": {
        "@odata.type": "microsoft.graph.subjectRightsRequestAllSiteLocation"
    },
    "approvers" : [
        {
            "id": "1B761ED2-AA7E-4D82-9CF5-C09D737B6167"
        }
    ]
}

Отклик

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "type": "export",
    "dataSubjectType": "customer",
    "regulations": [
        "CCPA"
    ],
    "displayName": "Export report for customer Id: 12345",
    "description": "This is a export request",
    "status": "active",
    "internalDueDateTime": "2022-07-20T22:42:28Z",
    "lastModifiedDateTime": "2022-05-10T22:42:28Z",
    "id": "CA084038-C5D2-493D-8DAB-23FC12393C76",
    "createdDateTime": "2022-05-10T22:42:28Z",
    "stages": [
        {
            "stage": "contentRetrieval",
            "status": "notStarted",
            "error": null
        },
        {
            "stage": "contentReview",
            "status": "notStarted",
            "error": null
        },
        {
            "stage": "generateReport",
            "status": "notStarted",
            "error": null
        },
        {
            "stage": "caseResolved",
            "status": "notStarted",
            "error": null
        }
    ],
    "createdBy": {
        "user": {
            "id": "1B761ED2-AA7E-4D82-9CF5-C09D737B6167",
            "displayName": "srradmin@contoso.com"
        }
    },
    "approvers": [
        {
            "id": "1B761ED2-AA7E-4D82-9CF5-C09D737B6167"
        }
    ],    
    "collaborators": [
        {
            "id": "1B761ED2-AA7E-4D82-9CF5-C09D737B6167"
        }
    ],    
    "lastModifiedBy": {
        "user": {
            "id": "1B761ED2-AA7E-4D82-9CF5-C09D737B6167",
            "displayName": "srradmin@contoso.com"
        }
    },
    "dataSubject": {
        "firstName": "Diego",
        "lastName": "Siciliani",
        "email": "Diego.Siciliani@contoso.com",
        "residency": "USA"
    },
    "team": {
        "id": "5484809c-fb5b-415a-afc6-da7ff601034e",
        "webUrl": "https://teams.contoso.com/teams/teamid"
    },
    "includeAllVersions": false,
    "pauseAfterEstimate": false,
    "includeAuthoredContent": false,
    "externalId": "F53BF2DA-607D-412A-B568-FAA0F023AC0B",
    "contentQuery": "((\"Diego Siciliani\" OR \"Diego.Siciliani@contoso.com\") OR (participants:\"Diego.Siciliani@contoso.com\"))",
    "mailboxLocations": null,
    "siteLocations": {
        "@odata.type": "microsoft.graph.subjectRightsRequestAllSiteLocation"
    }
}