Create subjectRightsRequest

Namespace: microsoft.graph

Create a new subjectRightsRequest object.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	SubjectRightsRequest.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	Not supported

HTTP request

POST /privacy/subjectRightsRequests

Request headers

Name	Description
Authorization	Bearer {token}. Required.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the subjectRightsRequest object.

The following table shows the properties that are required when you create the subjectRightsRequest.

Property	Type	Description
dataSubject	microsoft.graph.dataSubject	Contains the properties for data subject for the request.
dataSubjectType	dataSubjectType	Data subject type. Possible values are: customer, currentEmployee, formerEmployee, prospectiveEmployee, student, teacher, faculty, other, unknownFutureValue.
description	String	Description for the request.
displayName	String	Name of the request.
internalDueDateTime	DateTimeOffset	Internal due date that is used for tracking the request completion.
regulations	String collection	One or more regulations for the request.
type	subjectRightsRequestType	Type of the request. Possible values are: export, delete, access, tagForAction, unknownFutureValue.

Response

If successful, this method returns a 201 Created response code and a subjectRightsRequest object in the response body.

Examples

Request

HTTP

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

{
    "type": "microsoft.graph.subjectRightsRequestType",
    "dataSubjectType": "microsoft.graph.dataSubjectType",
    "regulations": ["String"],
    "displayName": "String",
    "description": "String",
    "internalDueDateTime": "String (timestamp)",
    "dataSubject": {
        "firstName": "String",
        "lastName": "String",
        "email": "String",
        "residency": "String",
        "phoneNumber": "String",
        "SSN": "String"
    }
}

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var subjectRightsRequest = new SubjectRightsRequestObject
{
	Type = SubjectRightsRequestType.Export,
	DataSubjectType = DataSubjectType.Customer,
	Regulations = new List<String>()
	{
		"String"
	},
	DisplayName = "String",
	Description = "String",
	InternalDueDateTime = DateTimeOffset.Parse("String (timestamp)"),
	DataSubject = new DataSubject
	{
		FirstName = "String",
		LastName = "String",
		Email = "String",
		Residency = "String",
		AdditionalData = new Dictionary<string, object>()
		{
			{"phoneNumber", "String"},
			{"SSN", "String"}
		}
	}
};

await graphClient.Privacy.SubjectRightsRequests
	.Request()
	.AddAsync(subjectRightsRequest);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const subjectRightsRequest = {
    type: 'microsoft.graph.subjectRightsRequestType',
    dataSubjectType: 'microsoft.graph.dataSubjectType',
    regulations: ['String'],
    displayName: 'String',
    description: 'String',
    internalDueDateTime: 'String (timestamp)',
    dataSubject: {
        firstName: 'String',
        lastName: 'String',
        email: 'String',
        residency: 'String',
        phoneNumber: 'String',
        SSN: 'String'
    }
};

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

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := graphmodels.NewSubjectRightsRequest()
type := graphmodels.SUBJECTRIGHTSREQUESTTYPE_GRAPH_MICROSOFT_SUBJECTRIGHTSREQUESTTYPE 
requestBody.SetType(&type) 
dataSubjectType := graphmodels.DATASUBJECTTYPE_GRAPH_MICROSOFT_DATASUBJECTTYPE 
requestBody.SetDataSubjectType(&dataSubjectType) 
regulations := []string {
	"String",

}
requestBody.SetRegulations(regulations)
displayName := "String"
requestBody.SetDisplayName(&displayName) 
description := "String"
requestBody.SetDescription(&description) 
internalDueDateTime , err := time.Parse(time.RFC3339, "String (timestamp)")
requestBody.SetInternalDueDateTime(&internalDueDateTime) 
dataSubject := graphmodels.NewDataSubject()
firstName := "String"
dataSubject.SetFirstName(&firstName) 
lastName := "String"
dataSubject.SetLastName(&lastName) 
email := "String"
dataSubject.SetEmail(&email) 
residency := "String"
dataSubject.SetResidency(&residency) 
additionalData := map[string]interface{}{
	"phoneNumber" : "String", 
	"sSN" : "String", 
}
dataSubject.SetAdditionalData(additionalData)
requestBody.SetDataSubject(dataSubject)

result, err := graphClient.Privacy().SubjectRightsRequests().Post(context.Background(), requestBody, nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new SubjectRightsRequest();
$requestBody->setType(new SubjectRightsRequestType('subjectrightsrequesttype'));

$requestBody->setDataSubjectType(new DataSubjectType('datasubjecttype'));

$requestBody->setRegulations(['String', ]);

$requestBody->setDisplayName('String');

$requestBody->setDescription('String');

$requestBody->setInternalDueDateTime(new DateTime('String (timestamp)'));

$dataSubject = new DataSubject();
$dataSubject->setFirstName('String');

$dataSubject->setLastName('String');

$dataSubject->setEmail('String');

$dataSubject->setResidency('String');

$additionalData = [
'phoneNumber' => 'String', 
'SSN' => 'String', 
];
$dataSubject->setAdditionalData($additionalData);



$requestBody->setDataSubject($dataSubject);


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

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

Note: The response object shown here might be shortened for readability.

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

{
    "type": "microsoft.graph.subjectRightsRequestType",
    "dataSubjectType": "microsoft.graph.dataSubjectType",
    "regulations": [
        "String"
    ],
    "displayName": "String",
    "description": "String",
    "status": "active",
    "internalDueDateTime": "String",
    "lastModifiedDateTime": "String",
    "id": "String",
    "createdDateTime": "String",
    "stages": [
        {
            "stage": "contentRetrieval",
            "status": "notStarted",
            "error": 
            {
                "@odata.type": "microsoft.graph.publicError"
            }
        },
        {
            "stage": "contentReview",
            "status": "notStarted",
            "error": 
            {
                "@odata.type": "microsoft.graph.publicError"
            }
        },
        {
            "stage": "generateReport",
            "status": "notStarted",
            "error": 
            {
                "@odata.type": "microsoft.graph.publicError"
            }
        },
        {
            "stage": "caseResolved",
            "status": "notStarted",
            "error": 
            {
                "@odata.type": "microsoft.graph.publicError"
            }
        }
    ],
    "createdBy": {
        "@odata.type": "microsoft.graph.identitySet"
    },
    "lastModifiedBy": {
        "@odata.type": "microsoft.graph.identitySet"
    },
    "dataSubject": {
        "firstName": "String",
        "lastName": "String",
        "email": "String",
        "residency": "String",
        "phoneNumber": "String",
        "SSN": "String"
    },
    "team": {
        "id": "String (identifier)",
        "webUrl": "String"
    }
}