Enumerar miembros
Espacio de nombres: microsoft.graph
Use esta API para obtener la lista de miembros (usuarios, grupos o 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 |
Importante
Cuando una aplicación consulta una relación que devuelve una colección de tipos directoryObject , si no tiene permiso para leer un tipo de recurso determinado, se devuelven miembros de ese tipo pero con información limitada. Por ejemplo, solo se devuelve la propiedad @odata.type para el tipo de objeto y el identificador , mientras que otras propiedades se indican como null
. 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.
Nota: Para enumerar los miembros de una pertenencia oculta en una unidad administrativa, también se requiere el permiso Member.Read.Hidden .
Solicitud HTTP
GET /directory/administrativeUnits/{id}/members
GET /directory/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
, $count
y $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
Nombre | Descripción |
---|---|
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, grupos y dispositivos.
GET https://graph.microsoft.com/v1.0/directory/administrativeUnits/8a07f5a8-edc9-4847-bbf2-dde106594bf4/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
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
"value": [
{
"@odata.type": "#microsoft.graph.device",
"id": "7c06cd31-7c30-4f3b-a5c3-444cd8dd63ac",
"accountEnabled": true,
"deviceId": "6fa60d52-01e7-4b18-8055-4759461fc16b",
"displayName": "Test Windows device",
"operatingSystem": "Windows"
},
{
"@odata.type": "#microsoft.graph.device",
"id": "c530e1f6-7b4c-4313-840e-cf1a99ec3b38",
"accountEnabled": false,
"deviceId": "4c299165-6e8f-4b45-a5ba-c5d250a707ff",
"displayName": "Test Linux device",
"operatingSystem": "linux"
}
]
}
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/v1.0/directory/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/v1.0/directoryObjects/492c5308-59fd-4740-9c83-4b3db07a6d70"
},
{
"@odata.id": "https://graph.microsoft.com/v1.0/directoryObjects/07eaa5c7-c9b6-45cf-8ff7-3147d5122caa"
}
]
}