Créer des historiquesDefinitions

  • Article

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Créez un objet accessReviewHistoryDefinition .

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) AccessReview.ReadWrite.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application AccessReview.ReadWrite.All Non disponible.

Pour les scénarios délégués, l’utilisateur connecté doit avoir au moins l’un des rôles Microsoft Entra suivants.

Écrire des révisions d’accès d’un groupe ou d’une application Écrire des révisions d’accès d’un rôle Microsoft Entra
Administrateur d’utilisateurs
Administrateur de gouvernance des identités		 Administrateur de
la gouvernance des identités - Administrateur de rôle privilégié

Requête HTTP

POST /identityGovernance/accessReviews/historyDefinitions

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 accessReviewHistoryDefinition .

Le tableau suivant présente les propriétés requises utilisées pour créer un accessReviewHistoryDefinition.

Propriété Type Description
displayName Chaîne Nom de la collecte de données d’historique de révision d’accès. Obligatoire.
reviewHistoryPeriodStartDateTime DateTimeOffset Horodatage. Les révisions commençant à cette date ou après se trouvent dans les données d’historique récupérées. Obligatoire uniquement si scheduleSettings n’est pas défini.
reviewHistoryPeriodEndDateTime DateTimeOffset Horodatage. Les révisions commençant à cette date ou avant sont incluses dans les données d’historique récupérées. Obligatoire uniquement si scheduleSettings n’est pas défini.
scopes collection accessReviewQueryScope Permet de filtrer les révisions qui sont incluses dans les données d’historique extraites. Récupère les révisions dont l’étendue correspond à cette étendue fournie. Obligatoire.
Pour plus d’informations, consultez Requêtes d’étendue prises en charge pour accessReviewHistoryDefinition.
scheduleSettings accessReviewHistoryScheduleSettings Pas encore pris en charge. Paramètres d’une série de définitions d’historique des révisions d’accès périodiques. Obligatoire uniquement si reviewHistoryPeriodStartDateTime ou reviewHistoryPeriodEndDateTime ne sont pas définis.

Requêtes d’étendue prises en charge pour accessReviewHistoryDefinition

Le $filter paramètre de requête avec l’opérateur contains est pris en charge sur la propriété scope de accessReviewScheduleDefinition. Utilisez le format suivant pour la requête :

/identityGovernance/accessReviews/definitions?$filter=contains(scope/microsoft.graph.accessReviewQueryScope/query, '{object}')

Peut {object} avoir l’une des valeurs suivantes :

Valeur Description
/groups Répertorier chaque accessReviewScheduleDefinition sur des groupes individuels (exclut les définitions étendues à tous les groupes Microsoft 365 avec des invités).
/groups/{group id} Répertorier chaque accessReviewScheduleDefinition sur un groupe spécifique (exclut les définitions étendues à tous les groupes Microsoft 365 avec invités).
./members Répertoriez chaque accessReviewScheduleDefinition délimité à tous les groupes Microsoft 365 avec des invités.
accessPackageAssignments Répertoriez chaque accessReviewScheduleDefinition sur un package d’accès.
roleAssignmentScheduleInstances Répertoriez chaque accessReviewScheduleDefinition pour les principaux affectés à un rôle privilégié.

Le $filter paramètre de requête n’est pas pris en charge sur accessReviewInactiveUserQueryScope ou principalResourceMembershipScope.

Réponse

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

Exemples

L’exemple suivant montre comment créer une définition d’historique des révisions d’accès limitée aux révisions d’accès sur les packages d’accès et les groupes, s’exécutant entre la date de début du 01/01/2021 et la date de fin du 05/04/2021.

Demande

POST https://graph.microsoft.com/beta/identityGovernance/accessReviews/historyDefinitions
Content-Type: application/json

{
  "displayName": "Last quarter's group reviews April 2021",
  "decisions": [
    "approve",
    "deny",
    "dontKnow",
    "notReviewed",
    "notNotified"
  ],
  "reviewHistoryPeriodStartDateTime": "2021-01-01T00:00:00Z",
  "reviewHistoryPeriodEndDateTime": "2021-04-30T23:59:59Z",
  "scopes": [
    {
      "@odata.type": "#microsoft.graph.accessReviewQueryScope",
      "queryType": "MicrosoftGraph",     
      "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, 'accessPackageAssignments')",
      "queryRoot": null
    },  
    {
      "@odata.type": "#microsoft.graph.accessReviewQueryScope",
      "queryType": "MicrosoftGraph",     
      "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, '/groups')",
      "queryRoot": null
    }
  ]
}

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

{
    "@odata.type": "#microsoft.graph.accessReviewHistoryDefinition",
    "id": "b2cb022f-b7e1-40f3-9854-c65a40861c38",
    "displayName": "Last quarter's group reviews April 2021",
    "reviewHistoryPeriodStartDateTime": "2021-01-01T00:00:00Z",
    "reviewHistoryPeriodEndDateTime": "2021-04-30T23:59:59Z",
    "decisions": [
        "approve",
        "deny",
        "dontKnow",
        "notReviewed",
        "notNotified"
    ],
    "status": "requested",
    "createdDateTime": "2021-04-14T00:22:48.9392594Z",
    "createdBy": {
        "id": "957f1027-c0ee-460d-9269-b8444459e0fe",
        "displayName": "MOD Administrator",
        "userPrincipalName": "admin@contoso.com"
    },
    "scopes": [
        {
            "@odata.type": "#microsoft.graph.accessReviewQueryScope",
            "queryType": "MicrosoftGraph",
            "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, 'accessPackageAssignments')",
            "queryRoot": null
        },
        {
            "@odata.type": "#microsoft.graph.accessReviewQueryScope",
            "queryType": "MicrosoftGraph",
            "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, '/groups')",
            "queryRoot": null
        }
    ]
}