Skip to content

Latest commit

 

History

History
173 lines (140 loc) · 6.45 KB

device-list-registeredusers.md

File metadata and controls

173 lines (140 loc) · 6.45 KB
title description author ms.localizationpriority ms.subservice doc_type
List registeredUsers
Retrieve a list of users that are registered users of the device.
myra-ramdenbourg
medium
entra-directory-management
apiPageType

List registeredUsers

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Retrieve a list of users that are registered users of the device.

For cloud joined devices and registered personal devices, registered users are set to the same value as registered owners at the time of registration.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE limited-info]

The calling user must also be in at least one of the following Microsoft Entra roles:

  • Users
  • Directory Readers
  • Directory Writers
  • Compliance Administrator
  • Device Managers
  • Application Administrator
  • Security Reader
  • Security Administrator
  • Privileged Role Administrator
  • Cloud Application Administrator
  • Customer LockBox Access Approver
  • Dynamics 365 Administrator
  • Power BI Administrator
  • Desktop Analytics Administrator
  • Microsoft Managed Desktop Administrator
  • Teams Communications Administrator
  • Teams Communications Support Engineer
  • Teams Communications Support Specialist
  • Teams Administrator
  • Compliance Data Administrator
  • Security Operator
  • Kaizala Administrator
  • Global Reader
  • Directory Reviewer
  • Windows 365 Administrator

HTTP request

You can address the device using either its id or deviceId.

GET /devices/{id}/registeredUsers
GET /devices(deviceId='{deviceId}')/registeredUsers

Note: The "id" in the request is the "id" property of the device, not the "deviceId" property.

Optional query parameters

This method supports the $search, $count, and $filter OData query parameters to help customize the response. OData cast is also enabled, for example, you can cast to get just the directoryRoles the device is a member of. You can use $search on the displayName property.

Some queries are supported only when you use the ConsistencyLevel header set to eventual and $count. For more information, see Advanced query capabilities on directory objects.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and collection of directoryObject objects in the response body.

Example

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/devices/{id}/registeredUsers

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]


Response

The following example shows the response. Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
    "value": [
        {
            "@odata.type": "#microsoft.graph.user",
            "@odata.id": "https://graph.microsoft.com/v2/72f988bf-86f1-41af-91ab-2d7cd011db47/directoryObjects/96a5df40-617b-4450-8b7a-1dc18b872d8f/Microsoft.DirectoryServices.User",
            "id": "96a5df40-617b-4450-8b7a-1dc18b872d8f",
            "displayName": "Alex Wilber",
            "givenName": "Alex",
            "mail": "AlexW@contoso.com",
            "surname": "Wilber",
            "userPrincipalName": "AlexW@contoso.com"
        }
    ]
}