<!--
{
  "availability" : [
    "iOS: 9.3.0 -",
    "iPadOS: 9.3.0 -",
    "macCatalyst: 9.3.0 -",
    "macOS: 10.13.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "DeviceManagement",
  "identifier" : "/documentation/DeviceManagement/User-List-Command",
  "metadataVersion" : "0.1.0",
  "role" : "Web Service Endpoint",
  "symbol" : {
    "kind" : "Web Service Endpoint",
    "modules" : [
      "Device Management"
    ],
    "preciseIdentifier" : "rest:put:mdm#UserListCommand"
  },
  "title" : "User List"
}
-->

# User List

Get a list of users with active accounts on a device.

## Discussion

Refer to the following sections to determine supported channels and requirements, and to see an example request and response.

### Command availability

|||
|--------------------------|----------|
|Device channel            |iOS, macOS|
|User channel              |N/A       |
|Requires supervision      |macOS     |
|Allowed in user enrollment|N/A       |
|Required access right     |N/A       |

### Example request and response

**Request:**

```plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>Command</key>
    <dict>
        <key>RequestType</key>
        <string>UserList</string>
    </dict>
    <key>CommandUUID</key>
    <string>0001_UserList</string>
</dict>
</plist>
```

**Response:**

```plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>CommandUUID</key>
    <string>0001_UserList</string>
    <key>Status</key>
    <string>Acknowledged</string>
    <key>UDID</key>
    <string>cf98820bd143abe0bbf151bed8e8e427594d2f88</string>
    <key>Users</key>
    <array>
        <dict>
            <key>DataQuota</key>
            <integer>10171187200</integer>
            <key>DataUsed</key>
            <integer>145625088</integer>
            <key>HasDataToSync</key>
            <true/>
            <key>IsLoggedIn</key>
            <false/>
            <key>UserName</key>
            <string>example@acme.com</string>
        </dict>
    </array>
</dict>
</plist>
```

## Topics

### Commands and responses

[`UserListCommand`](/documentation/DeviceManagement/UserListCommand)

The command to get a list of users with active accounts on a device.

[`UserListResponse`](/documentation/DeviceManagement/UserListResponse)

A response from the device after it processes the command to get a list of users with active accounts on a device.



---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)