subjectRightsRequest を作成する

  • [アーティクル]

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

新しい subjectRightsRequest オブジェクトを 作成します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ❌ ❌ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) SubjectRightsRequest.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション サポートされていません。 サポートされていません。

HTTP 要求

注意

ノードのサブジェクト /privacy 権限要求 API は非推奨となり、2025 年 3 月 30 日にデータの返しを停止します。 の下 /securityの新しいパスを使用してください。

POST /security/subjectRightsRequests
POST /privacy/subjectRightsRequests

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で、 subjectRightsRequest オブジェクトの JSON 表現を指定します。

次の表に、 subjectRightsRequest を作成するときに必要なプロパティを示します。

プロパティ 型 説明
承認 user コレクション 要求を承認できるユーザーのコレクション。 承認者は現在、要求の種類に対 delete してのみサポートされています。
協力 user コレクション 要求で共同作業できるユーザーのコレクション。
contentQuery String 検索に使用する KQL ベースのコンテンツ クエリ。 このプロパティは、クエリ パスを使用して \security アクセスされる API に対してのみ定義され、クエリ パスは \privacy 定義されません。
dataSubject dataSubject 要求のデータ主体のプロパティが含まれます。
dataSubjectType dataSubjectType データ主体の種類。 可能な値は、customer、currentEmployee、formerEmployee、prospectiveEmployee、student、teacher、faculty、other、unknownFutureValue です。
説明 String 要求の説明。
displayName String 要求の名前。
外部ID String 作成後に変更できない要求の外部 ID。外部システムの要求の追跡に使用されます。 このプロパティは、クエリ パスを使用して \security アクセスされる API に対してのみ定義され、クエリ パスは \privacy 定義されません。
includeAllVersions ブール型 ドキュメントのすべてのバージョンを含めます。 既定では、ドキュメントの現在のコピーが返されます。 SharePoint サイトでバージョン管理が有効になっている場合は、すべてのバージョンにドキュメントの履歴コピーが自動的に含まれます。 このプロパティは、クエリ パスを使用して \security アクセスされる API に対してのみ定義され、クエリ パスは \privacy 定義されません。
includeAuthoredContent ブール型 データ主体によって作成されたコンテンツを含めます。 このプロパティは、クエリ パスを使用して \security アクセスされる API に対してのみ定義され、クエリ パスは \privacy 定義されません。
internalDueDateTime DateTimeOffset 要求の完了を追跡するために使用される内部期日。
mailboxLocations subjectRightsRequestMailboxLocation 検索する必要があるメールボックスの場所。 このプロパティは、クエリ パスを使用して \security アクセスされる API に対してのみ定義され、クエリ パスは \privacy 定義されません。
pauseAfterEstimate ブール型 見積もりが完了したら、要求を一時停止します。 既定では、データ見積もりが実行され、一時停止され、結果をプレビューし、UI でデータを取得するオプションを選択できます。 見積もりを false 実行し、コンテンツの取得から自動的に開始する場合は、このプロパティを に設定できます。 このプロパティは、クエリ パスを使用して \security アクセスされる API に対してのみ定義され、クエリ パスは \privacy 定義されません。
規制 String collection 要求の 1 つ以上の規制。
siteLocations subjectRightsRequestSiteLocation 検索する必要がある SharePoint サイトと OneDrive サイトの場所。 このプロパティは、クエリ パスを使用して \security アクセスされる API に対してのみ定義され、クエリ パスは \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"
    }
}