directoryRole : delta

  • Article

Espace de noms: microsoft.graph

Obtenez des rôles d’annuaire nouvellement créés, mis à jour ou supprimés sans avoir à effectuer une lecture complète de l’ensemble de la collection de ressources. Pour plus d’informations, consultez Utilisation d’une requête Delta .

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

Requête HTTP

Pour commencer le suivi des modifications, vous effectuez une requête incluant la fonction delta sur la ressource directoryRole .

GET /directoryRoles/delta

Paramètres de requête

Le suivi des modifications entraîne une série d’appels de fonction delta . Si vous utilisez un paramètre de requête (autre que $deltatoken et $skiptoken), vous devez le spécifier dans la requête delta initiale. Microsoft Graph code automatiquement les paramètres spécifiés dans la partie jeton du @odata.nextLink ou de l’URL @odata.deltaLink fournie dans la réponse. Il vous suffit de spécifier les paramètres de requête de votre choix la première fois. Dans les requêtes suivantes, copiez et appliquez le @odata.nextLink ou l’URL @odata.deltaLink à partir de la réponse précédente, car cette URL inclut déjà les paramètres codés souhaités.

Paramètre de requête Type Description
$deltatoken string Jeton d’état retourné dans l’URL @odata.deltaLink de l’appel de fonction delta précédent pour la même collection de ressources, indiquant la fin de cette série de suivi des modifications. Enregistrez et appliquez l’ensemble de l’URL @odata.deltaLink, y compris ce jeton dans la première requête de la série suivante de suivi des modifications pour cette collection.
$skiptoken string Jeton d’état retourné dans l’URL @odata.nextLink de l’appel de fonction delta précédent, indiquant que d’autres modifications doivent être suivies dans la même collection de ressources.

Paramètres de requête OData

Cette méthode prend en charge les paramètres de requête OData pour vous aider à personnaliser la réponse.

  • Vous pouvez utiliser un paramètre de requête $select comme dans toute requête GET pour spécifier uniquement les propriétés dont vous avez besoin pour de meilleures performances. La propriété id est toujours renvoyée.

  • Pour $filter, la prise en charge est limitée :

    • La seule expression prise en charge $filter est pour le suivi des modifications pour des ressources spécifiques, par leur ID : $filter=id+eq+{value} ou $filter=id+eq+{value1}+or+id+eq+{value2}. Le nombre d’ID que vous pouvez spécifier est limité par la longueur maximale de l’URL.

En-têtes de demande

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

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse et un 200 OK objet de collection directoryRole dans le corps de la réponse. La réponse inclut également une URL @odata.nextLink ou une URL @odata.deltaLink.

  • Si une URL @odata.nextLink est renvoyée, d’autres pages de données peuvent être récupérées dans la session. L’application continue d’effectuer des requêtes à l’aide de l’URL @odata.nextLink jusqu’à ce que la réponse contienne une URL @odata.deltaLink.

  • Si une URL @odata.deltaLink est renvoyée, il n’existe aucune autre donnée sur l’état de la ressource à renvoyer. Enregistrez l’URL et appliquez-la @odata.deltaLink dans l’appel delta suivant pour en savoir plus sur les modifications apportées à la ressource à l’avenir.

Exemple

Demande

GET https://graph.microsoft.com/v1.0/directoryRoles/delta

Réponse

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

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryRoles",
  "@odata.nextLink": "https://graph.microsoft.com/v1.0/directoryRoles/delta?$skiptoken=pkXMyA5aFCIMmH1Kk1XEAnf2X-fodqXKXF03gYPQknSHRxogVsxvSq_26nhos-O2-shortened",
  "value": [
    {
      "description": "Device Administrators",
      "displayName": "Azure AD Joined Device Local Administrator",
      "roleTemplateId": "9f06204d-73c1-4d4c-880a-6edb90606fd8",
      "id": "f8e85ed8-f66f-4058-b170-3efae8b9c6e5",
      "members@delta": [
        {
          "@odata.type": "#microsoft.graph.user",
          "id": "bb165b45-151c-4cf6-9911-cd7188912848",
          "@removed": {
            "reason": "deleted"
          }
        }
      ]
    }
  ]
}

Contenu connexe