List users
Namespace: microsoft.graph
Retrieve a list of user objects.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | User.ReadBasic.All, User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
Delegated (personal Microsoft account) | Not supported. |
Application | User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
HTTP request
GET /users
Optional query parameters
This method supports the OData query parameters to help customize the response, including $search
, $count
, $filter
, and $select
. You can use $search
on the displayName property. When items are added or updated for this resource, they are specially indexed for use with the $count
and $search
query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index. The $count
and $search
parameters are currently not available in Azure AD B2C tenants.
By default, only a limited set of properties are returned (businessPhones, displayName, givenName, id, jobTitle, mail, mobilePhone, officeLocation, preferredLanguage, surname, and userPrincipalName).
To return an alternative property set, specify the desired set of user properties using the OData $select
query parameter. For example, to return displayName, givenName, and postalCode, add the following to your query $select=displayName,givenName,postalCode
.
Certain properties cannot be returned within a user collection. The following properties are only supported when retrieving an single user: aboutMe, birthday, hireDate, interests, mySite, pastProjects, preferredName, responsibilities, schools, skills, mailboxSettings.
Request headers
Header | Value |
---|---|
Authorization | Bearer {token} (required) |
ConsistencyLevel | eventual. This header and $count are required when using $search , or when using $filter with the $orderby query parameter, or $filter with the endsWith logical operator. It uses an index that may not be up-to-date with recent changes to the object. |
Request body
Do not supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and collection of user objects in the response body. If a large user collection is returned, you can use paging in your app.
Examples
Example 1: Get all users
Request
The following is an example of the request.
GET https://graph.microsoft.com/v1.0/users
Response
The following is an example of the response.
Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"displayName":"contoso1",
"mail":"'contoso1@gmail.com",
"mailNickname":"contoso1_gmail.com#EXT#",
"otherMails":["contoso1@gmail.com"],
"proxyAddresses":["SMTP:contoso1@gmail.com"],
"userPrincipalName":"contoso1_gmail.com#EXT#@microsoft.onmicrosoft.com"
}
]
}
Example 2: Get a user account using a sign-in name
Request
The following is an example of the request.
Note: When filtering on identities, you must supply both issuer and issuerAssignedId. The value of issuerAssignedId must be the email address of the user account, not the user principal name (UPN). If a UPN is used, the response will be an empty list.
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 'contoso.onmicrosoft.com')
Response
The following is an example of the response.
Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"displayName": "John Smith"
}
]
}
Example 3: Get only a count of users
Request
The following is an example of the request.
GET https://graph.microsoft.com/v1.0/users/$count
ConsistencyLevel: eventual
Response
The following is an example of the response.
HTTP/1.1 200 OK
Content-type: text/plain
893
Example 4: Use $filter and $top to get one user with a display name that starts with 'a' including a count of returned objects
Request
The following is an example of the request.
GET https://graph.microsoft.com/v1.0/users?$filter=startswith(displayName,'a')&$orderby=displayName&$count=true&$top=1
ConsistencyLevel: eventual
Response
The following is an example of the response.
Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.
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#",
"otherMails":["a@contoso.com"],
"proxyAddresses":["SMTP:a@contoso.com"],
"userPrincipalName":"a_contoso.com#EXT#@microsoft.onmicrosoft.com"
}
]
}
Example 5: Use $filter to get all users with a mail that ends with 'a@contoso.com', including a count of returned objects, with the results ordered by userPrincipalName
Request
The following is an example of the request.
GET https://graph.microsoft.com/v1.0/users?$filter=endswith(mail,'a@contoso.com')&$orderby=userPrincipalName&$count=true
ConsistencyLevel: eventual
Response
The following is an example of the response.
Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.
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"
}
]
}
Example 6: Use $search to get users with display names that contain the letters 'wa' including a count of returned objects
Request
The following is an example of the request.
GET https://graph.microsoft.com/v1.0/users?$search="displayName:wa"&$orderby=displayName&$count=true
ConsistencyLevel: eventual
Response
The following is an example of the response.
Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.
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",
"mailNickname":"oscward",
"userPrincipalName":"oscarward@contoso.com"
}
]
}
Example 7: Use $search to get users with display names that contain the letters 'wa' or the letters 'to' including a count of returned objects
Request
The following is an example of the request.
GET https://graph.microsoft.com/v1.0/users?$search="displayName:wa" OR "displayName:to"&$orderbydisplayName&$count=true
ConsistencyLevel: eventual
Response
The following is an example of the response.
Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.
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",
"mailNickname":"oscward",
"userPrincipalName":"oscarward@contoso.com"
},
{
"displayName":"contoso1",
"mail":"'contoso1@gmail.com",
"mailNickname":"contoso1_gmail.com#EXT#",
"proxyAddresses":["SMTP:contoso1@gmail.com"],
"userPrincipalName":"contoso1_gmail.com#EXT#@microsoft.onmicrosoft.com"
}
]
}
Example 8: Use $filter to get users who are assigned a specific license
Request
The following is an example of the request.
GET https://graph.microsoft.com/v1.0/users?$select=id,mail,assignedLicenses&$filter=assignedLicenses/any(u:u/skuId eq cbdc14ab-d96c-4c30-b9f4-6ada7cdc1d46)
Response
The following is an example of the response.
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"
}
]
}
]
}