Namespace: microsoft.graph
Erstellen Sie ein neues subjectRightsRequest-Objekt .
Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.
| Weltweiter Service |
US Government L4 |
US Government L5 (DOD) |
China, betrieben von 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Berechtigungen
Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.
| Berechtigungstyp |
Berechtigungen mit den geringsten Berechtigungen |
Berechtigungen mit höheren Berechtigungen |
| Delegiert (Geschäfts-, Schul- oder Unikonto) |
SubjectRightsRequest.ReadWrite.All |
Nicht verfügbar. |
| Delegiert (persönliches Microsoft-Konto) |
Nicht unterstützt |
Nicht unterstützt |
| Application |
Nicht unterstützt |
Nicht unterstützt |
HTTP-Anforderung
Achtung
Die ANFORDERUNGS-API für Antragstellerrechte unter dem /privacy Knoten ist veraltet und gibt am 30. März 2025 keine Daten mehr zurück. Verwenden Sie den neuen Pfad unter /security.
POST /security/subjectRightsRequests
POST /privacy/subjectRightsRequests
Anforderungstext
Geben Sie im Anforderungstext eine JSON-Darstellung des subjectRightsRequest-Objekts an.
In der folgenden Tabelle sind die Eigenschaften aufgeführt, die beim Erstellen von subjectRightsRequest erforderlich sind.
| Eigenschaft |
Typ |
Beschreibung |
| Genehmigenden |
Benutzersammlung |
Sammlung von Benutzern, die die Anforderung genehmigen können. Derzeit nur für Anforderungen vom Typdelete unterstützt. |
| Mitarbeiter |
Benutzersammlung |
Sammlung von Benutzern, die an der Anforderung zusammenarbeiten können. |
| contentQuery |
Zeichenfolge |
KQL-basierte Inhaltsabfrage, die für die Suche verwendet werden soll. Diese Eigenschaft wird nur für APIs definiert, auf die über den \security Abfragepfad und nicht über den \privacy Abfragepfad zugegriffen wird. |
| dataSubject |
dataSubject |
Enthält die Eigenschaften für die betroffene Person für die Anforderung. |
| dataSubjectType |
dataSubjectType |
Typ der betroffenen Person. Die möglichen Werte sind: customer, currentEmployee, formerEmployee, prospectiveEmployee, student, teacher, faculty, other, . unknownFutureValue |
| description |
Zeichenfolge |
Beschreibung für die Anforderung. |
| displayName |
Zeichenfolge |
Der Name der Anforderung. |
| externalId |
Zeichenfolge |
Die externe ID für die Anforderung, die nach der Erstellung unveränderlich ist und zum Nachverfolgen der Anforderung für das externe System verwendet wird. Diese Eigenschaft wird nur für APIs definiert, auf die über den \security Abfragepfad und nicht über den \privacy Abfragepfad zugegriffen wird. |
| includeAllVersions |
Boolean |
Schließen Sie alle Versionen der Dokumente ein. Standardmäßig werden die aktuellen Kopien der Dokumente zurückgegeben. Wenn für SharePoint-Websites die Versionsverwaltung aktiviert ist, werden unter Einbeziehung aller Versionen automatisch die verlaufsbezogenen Kopien der Dokumente eingeschlossen. Diese Eigenschaft wird nur für APIs definiert, auf die über den \security Abfragepfad und nicht über den \privacy Abfragepfad zugegriffen wird. |
| includeAuthoredContent |
Boolean |
Fügen Sie Inhalte ein, die von der betroffenen Person erstellt wurden. Diese Eigenschaft wird nur für APIs definiert, auf die über den \security Abfragepfad und nicht über den \privacy Abfragepfad zugegriffen wird. |
| internalDueDateTime |
DateTimeOffset |
Internes Fälligkeitsdatum, das zum Nachverfolgen des Anforderungsabschlusses verwendet wird. |
| mailboxLocations |
subjectRightsRequestMailboxLocation |
Die Postfachspeicherorte, die durchsucht werden sollen. Diese Eigenschaft wird nur für APIs definiert, auf die über den \security Abfragepfad und nicht über den \privacy Abfragepfad zugegriffen wird. |
| pauseAfterEstimate |
Boolean |
Halten Sie die Anforderung an, nachdem die Schätzung abgeschlossen ist. Standardmäßig wird die Datenschätzung ausgeführt und dann angehalten, sodass Sie eine Vorschau der Ergebnisse anzeigen und dann die Option zum Abrufen von Daten in der Benutzeroberfläche auswählen können. Sie können diese Eigenschaft auf false festlegen, wenn sie die Schätzung durchführen und dann automatisch mit dem Abrufen des Inhalts beginnen soll. Diese Eigenschaft wird nur für APIs definiert, auf die über den \security Abfragepfad und nicht über den \privacy Abfragepfad zugegriffen wird. |
| Vorschriften |
Zeichenfolgensammlung |
Eine oder mehrere Vorschriften für die Anforderung. |
| siteLocations |
subjectRightsRequestSiteLocation |
Die SharePoint- und OneDrive-Websitespeicherorte, die durchsucht werden sollten. Diese Eigenschaft wird nur für APIs definiert, auf die über den \security Abfragepfad und nicht über den \privacy Abfragepfad zugegriffen wird. |
| type |
subjectRightsRequestType |
Typ der Anforderung. Mögliche Werte sind: export, access, delete, tagForAction, unknownFutureValue. |
Antwort
Bei erfolgreicher Ausführung gibt die Methode den 201 Created Antwortcode und ein subjectRightsRequest-Objekt im Antworttext zurück.
Beispiele
Anforderung
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"
}
]
}
// 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);
Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.
// 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)
Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.
// 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);
Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.
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);
Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\SubjectRightsRequest;
use Microsoft\Graph\Generated\Models\SubjectRightsRequestType;
use Microsoft\Graph\Generated\Models\DataSubjectType;
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();
Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.
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
Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.subject_rights_request import SubjectRightsRequest
from msgraph.generated.models.subject_rights_request_type import SubjectRightsRequestType
from msgraph.generated.models.data_subject_type import DataSubjectType
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
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
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)
Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.
Antwort
Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.
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"
}
}