Enumerar usuarios
Espacio de nombres: microsoft.graph
Recupere una lista de objetos user.
Nota: Esta solicitud puede tener retrasos de replicación para los usuarios que se crearon, actualizaron o eliminaron recientemente.
Permissions
Se requiere uno de los permisos siguientes 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) | User.ReadBasic.All, User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
Delegado (cuenta personal de Microsoft) | No admitida. |
Aplicación | User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
Los usuarios invitados no pueden llamar a esta API. Para obtener más información acerca de los permisos para miembros e invitados, vea ¿Cuáles son los permisos predeterminados de usuario en Azure Active Directory?
Solicitud HTTP
GET /users
Parámetros de consulta opcionales
Este método admite los $count
parámetros de consulta , $expand
, $filter
, $orderBy
$search
, $select
y $top
OData para ayudar a personalizar la respuesta. No se admite $skip
. Debe especificar o $filter=signInActivity
al enumerar$select=signInActivity
usuarios, ya que la propiedad signInActivity no se devuelve de forma predeterminada.
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. Los parámetros $count
y $search
no están disponibles actualmente en espacios empresariales de Azure AD B2C.
De forma predeterminada, solo se devuelve un conjunto limitado de propiedades (businessPhones, displayName, givenName, id, jobTitle, mail, mobilePhone, officeLocation, preferredLanguage, surname y userPrincipalName). Para devolver un conjunto de propiedades alternativo, especifique el conjunto deseado de propiedades del usuario mediante el parámetro de consulta OData $select
. Por ejemplo, para devolver displayName, givenName y postalCode, agregue lo siguiente a su consulta $select=displayName,givenName,postalCode
.
Las propiedades de extensión también admiten parámetros de consulta como se indica a continuación:
Tipo de extensión | Comentarios |
---|---|
onPremisesExtensionAttributes 1-15 | Solo se devuelve con $select . Admite $filter (eq , ne y eq en valores null ). |
Extensiones de esquema | Solo se devuelve con $select . Admite $filter (eq , ne y eq en valores null ). |
Extensiones abiertas | Solo se devuelve con $expand , es decir, users?$expand=extensions . |
Extensiones de directorio | Solo se devuelve con $select . Admite $filter (eq , ne y eq en valores null ). |
Algunas propiedades no se pueden devolver dentro de una colección de usuarios. Las siguientes propiedades solo se admiten al recuperar un único usuario: aboutMe, birthday, hireDate, interests, mySite, pastProjects, preferredName, responsibilities, schools, skills, mailboxSettings.
Las propiedades siguientes no se admiten en cuentas personales de Microsoft y son null
: aboutMe, birthday, interests, mySite, pastProjects, preferredName, responsibilities, schools, skills, streetAddress.
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 ejecuta correctamente, este método devuelve un código de respuesta 200 OK
y la colección de objetos user en el cuerpo de la respuesta. Si se devuelve una colección de usuarios grande, puede usar la paginación en la aplicación.
Al intentar usar $select
en la colección /users
para recuperar propiedades que no se pueden devolver dentro de una colección de usuarios (por ejemplo, la solicitud) ../users?$select=aboutMe
devuelve un código 501 Not Implemented
de error.
Ejemplos
Ejemplo 1: obtener todos los usuarios
Solicitud
Aquí tiene un ejemplo de la solicitud.
GET https://graph.microsoft.com/v1.0/users
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
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users",
"value": [
{
"businessPhones": [],
"displayName": "Conf Room Adams",
"givenName": null,
"jobTitle": null,
"mail": "Adams@contoso.com",
"mobilePhone": null,
"officeLocation": null,
"preferredLanguage": null,
"surname": null,
"userPrincipalName": "Adams@contoso.com",
"id": "6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0"
},
{
"businessPhones": [
"425-555-0100"
],
"displayName": "MOD Administrator",
"givenName": "MOD",
"jobTitle": null,
"mail": null,
"mobilePhone": "425-555-0101",
"officeLocation": null,
"preferredLanguage": "en-US",
"surname": "Administrator",
"userPrincipalName": "admin@contoso.com",
"id": "4562bcc8-c436-4f95-b7c0-4f8ce89dca5e"
}
]
}
Ejemplo 2: obtener una cuenta de usuario con un nombre de inicio de sesión
Solicitud
Aquí tiene un ejemplo de la solicitud.
Nota: al filtrar por issuerAssignedId, debe proporcionar tanto el emisor como el issuerAssignedId. Sin embargo, el valor del emisor se omitirá en determinados escenarios. Para obtener más información sobre el filtrado por identidades, consulte tipo de recurso objectIdentity
GET https://graph.microsoft.com/v1.0/users?$select=displayName,id&$filter=identities/any(c:c/issuerAssignedId eq 'j.smith@yahoo.com' and c/issuer eq 'My B2C tenant')
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": [
{
"displayName": "John Smith",
"id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd"
}
]
}
Ejemplo 3: Obtener solo un recuento de usuarios
Solicitud
Aquí tiene un ejemplo de la solicitud. Esta solicitud requiere el encabezado ConsistencyLevel establecido en eventual
porque $count
está en la solicitud. Para obtener más información sobre el uso de consistencyLevel y $count
, vea funciones de consulta avanzadas en Azure AD objetos de directorio.
Nota: Los parámetros de consulta
$count
y$search
actualmente no están disponibles en inquilinos de Azure AD B2C.
GET https://graph.microsoft.com/v1.0/users/$count
ConsistencyLevel: eventual
Respuesta
Este es un ejemplo de la respuesta.
HTTP/1.1 200 OK
Content-type: text/plain
893
Ejemplo 4: Usar $filter y $top para obtener un usuario con un nombre para mostrar que comience por "a", junto con un recuento de los objetos devueltos
Solicitud
Aquí tiene un ejemplo de la solicitud. Esta solicitud requiere el encabezado ConsistencyLevel establecido en eventual
y la cadena de consulta $count=true
porque la solicitud tiene los parámetros de consulta $orderBy
y $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.
Nota: Los parámetros de consulta
$count
y$search
actualmente no están disponibles en inquilinos de Azure AD B2C.
GET https://graph.microsoft.com/v1.0/users?$filter=startswith(displayName,'a')&$orderby=displayName&$count=true&$top=1
ConsistencyLevel: eventual
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
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#users",
"@odata.count":1,
"value":[
{
"displayName":"a",
"mail":"a@contoso.com",
"mailNickname":"a_contoso.com#EXT#",
"userPrincipalName":"a_contoso.com#EXT#@microsoft.onmicrosoft.com"
}
]
}
Ejemplo 5: Use $filter para obtener todos los usuarios con un correo que termine con ""a@contoso.com, incluido un recuento de objetos devueltos, con los resultados ordenados por userPrincipalName.
Solicitud
Aquí tiene un ejemplo de la solicitud. Esta solicitud requiere el encabezado ConsistencyLevel establecido en eventual
y la cadena de consulta $count=true
porque la solicitud tiene los parámetros de consulta $orderBy
y $filter
, y también usa el operador endsWith
. Para obtener más información sobre el uso de consistencyLevel y $count
, vea funciones de consulta avanzadas en Azure AD objetos de directorio.
Nota: Los parámetros de consulta
$count
y$search
actualmente no están disponibles en inquilinos de Azure AD B2C.
GET https://graph.microsoft.com/v1.0/users?$filter=endswith(mail,'a@contoso.com')&$orderby=userPrincipalName&$count=true
ConsistencyLevel: eventual
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
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users",
"@odata.count": 1,
"value": [
{
"displayName": "Grady Archie",
"givenName": "Grady",
"jobTitle": "Designer",
"mail": "GradyA@contoso.com",
"userPrincipalName": "GradyA@contoso.com",
"id": "e8b753b5-4117-464e-9a08-713e1ff266b3"
}
]
}
Ejemplo 6: use $search para obtener usuarios cuyos nombres para mostrar contengan las letras "wa", junto con un recuento de los objetos devueltos
Solicitud
Aquí tiene un ejemplo de la solicitud. Esta solicitud requiere el encabezado ConsistencyLevel establecido en eventual
porque $search
está en la solicitud. Para obtener más información sobre el uso de consistencyLevel y $count
, vea funciones de consulta avanzadas en Azure AD objetos de directorio.
Nota: Los parámetros de consulta
$count
y$search
actualmente no están disponibles en inquilinos de Azure AD B2C.
GET https://graph.microsoft.com/v1.0/users?$search="displayName:wa"&$orderby=displayName&$count=true
ConsistencyLevel: eventual
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
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#users",
"@odata.count":7,
"value":[
{
"displayName":"Oscar Ward",
"givenName":"Oscar",
"mail":"oscarward@contoso.com",
"userPrincipalName":"oscarward@contoso.com"
}
]
}
Ejemplo 7: use $search para obtener usuarios con nombres para mostrar que contengan las letras "wa" o las letras "to", junto con un recuento de los objetos devueltos
Solicitud
Aquí tiene un ejemplo de la solicitud. Esta solicitud requiere el encabezado ConsistencyLevel establecido en eventual
porque $search
está en la solicitud. Para obtener más información sobre el uso de consistencyLevel y $count
, vea funciones de consulta avanzadas en Azure AD objetos de directorio.
Nota: Los parámetros de consulta
$count
y$search
actualmente no están disponibles en inquilinos de Azure AD B2C.
GET https://graph.microsoft.com/v1.0/users?$search="displayName:wa" OR "displayName:ad"&$orderbydisplayName&$count=true
ConsistencyLevel: eventual
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
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#users",
"@odata.count":7,
"value":[
{
"displayName":"Oscar Ward",
"givenName":"Oscar",
"mail":"oscarward@contoso.com",
"userPrincipalName":"oscarward@contoso.com"
},
{
"displayName":"contosoAdmin1",
"givenName":"Contoso Administrator",
"mail":"'contosoadmin1@fabrikam.com",
"userPrincipalName":"contosoadmin1_fabrikam.com#EXT#@microsoft.onmicrosoft.com"
}
]
}
Ejemplo 8: Usar $filter para que los usuarios a los que se les asigne una licencia específica
Solicitud
Aquí tiene un ejemplo de la solicitud.
GET https://graph.microsoft.com/v1.0/users?$select=id,mail,assignedLicenses&$filter=assignedLicenses/any(u:u/skuId eq cbdc14ab-d96c-4c30-b9f4-6ada7cdc1d46)
Respuesta
Este es un ejemplo de la respuesta.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users(id,mail,assignedLicenses)",
"value": [
{
"id": "cb4954e8-467f-4a6d-a8c8-28b9034fadbc",
"mail": "admin@contoso.com",
"assignedLicenses": [
{
"disabledPlans": [],
"skuId": "cbdc14ab-d96c-4c30-b9f4-6ada7cdc1d46"
}
]
},
{
"id": "81a133c2-bdf2-4e67-8755-7264366b04ee",
"mail": "DebraB@contoso.com",
"assignedLicenses": [
{
"disabledPlans": [],
"skuId": "cbdc14ab-d96c-4c30-b9f4-6ada7cdc1d46"
}
]
}
]
}
Ejemplo 9: obtener el valor de una extensión de esquema para todos los usuarios
En este ejemplo, el identificador de la extensión de esquema es ext55gb1l09_msLearnCourses
.
Solicitud
GET https://graph.microsoft.com/v1.0/users?$select=ext55gb1l09_msLearnCourses
Respuesta
En la respuesta siguiente, la propiedad de extensión de esquema ext55gb1l09_msLearnCourses
no está asignada en dos de los objetos de usuario.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users(ext55gb1l09_msLearnCourses)",
"value": [
{},
{
"ext55gb1l09_msLearnCourses": {
"@odata.type": "#microsoft.graph.ComplexExtensionValue",
"courseType": "Developer",
"courseName": "Introduction to Microsoft Graph",
"courseId": 1
}
},
{}
]
}
Nota: También puede aplicar
$filter
en la propiedad de extensión de esquema para recuperar objetos en los que una propiedad de la colección coincida con un valor especificado. La sintaxis es/users?$filter={schemaPropertyID}/{propertyName} eq 'value'
. Por ejemplo,GET /users?$select=ext55gb1l09_msLearnCourses&$filter=ext55gb1l09_msLearnCourses/courseType eq 'Developer'
. Se admiten los operadoreseq
ynot
.
Ejemplo 10: Obtención de usuarios que incluyan su última hora de inicio de sesión
Solicitud
Aquí tiene un ejemplo de la solicitud. Los detalles de la propiedad signInActivity requieren una licencia de Azure AD Premium P1/P2 y el permiso AuditLog.Read.All.
Nota: Al especificar
$select=signInActivity
o$filter=signInActivity
al enumerar usuarios, el tamaño máximo de página para$top
es 120. Las solicitudes con$top
un conjunto superior a 120 devolverán páginas con hasta 120 usuarios. signInActivity admite$filter
(eq
,ne
,not
,ge
,le
), pero no con ninguna otra propiedad filtrable.
GET https://graph.microsoft.com/v1.0/users?$select=displayName,userPrincipalName,signInActivity
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
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users(displayName,userPrincipalName,signInActivity)",
"value": [
{
"displayName": "Adele Vance",
"userPrincipalName": "AdeleV@contoso.com",
"id": "1aecaf40-dc3a-461f-88a8-d06994e12898",
"signInActivity": {
"lastSignInDateTime": "2021-06-17T16:41:33Z",
"lastSignInRequestId": "d4d31c40-4c36-4775-ad59-7d1e6a171f00",
"lastNonInteractiveSignInDateTime": "0001-01-01T00:00:00Z",
"lastNonInteractiveSignInRequestId": ""
}
},
{
"displayName": "Alex Wilber",
"userPrincipalName": "AlexW@contoso.com",
"id": "f0662ee5-84b1-43d6-8338-769cce1bc141",
"signInActivity": {
"lastSignInDateTime": "2021-07-29T15:53:27Z",
"lastSignInRequestId": "f3149ee1-e347-4181-b45b-99a1f82b1c00",
"lastNonInteractiveSignInDateTime": "2021-07-29T17:53:42Z",
"lastNonInteractiveSignInRequestId": "868efa6a-b2e9-40e9-9b1c-0aaea5b50200"
}
}
]
}