Namespace: microsoft.graph
Crie um novo objeto subjectRightsRequest .
Esta API está disponível nas seguintes implementações de cloud nacionais.
| Serviço global |
US Government L4 |
US Government L5 (DOD) |
China operada pela 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Permissões
Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.
| Tipo de permissão |
Permissões com menos privilégios |
Permissões com privilégios superiores |
| Delegado (conta corporativa ou de estudante) |
SubjectRightsRequest.ReadWrite.All |
Indisponível. |
| Delegado (conta pessoal da Microsoft) |
Sem suporte. |
Sem suporte. |
| Aplicativo |
Sem suporte. |
Sem suporte. |
Solicitação HTTP
Cuidado
A API de pedido de direitos do requerente no /privacy nó foi preterida e deixará de devolver dados a 30 de março de 2025. Utilize o novo caminho em /security.
POST /security/subjectRightsRequests
POST /privacy/subjectRightsRequests
| Nome |
Descrição |
| Autorização |
{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
| Content-Type |
application/json. Obrigatório. |
Corpo da solicitação
No corpo do pedido, forneça uma representação JSON do objeto subjectRightsRequest .
A tabela seguinte lista as propriedades necessárias quando cria o assuntoRightsRequest.
| Propriedade |
Tipo |
Descrição |
| aprovadores |
Coleção user |
Coleção de utilizadores que podem aprovar o pedido. Atualmente, só é suportado para pedidos do tipodelete. |
| colaboradores |
Coleção user |
Coleção de utilizadores que podem colaborar no pedido. |
| contentQuery |
Cadeia de caracteres |
Consulta de conteúdo baseada em KQL que deve ser utilizada para pesquisa. Esta propriedade é definida apenas para APIs acedidas através do caminho da \security consulta e não do caminho da \privacy consulta. |
| dataSubject |
dataSubject |
Contém as propriedades do titular dos dados do pedido. |
| dataSubjectType |
dataSubjectType |
Tipo de requerente de dados. Os valores possíveis são: customer, , currentEmployeeformerEmployee, prospectiveEmployee, , teacherstudent, faculty, , other, . unknownFutureValue |
| description |
Cadeia de caracteres |
Descrição do pedido. |
| displayName |
Cadeia de caracteres |
Nome do pedido. |
| externalId |
Cadeia de caracteres |
O ID externo do pedido que é imutável após a criação e é utilizado para controlar o pedido para o sistema externo. Esta propriedade é definida apenas para APIs acedidas através do caminho da \security consulta e não do caminho da \privacy consulta. |
| includeAllVersions |
Booliano |
Inclua todas as versões dos documentos. Por predefinição, são devolvidas as cópias atuais dos documentos. Se os sites do SharePoint tiverem o controlo de versões ativado, incluindo todas as versões inclui automaticamente as cópias históricas dos documentos. Esta propriedade é definida apenas para APIs acedidas através do caminho da \security consulta e não do caminho da \privacy consulta. |
| includeAuthoredContent |
Booliano |
Incluir conteúdo criado pelo titular dos dados. Esta propriedade é definida apenas para APIs acedidas através do caminho da \security consulta e não do caminho da \privacy consulta. |
| internalDueDateTime |
DateTimeOffset |
Data para conclusão interna que é utilizada para controlar a conclusão do pedido. |
| mailboxLocations |
subjectRightsRequestMailboxLocation |
As localizações da caixa de correio que devem ser pesquisadas. Esta propriedade é definida apenas para APIs acedidas através do caminho da \security consulta e não do caminho da \privacy consulta. |
| pauseAfterEstimate |
Booliano |
Coloque o pedido em pausa após a conclusão da estimativa. Por predefinição, a estimativa de dados é executada e, em seguida, é interrompida, permitindo-lhe pré-visualizar os resultados e, em seguida, selecionar a opção para obter dados na IU. Pode definir esta propriedade como false se quiser que esta execute a estimativa e, em seguida, comece automaticamente com a obtenção do conteúdo. Esta propriedade é definida apenas para APIs acedidas através do caminho da \security consulta e não do caminho da \privacy consulta. |
| regulamentos |
String collection |
Um ou mais regulamentos para o pedido. |
| siteLocations |
subjectRightsRequestSiteLocation |
As localizações do site do SharePoint e do OneDrive que devem ser pesquisadas. Esta propriedade é definida apenas para APIs acedidas através do caminho da \security consulta e não do caminho da \privacy consulta. |
| type |
subjectRightsRequestType |
Tipo do pedido. Os valores possíveis são: export, access, delete, tagForAction, unknownFutureValue. |
Resposta
Se for bem-sucedido, este método devolve um 201 Created código de resposta e um objeto subjectRightsRequest no corpo da resposta.
Exemplos
Solicitação
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);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
// 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)
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
// 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);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
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);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
<?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();
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
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
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
# 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)
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
Resposta
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
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"
}
}