Enumerar miembros

Espacio de nombres: microsoft.graph

Importante

Las API de la /beta versión de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de versiones .

Use esta API para obtener la lista de miembros (usuarios, grupos y dispositivos) en una unidad administrativa.

Permisos

Se requiere uno de los siguientes permisos para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.

Tipo de permiso	Permisos (de menos a más privilegiados)
Delegado (cuenta profesional o educativa)	AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All
Delegado (cuenta personal de Microsoft)	No admitida.
Aplicación	AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All

Nota: Para enumerar los miembros de una pertenencia oculta en una unidad administrativa, se requiere el permiso Member.Read.Hidden.

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

Solicitud HTTP

GET /administrativeUnits/{id}/members
GET /administrativeUnits/{id}/members/$ref

Parámetros de consulta opcionales

Este método (cuando se usa sin $ref) admite los parámetros de consulta OData para ayudar a personalizar la respuesta, incluidos $search, $county $filter. La conversión de OData también está habilitada, por ejemplo, puede convertir para obtener solo los usuarios que son miembros de la unidad administrativa.

$search solo se admite en las propiedades displayName y description . Algunas consultas solo se admiten cuando se usa el encabezado ConsistencyLevel establecido en eventual y $count. Para obtener más información, vea funciones de consulta avanzadas en Azure AD objetos de directorio.

Encabezados de solicitud

Encabezado	Valor
Authorization	{token} de portador. Obligatorio.
ConsistencyLevel	eventual. Este encabezado y $count son necesarios cuando se usa $search,o en un uso específico de $filter. Para obtener más información sobre el uso de consistencyLevel y $count, vea funciones de consulta avanzadas en Azure AD objetos de directorio.

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Si se realiza correctamente, este método devuelve un código 200 OK de respuesta y una colección de objetos de usuario, grupo o dispositivo en el cuerpo de la respuesta. Agregar $ref al final de la solicitud devuelve una colección de solo @odata.id direcciones URL de los miembros.

Ejemplos

Ejemplo 1: Enumerar objetos miembros

Solicitud

La siguiente solicitud enumerará los miembros de la unidad administrativa, devolviendo una colección de usuarios o grupos.

GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members

Respuesta

Este es un ejemplo de la 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

{
  "value":[
    {
      "@odata.type":"#microsoft.graph.user",
      "id":"492c5308-59fd-4740-9c83-4b3db07a6d70"
      "accountEnabled":true,
      "businessPhones":[],
      "companyName":null,
      "displayName":"Demo User"
    },
    {
      "@odata.type":"#microsoft.graph.group",
      "id":"07eaa5c7-c9b6-45cf-8ff7-3147d5122caa",
      "description":"This group is the best ever",
      "displayName":"Awesome group"
    }
  ]
}

Ejemplo 2: Enumerar referencias de miembros

Solicitud

La siguiente solicitud enumerará las referencias de miembros de la unidad administrativa, devolviendo una colección de @odata.id referencias a los miembros.

GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members/$ref

Respuesta

Este es un ejemplo de la 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

{
  "value":[
    {
      "@odata.id": "https://graph.microsoft.com/beta/directoryObjects/492c5308-59fd-4740-9c83-4b3db07a6d70"
    },
    {
      "@odata.id": "https://graph.microsoft.com/beta/directoryObjects/07eaa5c7-c9b6-45cf-8ff7-3147d5122caa"
    }
  ]
}