directoryObject: getByIds

  • Artículo

Espacio de nombres: microsoft.graph

Devuelve los objetos de directorio especificados en una lista de identificadores. De forma predeterminada, solo se devuelve un subconjunto de propiedades de usuario en la versión 1.0.

Algunos usos comunes de esta función son:

  • Resuelva los identificadores devueltos por las funciones (que devuelven colecciones de identificadores), como getMemberObjects o getMemberGroups , en sus objetos de directorio de respaldo.
  • Resolver identificadores que conserva la aplicación en un almacén externo para sus objetos del directorio de copia de seguridad.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet
✅ ✅ ✅ ✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) Directory.Read.All No disponible.
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación Directory.Read.All No disponible.

Cuando una aplicación consulta una relación que devuelve una colección de tipos directoryObject , si no tiene permiso para leer un tipo derivado determinado (como dispositivo), se devuelven los miembros de ese tipo pero con información limitada. Con este comportamiento, las aplicaciones pueden solicitar los permisos con privilegios mínimos que necesitan, en lugar de depender del conjunto de directorios.*Permisos. Para información, consulte Información limitada devuelta para objetos de miembros inaccesibles.

Solicitud HTTP

POST /directoryObjects/getByIds

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Tipo de contenido application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione un objeto JSON con los siguientes parámetros.

Parámetro Tipo Descripción
ids Colección string Una colección de identificadores para la que devolver objetos. Los ID. son GUID, que se representan como cadenas. Puede especificar hasta 1000 identificadores.
types Colección de cadenas Una colección de tipos de recursos que especifica el conjunto de colecciones de recursos en el que debe buscarse. Si no se especifica, el valor predeterminado es directoryObject, que contiene todos los tipos de recursos definidos en el directorio. Cualquier objeto que derive de directoryObject puede especificarse en la colección; por ejemplo, los objetos user, group y device.

Para buscar referencias a organizaciones asociadas proveedoras de soluciones de nube, especifique directoryObjectPartnerReference. Si no se especifica, el valor predeterminado es directoryObject, que contiene todos los tipos de recursos definidos en el directorio, salvo referencias a una organización asociada proveedora de soluciones de nube.

Los valores no distinguen mayúsculas de minúsculas.

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK y un objeto de colección String en el cuerpo de la respuesta.

Ejemplo

Solicitud

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

Respuesta

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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