Microsoft Graph · Schema

microsoft.graph.subjectRightsRequest

Azure ADCollaborationContactsDocumentsEmailGraphIdentityMicrosoftOffice 365PresentationsProductivitySpreadsheetsT1Tasks
View JSON Schema on GitHub

JSON Schema

microsoft-graph-microsoftgraphsubjectrightsrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.subjectRightsRequest",
  "title": "microsoft.graph.subjectRightsRequest",
  "allOf": [
    {
      "$ref": "#/components/schemas/microsoft.graph.entity"
    },
    {
      "title": "subjectRightsRequest",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "assignedTo": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.identity"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Identity that the request is assigned to."
        },
        "closedDateTime": {
          "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
          "type": "string",
          "description": "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.",
          "format": "date-time",
          "nullable": true
        },
        "contentQuery": {
          "type": "string",
          "description": "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.",
          "nullable": true
        },
        "createdBy": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.identitySet"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Identity information for the entity that created the request."
        },
        "createdDateTime": {
          "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
          "type": "string",
          "description": "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.",
          "format": "date-time",
          "nullable": true
        },
        "dataSubject": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.dataSubject"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Information about the data subject."
        },
        "dataSubjectType": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.dataSubjectType"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The type of the data subject. The possible values are: customer, currentEmployee, formerEmployee, prospectiveEmployee, student, teacher, faculty, other, unknownFutureValue."
        },
        "description": {
          "type": "string",
          "description": "Description for the request.",
          "nullable": true
        },
        "displayName": {
          "type": "string",
          "description": "The name of the request.",
          "nullable": true
        },
        "externalId": {
          "type": "string",
          "description": "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.",
          "nullable": true
        },
        "history": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.subjectRightsRequestHistory"
          },
          "description": "Collection of history change events."
        },
        "includeAllVersions": {
          "type": "boolean",
          "description": "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.",
          "nullable": true
        },
        "includeAuthoredContent": {
          "type": "boolean",
          "description": "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.",
          "nullable": true
        },
        "insight": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.subjectRightsRequestDetail"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Insight about the request."
        },
        "internalDueDateTime": {
          "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
          "type": "string",
          "description": "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.",
          "format": "date-time",
          "nullable": true
        },
        "lastModifiedBy": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.identitySet"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Identity information for the entity that last modified the request."
        },
        "lastModifiedDateTime": {
          "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
          "type": "string",
          "description": "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.",
          "format": "date-time",
          "nullable": true
        },
        "mailboxLocations": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.subjectRightsRequestMailboxLocation"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "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": {
          "type": "boolean",
          "description": "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.",
          "nullable": true
        },
        "regulations": {
          "type": "array",
          "items": {
            "type": "string",
            "nullable": true
          },
          "description": "List of regulations that this request fulfill."
        },
        "siteLocations": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.subjectRightsRequestSiteLocation"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "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": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.subjectRightsRequestStageDetail"
          },
          "description": "Information about the different stages for the request."
        },
        "status": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.subjectRightsRequestStatus"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The status of the request. The possible values are: active, closed, unknownFutureValue."
        },
        "type": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.subjectRightsRequestType"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The type of the request. The possible values are: export, delete, access, tagForAction, unknownFutureValue."
        },
        "approvers": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.user"
          },
          "description": "Collection of users who can approve the request. Currently only supported for requests of type delete.",
          "x-ms-navigationProperty": true
        },
        "collaborators": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.user"
          },
          "description": "Collection of users who can collaborate on the request.",
          "x-ms-navigationProperty": true
        },
        "notes": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.authoredNote"
          },
          "description": "List of notes associated with the request.",
          "x-ms-navigationProperty": true
        },
        "team": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.team"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Information about the Microsoft Teams team that was created for the request.",
          "x-ms-navigationProperty": true
        },
        "@odata.type": {
          "type": "string"
        }
      }
    }
  ],
  "x-ms-discriminator-value": "#microsoft.graph.subjectRightsRequest"
}