Créer subjectRightsRequest

Espace de noms: microsoft.graph

Créez un objet subjectRightsRequest .

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) SubjectRightsRequest.ReadWrite.All* Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Non prise en charge. Non prise en charge.

Requête HTTP

Attention

L’API de demande de droits de l’objet sous le /privacy nœud est déconseillée et cessera de retourner des données le 30 mars 2025. Utilisez le nouveau chemin d’accès sous /security.

POST /security/subjectRightsRequests
POST /privacy/subjectRightsRequests

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet subjectRightsRequest .

Le tableau suivant répertorie les propriétés requises lorsque vous créez l’objet subjectRightsRequest.

Propriété Type Description
Approbateurs Collection d’utilisateurs Collection d’utilisateurs qui peuvent approuver la demande. Actuellement pris en charge uniquement pour les demandes de typedelete.
Collaborateurs Collection d’utilisateurs Collection d’utilisateurs qui peuvent collaborer sur la demande.
contentQuery Chaîne Requête de contenu basée sur KQL qui doit être utilisée pour la recherche. Cette propriété est définie uniquement pour les API accessibles à l’aide du chemin de requête \security et non du chemin de requête \privacy .
dataSubject dataSubject Contient les propriétés de la personne concernée pour la requête.
dataSubjectType dataSubjectType Type de personne concernée. Les valeurs possibles sont les suivantes : customer, currentEmployee, formerEmployee, prospectiveEmployee, student, teacher, faculty, other, unknownFutureValue.
description Chaîne Description de la demande.
displayName Chaîne Nom de la demande.
externalId Chaîne ID externe de la requête immuable après sa création et utilisé pour le suivi de la demande pour le système externe. Cette propriété est définie uniquement pour les API accessibles à l’aide du chemin de requête \security et non du chemin de requête \privacy .
includeAllVersions Valeur booléenne Incluez toutes les versions des documents. Par défaut, les copies actuelles des documents sont retournées. Si le contrôle de version est activé sur les sites SharePoint, toutes les versions incluent automatiquement les copies historiques des documents. Cette propriété est définie uniquement pour les API accessibles à l’aide du chemin de requête \security et non du chemin de requête \privacy .
includeAuthoredContent Valeur booléenne Inclure le contenu créé par la personne concernée. Cette propriété est définie uniquement pour les API accessibles à l’aide du chemin de requête \security et non du chemin de requête \privacy .
internalDueDateTime DateTimeOffset Date d’échéance interne utilisée pour le suivi de l’achèvement de la demande.
mailboxLocations subjectRightsRequestMailboxLocation Emplacements de boîte aux lettres qui doivent faire l’objet d’une recherche. Cette propriété est définie uniquement pour les API accessibles à l’aide du chemin de requête \security et non du chemin de requête \privacy .
pauseAfterEstimate Valeur booléenne Suspendez la requête une fois l’estimation terminée. Par défaut, l’estimation des données s’exécute, puis s’interrompt, ce qui vous permet d’afficher un aperçu des résultats, puis de sélectionner l’option permettant de récupérer des données dans l’interface utilisateur. Vous pouvez définir cette propriété sur false si vous souhaitez qu’elle effectue l’estimation, puis commence automatiquement par la récupération du contenu. Cette propriété est définie uniquement pour les API accessibles à l’aide du chemin de requête \security et non du chemin de requête \privacy .
règlement Collection de chaînes Un ou plusieurs règlements pour la demande.
siteLocations subjectRightsRequestSiteLocation Emplacements des sites SharePoint et OneDrive qui doivent faire l’objet d’une recherche. Cette propriété est définie uniquement pour les API accessibles à l’aide du chemin de requête \security et non du chemin de requête \privacy .
type subjectRightsRequestType Type de la demande. Les valeurs possibles sont les suivantes : export, access, delete, tagForAction, unknownFutureValue.

Réponse

Si elle réussit, cette méthode renvoie un 201 Created code de réponse et un objet subjectRightsRequest dans le corps de la réponse.

Exemples

Demande

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

Réponse

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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