Créer subjectRightsRequest

Espace de noms: microsoft.graph

Créez un objet subjectRightsRequest .

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	❌	❌	❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	SubjectRightsRequest.ReadWrite.All*	Non disponible.
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	Non prise en charge.	Non prise en charge.

Requête HTTP

Attention

L’API de demande de droits de l’objet sous le /privacy nœud est déconseillée et cessera de retourner des données le 30 mars 2025. Utilisez le nouveau chemin d’accès sous /security.

POST /security/subjectRightsRequests
POST /privacy/subjectRightsRequests

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type	application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet subjectRightsRequest .

Le tableau suivant répertorie les propriétés requises lorsque vous créez l’objet subjectRightsRequest.

Propriété	Type	Description
Approbateurs	Collection d’utilisateurs	Collection d’utilisateurs qui peuvent approuver la demande. Actuellement pris en charge uniquement pour les demandes de typedelete.
Collaborateurs	Collection d’utilisateurs	Collection d’utilisateurs qui peuvent collaborer sur la demande.
contentQuery	Chaîne	Requête de contenu basée sur KQL qui doit être utilisée pour la recherche. Cette propriété est définie uniquement pour les API accessibles à l’aide du chemin de requête \security et non du chemin de requête \privacy .
dataSubject	dataSubject	Contient les propriétés de la personne concernée pour la requête.
dataSubjectType	dataSubjectType	Type de personne concernée. Les valeurs possibles sont les suivantes : customer, currentEmployee, formerEmployee, prospectiveEmployee, student, teacher, faculty, other, unknownFutureValue.
description	Chaîne	Description de la demande.
displayName	Chaîne	Nom de la demande.
externalId	Chaîne	ID externe de la requête immuable après sa création et utilisé pour le suivi de la demande pour le système externe. Cette propriété est définie uniquement pour les API accessibles à l’aide du chemin de requête \security et non du chemin de requête \privacy .
includeAllVersions	Valeur booléenne	Incluez toutes les versions des documents. Par défaut, les copies actuelles des documents sont retournées. Si le contrôle de version est activé sur les sites SharePoint, toutes les versions incluent automatiquement les copies historiques des documents. Cette propriété est définie uniquement pour les API accessibles à l’aide du chemin de requête \security et non du chemin de requête \privacy .
includeAuthoredContent	Valeur booléenne	Inclure le contenu créé par la personne concernée. Cette propriété est définie uniquement pour les API accessibles à l’aide du chemin de requête \security et non du chemin de requête \privacy .
internalDueDateTime	DateTimeOffset	Date d’échéance interne utilisée pour le suivi de l’achèvement de la demande.
mailboxLocations	subjectRightsRequestMailboxLocation	Emplacements de boîte aux lettres qui doivent faire l’objet d’une recherche. Cette propriété est définie uniquement pour les API accessibles à l’aide du chemin de requête \security et non du chemin de requête \privacy .
pauseAfterEstimate	Valeur booléenne	Suspendez la requête une fois l’estimation terminée. Par défaut, l’estimation des données s’exécute, puis s’interrompt, ce qui vous permet d’afficher un aperçu des résultats, puis de sélectionner l’option permettant de récupérer des données dans l’interface utilisateur. Vous pouvez définir cette propriété sur false si vous souhaitez qu’elle effectue l’estimation, puis commence automatiquement par la récupération du contenu. Cette propriété est définie uniquement pour les API accessibles à l’aide du chemin de requête \security et non du chemin de requête \privacy .
Règlements	String collection	Un ou plusieurs règlements pour la demande.
siteLocations	subjectRightsRequestSiteLocation	Emplacements des sites SharePoint et OneDrive qui doivent faire l’objet d’une recherche. Cette propriété est définie uniquement pour les API accessibles à l’aide du chemin de requête \security et non du chemin de requête \privacy .
type	subjectRightsRequestType	Type de la demande. Les valeurs possibles sont les suivantes : export, access, delete, tagForAction, unknownFutureValue.

Réponse

Si elle réussit, cette méthode renvoie un 201 Created code de réponse et un objet subjectRightsRequest dans le corps de la réponse.

Exemples

Demande

HTTP

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

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new SubjectRightsRequest
{
	Type = SubjectRightsRequestType.Export,
	ContentQuery = "((\"Diego Siciliani\" OR \"Diego.Siciliani@contoso.com\") OR (participants:\"Diego.Siciliani@contoso.com\"))",
	DataSubjectType = 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 = DateTimeOffset.Parse("2022-07-20T22:42:28Z"),
	DataSubject = new DataSubject
	{
		FirstName = "Diego",
		LastName = "Siciliani",
		Email = "Diego.Siciliani@contoso.com",
		Residency = "USA",
	},
	MailboxLocations = null,
	PauseAfterEstimate = true,
	Regulations = new List<string>
	{
		"CCPA",
	},
	SiteLocations = new SubjectRightsRequestAllSiteLocation
	{
		OdataType = "microsoft.graph.subjectRightsRequestAllSiteLocation",
	},
	Approvers = new List<User>
	{
		new User
		{
			Id = "1B761ED2-AA7E-4D82-9CF5-C09D737B6167",
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Privacy.SubjectRightsRequests.PostAsync(requestBody);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

CLI

mgc privacy subject-rights-requests create --body '{\
  "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"\
    }\
  ]\
}\
'

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  "time"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewSubjectRightsRequest()
type := graphmodels.EXPORT_SUBJECTRIGHTSREQUESTTYPE 
requestBody.SetType(&type) 
contentQuery := "((\"Diego Siciliani\" OR \"Diego.Siciliani@contoso.com\") OR (participants:\"Diego.Siciliani@contoso.com\"))"
requestBody.SetContentQuery(&contentQuery) 
dataSubjectType := graphmodels.CUSTOMER_DATASUBJECTTYPE 
requestBody.SetDataSubjectType(&dataSubjectType) 
externalId := "F53BF2DA-607D-412A-B568-FAA0F023AC0B"
requestBody.SetExternalId(&externalId) 
displayName := "Export report for customer Id: 12345"
requestBody.SetDisplayName(&displayName) 
description := "This is a export request"
requestBody.SetDescription(&description) 
includeAllVersions := false
requestBody.SetIncludeAllVersions(&includeAllVersions) 
includeAuthoredContent := true
requestBody.SetIncludeAuthoredContent(&includeAuthoredContent) 
internalDueDateTime , err := time.Parse(time.RFC3339, "2022-07-20T22:42:28Z")
requestBody.SetInternalDueDateTime(&internalDueDateTime) 
dataSubject := graphmodels.NewDataSubject()
firstName := "Diego"
dataSubject.SetFirstName(&firstName) 
lastName := "Siciliani"
dataSubject.SetLastName(&lastName) 
email := "Diego.Siciliani@contoso.com"
dataSubject.SetEmail(&email) 
residency := "USA"
dataSubject.SetResidency(&residency) 
requestBody.SetDataSubject(dataSubject)
mailboxLocations := null
requestBody.SetMailboxLocations(&mailboxLocations) 
pauseAfterEstimate := true
requestBody.SetPauseAfterEstimate(&pauseAfterEstimate) 
regulations := []string {
	"CCPA",
}
requestBody.SetRegulations(regulations)
siteLocations := graphmodels.NewSubjectRightsRequestAllSiteLocation()
requestBody.SetSiteLocations(siteLocations)


user := graphmodels.NewUser()
id := "1B761ED2-AA7E-4D82-9CF5-C09D737B6167"
user.SetId(&id) 

approvers := []graphmodels.Userable {
	user,
}
requestBody.SetApprovers(approvers)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
subjectRightsRequests, err := graphClient.Privacy().SubjectRightsRequests().Post(context.Background(), requestBody, nil)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

SubjectRightsRequest subjectRightsRequest = new SubjectRightsRequest();
subjectRightsRequest.setType(SubjectRightsRequestType.Export);
subjectRightsRequest.setContentQuery("((\"Diego Siciliani\" OR \"Diego.Siciliani@contoso.com\") OR (participants:\"Diego.Siciliani@contoso.com\"))");
subjectRightsRequest.setDataSubjectType(DataSubjectType.Customer);
subjectRightsRequest.setExternalId("F53BF2DA-607D-412A-B568-FAA0F023AC0B");
subjectRightsRequest.setDisplayName("Export report for customer Id: 12345");
subjectRightsRequest.setDescription("This is a export request");
subjectRightsRequest.setIncludeAllVersions(false);
subjectRightsRequest.setIncludeAuthoredContent(true);
OffsetDateTime internalDueDateTime = OffsetDateTime.parse("2022-07-20T22:42:28Z");
subjectRightsRequest.setInternalDueDateTime(internalDueDateTime);
DataSubject dataSubject = new DataSubject();
dataSubject.setFirstName("Diego");
dataSubject.setLastName("Siciliani");
dataSubject.setEmail("Diego.Siciliani@contoso.com");
dataSubject.setResidency("USA");
subjectRightsRequest.setDataSubject(dataSubject);
subjectRightsRequest.setMailboxLocations(null);
subjectRightsRequest.setPauseAfterEstimate(true);
LinkedList<String> regulations = new LinkedList<String>();
regulations.add("CCPA");
subjectRightsRequest.setRegulations(regulations);
SubjectRightsRequestAllSiteLocation siteLocations = new SubjectRightsRequestAllSiteLocation();
siteLocations.setOdataType("microsoft.graph.subjectRightsRequestAllSiteLocation");
subjectRightsRequest.setSiteLocations(siteLocations);
LinkedList<User> approvers = new LinkedList<User>();
User user = new User();
user.setId("1B761ED2-AA7E-4D82-9CF5-C09D737B6167");
approvers.add(user);
subjectRightsRequest.setApprovers(approvers);
SubjectRightsRequest result = graphClient.privacy().subjectRightsRequests().post(subjectRightsRequest);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const subjectRightsRequest = {
  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'
    }
  ]
};

await client.api('/privacy/subjectRightsRequests')
	.post(subjectRightsRequest);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\SubjectRightsRequest;
use Microsoft\Graph\Generated\Models\DataSubject;
use Microsoft\Graph\Generated\Models\SubjectRightsRequestAllSiteLocation;
use Microsoft\Graph\Generated\Models\User;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new SubjectRightsRequest();
$requestBody->setType(new SubjectRightsRequestType('export'));
$requestBody->setContentQuery('((\"Diego Siciliani\" OR \"Diego.Siciliani@contoso.com\") OR (participants:\"Diego.Siciliani@contoso.com\"))');
$requestBody->setDataSubjectType(new DataSubjectType('customer'));
$requestBody->setExternalId('F53BF2DA-607D-412A-B568-FAA0F023AC0B');
$requestBody->setDisplayName('Export report for customer Id: 12345');
$requestBody->setDescription('This is a export request');
$requestBody->setIncludeAllVersions(false);
$requestBody->setIncludeAuthoredContent(true);
$requestBody->setInternalDueDateTime(new \DateTime('2022-07-20T22:42:28Z'));
$dataSubject = new DataSubject();
$dataSubject->setFirstName('Diego');
$dataSubject->setLastName('Siciliani');
$dataSubject->setEmail('Diego.Siciliani@contoso.com');
$dataSubject->setResidency('USA');
$requestBody->setDataSubject($dataSubject);
$requestBody->setMailboxLocations(null);
$requestBody->setPauseAfterEstimate(true);
$requestBody->setRegulations(['CCPA', 	]);
$siteLocations = new SubjectRightsRequestAllSiteLocation();
$siteLocations->setOdataType('microsoft.graph.subjectRightsRequestAllSiteLocation');
$requestBody->setSiteLocations($siteLocations);
$approversUser1 = new User();
$approversUser1->setId('1B761ED2-AA7E-4D82-9CF5-C09D737B6167');
$approversArray []= $approversUser1;
$requestBody->setApprovers($approversArray);


$result = $graphServiceClient->privacy()->subjectRightsRequests()->post($requestBody)->wait();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PowerShell

Import-Module Microsoft.Graph.Compliance

$params = @{
	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 = [System.DateTime]::Parse("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"
	}
)
}

New-MgPrivacySubjectRightsRequest -BodyParameter $params

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.subject_rights_request import SubjectRightsRequest
from msgraph.generated.models.data_subject import DataSubject
from msgraph.generated.models.subject_rights_request_all_site_location import SubjectRightsRequestAllSiteLocation
from msgraph.generated.models.user import User

graph_client = GraphServiceClient(credentials, scopes)

request_body = SubjectRightsRequest(
	type = SubjectRightsRequestType.Export,
	content_query = "((\"Diego Siciliani\" OR \"Diego.Siciliani@contoso.com\") OR (participants:\"Diego.Siciliani@contoso.com\"))",
	data_subject_type = DataSubjectType.Customer,
	external_id = "F53BF2DA-607D-412A-B568-FAA0F023AC0B",
	display_name = "Export report for customer Id: 12345",
	description = "This is a export request",
	include_all_versions = False,
	include_authored_content = True,
	internal_due_date_time = "2022-07-20T22:42:28Z",
	data_subject = DataSubject(
		first_name = "Diego",
		last_name = "Siciliani",
		email = "Diego.Siciliani@contoso.com",
		residency = "USA",
	),
	mailbox_locations = None,
	pause_after_estimate = True,
	regulations = [
		"CCPA",
	],
	site_locations = SubjectRightsRequestAllSiteLocation(
		odata_type = "microsoft.graph.subjectRightsRequestAllSiteLocation",
	),
	approvers = [
		User(
			id = "1B761ED2-AA7E-4D82-9CF5-C09D737B6167",
		),
	],
)

result = await graph_client.privacy.subject_rights_requests.post(request_body)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Réponse

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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