Enumerar miembros

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta 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 Versión.

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

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) AdministrativeUnit.Read.All AdministrativeUnit.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación AdministrativeUnit.Read.All AdministrativeUnit.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All

Nota:

Para ver los miembros con una pertenencia oculta en una unidad administrativa, se debe conceder a la aplicación el permiso delegado o de Member.Read.Hidden aplicación.

Para escenarios delegados, el usuario que realiza la llamada debe ser un usuario miembro o tener al menos uno de los siguientes roles de Microsoft Entra:

  • Lectores de directorio
  • Escritores de directorios
  • Administrador de la aplicación
  • Lector de seguridad
  • Administrador de seguridad
  • Administrador de roles con privilegios
  • Administrador de aplicaciones en la nube
  • Aprobador de acceso de caja de seguridad del cliente
  • Administrador de Dynamics 365
  • Administrador de Power BI
  • Administrador de Azure Information Protection
  • Administrador de Análisis de escritorio
  • Administrador de licencias
  • Administrador de Escritorio administrado de Microsoft
  • Administrador de comunicaciones de Teams
  • Ingeniero de soporte en comunicaciones de Teams
  • Especialista de soporte en comunicaciones de Teams
  • Administrador de Teams
  • Administrador de Insights
  • Administrador de datos de cumplimiento
  • Operador de seguridad
  • Administrador de Kaizala
  • Lector global
  • Revisor de directorios

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

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 de 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 Funcionalidades avanzadas de consulta en objetos de directorio.

Encabezados de solicitud

Encabezado Valor
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
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 Funcionalidades avanzadas de consulta en objetos de directorio.

Cuerpo de la solicitud

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

Respuesta

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

Ejemplos

Ejemplo 1: Lista de objetos miembro

Solicitud

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

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

Respuesta

En el ejemplo siguiente se muestra 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: Lista de referencias de miembros

Solicitud

En la solicitud siguiente se enumeran las referencias de miembro de la unidad administrativa y se devuelve una colección de @odata.id referencias a los miembros.

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

Respuesta

En el ejemplo siguiente se muestra 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"
    }
  ]
}