subjectRightsRequest resource type

Namespace: microsoft.graph

Represents the properties of a subject rights request, which is a formal request by a data subject to a controller to take an action on their personal data.

Inherits from entity.

Methods

Method Return type Description
List subjectRightsRequests subjectRightsRequest collection Get a list of the subjectRightsRequest objects and their properties.
Create subjectRightsRequest subjectRightsRequest Create a new subjectRightsRequest object.
Get subjectRightsRequest subjectRightsRequest Read the properties and relationships of a subjectRightsRequest object.
Update subjectRightsRequest subjectRightsRequest Update the properties of a subjectRightsRequest object.
getFinalAttachment Stream Get the final attachment for the request. The attachment is a zip file that contains all the files that where included by the privacy administrator.
getFinalReport Stream Get the final report for the request. The report is a text file that contains information about the files that where included by the privacy administrator.
List notes authoredNote collection Get the authoredNote resources from the notes navigation property.
Create authoredNote authoredNote Create a new authoredNote object.

Properties

Property Type Description
assignedTo identity Identity that the request is assigned to.
closedDateTime DateTimeOffset The date and time when the request was closed. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
createdBy identitySet Identity information for the entity that created the request.
createdDateTime DateTimeOffset The date and time when the request was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
dataSubject dataSubject Information about the data subject.
dataSubjectType dataSubjectType The type of the data subject. Possible values are: customer, currentEmployee, formerEmployee, prospectiveEmployee, student, teacher, faculty, other, unknownFutureValue.
description String Description for the request.
displayName String The name of the request.
history subjectRightsRequestHistory collection Collection of history change events.
insight subjectRightsRequestDetail Insight about the request.
internalDueDateTime DateTimeOffset The date and time when the request is internally due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
lastModifiedBy identitySet Identity information for the entity that last modified the request.
lastModifiedDateTime DateTimeOffset The date and time when the request was last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
regulations String collection List of regulations that this request will fulfill.
stages subjectRightsRequestStageDetail collection Information about the different stages for the request.
status subjectRightsRequestStatus The status of the request.. Possible values are: active, closed, unknownFutureValue.
type subjectRightsRequestType The type of the request. Possible values are: export, delete, access, tagForAction, unknownFutureValue.

Relationships

Relationship Type Description
notes authoredNote collection List of notes associcated with the request.
team team Information about the Microsoft Teams team that was created for the request.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.subjectRightsRequest",
    "type": "access",
    "dataSubjectType": "customer",
    "regulations": [
        "String"
    ],
    "displayName": "String",
    "description": "String",
    "status": "active",
    "internalDueDateTime": "String (timestamp)",
    "closedDateTime": "String (timestamp)",
    "lastModifiedDateTime": "String (timestamp)",
    "id": "String (identifier)",
    "createdDateTime": "String (timestamp)",
    "stages": [
        {
            "stage": "contentRetrieval",
            "status": "completed",
            "error": 
            {
                "@odata.type": "microsoft.graph.publicError"
            }
        },
        {
            "stage": "contentReview",
            "status": "current",
            "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"
            }
        }
    ],
    "insight": {
        "@odata.type": "microsoft.graph.subjectRightsRequestDetail"
    },
    "createdBy": {
        "@odata.type": "microsoft.graph.identitySet"
    },
    "lastModifiedBy": {
        "@odata.type": "microsoft.graph.identitySet"
    },
    "dataSubject": {
        "@odata.type": "microsoft.graph.dataSubject",
    },
    "team": {
        "@odata.type": "microsoft.graph.team"
    }
}