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 | subjectRightsRequest collection | Get a list of the subjectRightsRequest objects and their properties. |
| Create | subjectRightsRequest | Create a new subjectRightsRequest object. |
| Get | subjectRightsRequest | Read the properties and relationships of a subjectRightsRequest object. |
| Update | subjectRightsRequest | Update the properties of a subjectRightsRequest object. |
| Get final attachment | Stream | Get the final attachment for the request. The attachment is a zip file that contains all the files that the privacy administrator included. |
| Get final report | Stream | Get the final report for the request. The report is a text file that contains information about the files that the privacy administrator included. |
| List notes | authoredNote collection | Get the authoredNote resources from the notes navigation property. |
| Create note | 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. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| contentQuery | String | KQL based content query that should be used for search. This property is defined only for APIs accessed using the \security query path and not the \privacy query path. |
| 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. 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. |
| externalId | String | The external ID for the request that is immutable after creation and is used for tracking the request for the external system. This property is defined only for APIs accessed using the \security query path and not the \privacy query path. |
| history | subjectRightsRequestHistory collection | Collection of history change events. |
| id | String | Unique identifier for the subjectRightsRequest object. Inherited from entity. |
| includeAllVersions | Boolean | Include all versions of the documents. By default, the current copies of the documents are returned. If SharePoint sites have versioning enabled, including all versions includes the historical copies of the documents. This property is defined only for APIs accessed using the \security query path and not the \privacy query path. |
| includeAuthoredContent | Boolean | Include content authored by the data subject. This property is defined only for APIs accessed using the \security query path and not the \privacy query path. |
| 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. 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. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| mailboxLocations | subjectRightsRequestMailboxLocation | The mailbox locations that should be searched. This property is defined only for APIs accessed using the \security query path and not the \privacy query path. |
| pauseAfterEstimate | Boolean | Pause the request after estimate has finished. By default, the data estimate runs and then pauses, allowing you to preview results and then select the option to retrieve data in the UI. You can set this property to false if you want it to perform the estimate and then automatically begin with the retrieval of the content. This property is defined only for APIs accessed using the \security query path and not the \privacy query path. |
| regulations | String collection | List of regulations that this request fulfill. |
| siteLocations | subjectRightsRequestSiteLocation | The SharePoint and OneDrive site locations that should be searched. This property is defined only for APIs accessed using the \security query path and not the \privacy query path. |
| 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 |
|---|---|---|
| approvers | user collection | Collection of users who can approve the request. Currently only supported for requests of type delete. |
| collaborators | user collection | Collection of users who can collaborate on the request. |
| notes | authoredNote collection | List of notes associated with the request. |
| team | team | Information about the Microsoft Teams team that was created for the request. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.subjectRightsRequest",
"assignedTo": "String",
"closedDateTime": "String (timestamp)",
"contentQuery": "String",
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"dataSubject": {"@odata.type": "microsoft.graph.dataSubject"},
"dataSubjectType": "String",
"description": "String",
"displayName": "String",
"externalId": "String",
"history": [{"@odata.type": "microsoft.graph.subjectRightsRequestHistory"}],
"id": "String (identifier)",
"includeAllVersions": "Boolean",
"includeAuthoredContent": "Boolean",
"insight": {"@odata.type": "microsoft.graph.subjectRightsRequestDetail"},
"internalDueDateTime": "String (timestamp)",
"lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
"lastModifiedDateTime": "String (timestamp)",
"mailboxLocations": {"@odata.type":"microsoft.graph.subjectRightsRequestMailboxLocation"},
"pauseAfterEstimate":"Boolean",
"regulations": ["String"],
"siteLocations": {"@odata.type":"microsoft.graph.subjectRightsRequestSiteLocation"},
"stages": [{"@odata.type": "microsoft.graph.subjectRightsRequestStageDetail"}],
"status": "String",
"type": "String"
}