Partager via

directoryObject: getByIds

  • Article

Espace de noms: microsoft.graph

Renvoie les objets d’annuaire spécifiés dans une liste d’identificateurs. Seul un sous-ensemble de propriétés utilisateur est retourné par défaut dans la version 1.0.

Utilisations courantes de cette fonction :

  • Résolvez les ID retournés par des fonctions (qui retournent des collections d’ID) telles que getMemberObjects ou getMemberGroups dans leurs objets de répertoire de stockage.
  • Résoudre les ID conservés dans une collection externe par l’application pour les objets d’annuaire de sauvegarde.

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

Importante

Lorsqu’une application interroge une relation qui retourne une collection de types directoryObject , si elle n’a pas l’autorisation de lire un certain type de ressource, les membres de ce type sont retournés, mais avec des informations limitées. Par exemple, seule la propriété @odata.type pour le type d’objet et l’ID est retournée, tandis que les autres propriétés sont indiquées comme null. Avec ce comportement, les applications peuvent demander les autorisations les moins privilégiées dont elles ont besoin, plutôt que de s’appuyer sur l’ensemble de Répertoire.*Autorisations. Pour plus d’informations, consultez Informations limitées retournées pour les objets membres inaccessibles.

Requête HTTP

POST /directoryObjects/getByIds

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, indiquez un objet JSON avec les paramètres suivants.

Paramètre Type Description
Ids String collection Collection d’ID dont les objets doivent être renvoyés. Les ID sont des GUID, représentés sous forme de chaînes. Vous pouvez spécifier jusqu’à 1 000 ID.
types Collection de chaînes Collection de types de ressources qui spécifie les collections de ressources à rechercher. Si cela n’est pas spécifié, la valeur par défaut est directoryObject. Elle contient tous les types de ressources définis dans le répertoire. Tout objet qui dérive de directoryObject peut être spécifié dans la collection ; par exemple : utilisateur, groupe, et objets appareil.

Pour rechercher des références à une organisation partenaire fournisseur de solutions Cloud, spécifier directoryObjectPartnerReference. Si cela n’est pas spécifié, la valeur par défaut est directoryObject. Elle contient tous les types de ressources définis dans le répertoire, sauf les références à une organisation partenaire fournisseur de solutions Cloud.

Les valeurs ne respectent pas la casse.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et un objet de collection de chaînes dans le corps de la réponse.

Exemple

Demande

POST https://graph.microsoft.com/v1.0/directoryObjects/getByIds
Content-type: application/json

{
    "ids": [
        "84b80893-8749-40a3-97b7-68513b600544",
        "5d6059b6-368d-45f8-91e1-8e07d485f1d0",
        "0b944de3-e0fc-4774-a49a-b135213725ef",
        "b75a5ab2-fe55-4463-bd31-d21ad555c6e0"
    ],
    "types": [
        "user",
        "group",
        "device"
    ]
}

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#directoryObjects",
    "value": [
      {
        "@odata.type": "#microsoft.graph.user",
        "id": "84b80893-8749-40a3-97b7-68513b600544",
        "displayName": "Trevor Jones"
      },
      {
        "@odata.type": "#microsoft.graph.user",
        "id": "5d6059b6-368d-45f8-91e1-8e07d485f1d0",
        "displayName": "Billy Smith"
      },
      {
         "@odata.type": "#microsoft.graph.group",
         "id": "0b944de3-e0fc-4774-a49a-b135213725ef",
         "description": "Pineview School Staff",
         "groupTypes": [
             "Unified"
         ]
      },
      {
         "@odata.type": "#microsoft.graph.device",
         "id": "b75a5ab2-fe55-4463-bd31-d21ad555c6e0",
         "displayName": "e8ba4e98c000002",
         "deviceId": "4c299165-6e8f-4b45-a5ba-c5d250a707ff"
      }
    ]
}