Criar subjectRightsRequest

  • Artigo

Namespace: microsoft.graph

Crie um objeto subjectRightsRequest .

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global Governo dos EUA L4 GOVERNO DOS EUA L5 (DOD) China operada pela 21Vianet
✅ ❌ ❌ ❌

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões privilegiadas mais altas
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 solicitação de direitos de entidade sob o /privacy nó foi preterida e deixará de retornar dados em 30 de março de 2025. Use o novo caminho em /security.

POST /security/subjectRightsRequests
POST /privacy/subjectRightsRequests

Cabeçalhos de solicitação

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 da solicitação, forneça uma representação JSON do objeto subjectRightsRequest .

A tabela a seguir lista as propriedades necessárias ao criar o subjectRightsRequest.

Propriedade Tipo Descrição
Aprovadores Coleção user Coleção de usuários que podem aprovar a solicitação. Atualmente, só há suporte para solicitações de tipodelete.
Colaboradores Coleção user Coleção de usuários que podem colaborar na solicitação.
contentQuery Cadeia de caracteres Consulta de conteúdo baseada em KQL que deve ser usada para pesquisa. Essa propriedade é definida apenas para APIs acessadas usando o caminho da \security consulta e não o caminho da \privacy consulta.
dataSubject dataSubject Contém as propriedades do sujeito de dados para a solicitação.
dataSubjectType dataSubjectType Tipo de assunto de dados. Os valores possíveis são: customer, currentEmployee, formerEmployee, prospectiveEmployee, student, teacher, faculty, other, unknownFutureValue.
description Cadeia de caracteres Descrição da solicitação.
displayName Cadeia de caracteres Nome da solicitação.
externalId Cadeia de caracteres A ID externa da solicitação que é imutável após a criação e é usada para acompanhar a solicitação do sistema externo. Essa propriedade é definida apenas para APIs acessadas usando o caminho da \security consulta e não o caminho da \privacy consulta.
includeAllVersions Booliano Inclua todas as versões dos documentos. Por padrão, as cópias atuais dos documentos são retornadas. Se os sites do SharePoint tiverem a versão habilitada, incluindo todas as versões inclui automaticamente as cópias históricas dos documentos. Essa propriedade é definida apenas para APIs acessadas usando o caminho da \security consulta e não o caminho da \privacy consulta.
includeAuthoredContent Booliano Inclua o conteúdo de autoria do sujeito de dados. Essa propriedade é definida apenas para APIs acessadas usando o caminho da \security consulta e não o caminho da \privacy consulta.
internalDueDateTime DateTimeOffset Data de vencimento interna usada para acompanhar a conclusão da solicitação.
mailboxLocations subjectRightsRequestMailboxLocation Os locais da caixa de correio que devem ser pesquisados. Essa propriedade é definida apenas para APIs acessadas usando o caminho da \security consulta e não o caminho da \privacy consulta.
pauseAfterEstimate Booliano Pausar a solicitação após a conclusão da estimativa. Por padrão, a estimativa de dados é executada e, em seguida, pausa, permitindo que você visualize os resultados e selecione a opção para recuperar dados na interface do usuário. Você pode definir essa propriedade como false se desejar que ela execute a estimativa e comece automaticamente com a recuperação do conteúdo. Essa propriedade é definida apenas para APIs acessadas usando o caminho da \security consulta e não o caminho da \privacy consulta.
Regulamentos Coleção String Um ou mais regulamentos para a solicitação.
siteLocations subjectRightsRequestSiteLocation Os locais do site do SharePoint e do OneDrive que devem ser pesquisados. Essa propriedade é definida apenas para APIs acessadas usando o caminho da \security consulta e não o caminho da \privacy consulta.
type subjectRightsRequestType Tipo da solicitação. Os valores possíveis são: export, access, delete, tagForAction, unknownFutureValue.

Resposta

Se for bem-sucedido, esse método retornará 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"
    }
  ]
}

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"
  }
}