device resource type
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents a device registered in the directory. Devices are created in the cloud using the Device Registration Service or by Intune. They're used by conditional access policies for multifactor authentication. These devices can range from desktop and laptop machines to phones and tablets. Inherits from directoryObject.
This resource is an open type that allows other properties to be passed in.
This resource supports:
- Adding your own data to custom properties as extensions.
- Using delta query to track incremental additions, deletions, and updates, by providing a delta function.
- OData query capabilities including
$select,$filter,$search, and$top. Specific usages are supported only with Advanced query capabilities.
Methods
| Method | Return Type | Description |
|---|---|---|
| List | device collection | Retrieve a list of devices registered in the directory. |
| Create | device | Register a new device in the directory. |
| Get | device | Read properties and relationships of device object. |
| Update | device | Update the properties of the device object. |
| Delete | None | Delete the device object. |
| Get delta | device collection | Get incremental changes for devices. |
| List member of | directoryObject collection | List the groups and administrative units that the device is a direct member of. |
| List transitive member of | directoryObject collection | List the groups and administrative units that the device is a member of. This operation is transitive. |
| List registered owners | directoryObject collection | Get the users that are registered owners of the device from the registeredOwners navigation property. |
| Add registered owners | directoryObject collection | Add registered owners of the device. |
| Remove registered owners | directoryObject collection | Delete registered owners from the device. |
| List registered users | directoryObject collection | Get the registered users of the device from the registeredUsers navigation property. |
| Add registered users | directoryObject collection | Add registered users of the device . |
| Remove registered users | directoryObject collection | Remove registered users from the device . |
| List usage rights | usageRight collection | Get a collection of usage rights granted to the device. |
| Check member groups | String collection | Check for membership in a list of groups. The check is transitive. |
| Get member groups | String collection | Return all the groups that the device is a member of. The check is transitive. |
| Check member objects | String collection | Check for membership in a list of groups, directory role, or administrative unit objects. |
| Get member objects | String collection | Return all groups, administrative units, and directory roles that the device is a member of. The check is transitive. |
Properties
Important
Specific usage of $filter and the $search query parameter is supported only when you use the ConsistencyLevel header set to eventual and $count. For more information, see Advanced query capabilities on directory objects.
| Property | Type | Description |
|---|---|---|
| accountEnabled | Boolean | true if the account is enabled; otherwise, false. Default is true. Supports $filter (eq, ne, not, in). Only callers with at least the Cloud Device Administrator role can set this property. |
| alternativeSecurityIds | alternativeSecurityId collection | For internal use only. Not nullable. Supports $filter (eq, not, ge, le). |
| approximateLastSignInDateTime | DateTimeOffset | The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderby. |
| complianceExpirationDateTime | DateTimeOffset | The timestamp when the device is no longer deemed compliant. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| deviceCategory | String | User-defined property set by Intune to automatically add devices to groups and simplify managing devices. |
| deviceId | String | Unique Identifier set by Azure Device Registration Service at the time of registration. This is an alternate key that can be used to reference the device object. Also Supports $filter (eq, ne, not, startsWith). |
| deviceMetadata | String | For internal use only. Set to null. |
| deviceOwnership | String | Ownership of the device. This property is set by Intune. Possible values are: unknown, company, personal. |
| deviceVersion | Int32 | For internal use only. |
| displayName | String | The display name for the device. Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby. |
| domainName | String | The on-premises domain name of Microsoft Entra hybrid joined devices. This property is set by Intune. |
| enrollmentProfileName | String | Enrollment profile applied to the device. For example, Apple Device Enrollment Profile, Device enrollment - Corporate device identifiers, or Windows Autopilot profile name. This property is set by Intune. |
| enrollmentType | String | Enrollment type of the device. This property is set by Intune. Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount. NOTE: This property might return other values apart from those listed. |
| extensionAttributes | onPremisesExtensionAttributes | Contains extension attributes 1-15 for the device. The individual extension attributes aren't selectable. These properties are mastered in cloud and can be set during creation or update of a device object in Microsoft Entra ID. Supports $filter (eq, not, startsWith, and eq on null values). |
| hostnames | String collection | List of host names for the device. |
| id | String | The unique identifier for the device. Inherited from directoryObject. Key, Not nullable. Read-only. Supports $filter (eq, ne, not, in). |
| isCompliant | Boolean | true if the device complies with Mobile Device Management (MDM) policies; otherwise, false. Read-only. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not). |
| isManaged | Boolean | true if the device is managed by a Mobile Device Management (MDM) app; otherwise, false. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not). |
| isManagementRestricted | Boolean | Indicates whether the device is a member of a restricted management administrative unit. The default value is false. Read-only. To manage a device that's a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. |
| isRooted | Boolean | true if the device is rooted or jail-broken. This property can only be updated by Intune. |
| kind | String | Form factor of the device. Only returned if the user signs in with a Microsoft account as part of Project Rome. |
| managementType | String | Management channel of the device. This property is set by Intune. Possible values are: eas, mdm, easMdm, intuneClient, easIntuneClient, configurationManagerClient, configurationManagerClientMdm, configurationManagerClientMdmEas, unknown, jamf, googleCloudDevicePolicyController. |
| manufacturer | String | Manufacturer of the device. Read-only. |
| mdmAppId | String | Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, not, startsWith). |
| model | String | Model of the device. Read-only. |
| name | String | Friendly name of the device. Only returned if user signs in with a Microsoft account as part of Project Rome. |
| onPremisesLastSyncDateTime | DateTimeOffset | The last time at which the object was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Read-only. Supports $filter (eq, ne, not, ge, le, in). |
| onPremisesSecurityIdentifier | String | The on-premises security identifier (SID) for the user who was synchronized from on-premises to the cloud. Read-only. Returned only on $select. Supports $filter (eq). |
| onPremisesSyncEnabled | Boolean | true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only. Supports $filter (eq, ne, not, in, and eq on null values). |
| operatingSystem | String | The type of operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values). |
| operatingSystemVersion | String | Operating system version of the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values). |
| physicalIds | String collection | For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, /$count eq 0, /$count ne 0. |
| platform | String | Platform of device. Only returned if the user signs in with a Microsoft account as part of Project Rome. |
| profileType | String | The profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT. |
| registrationDateTime | DateTimeOffset | Date and time of when the device was registered. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| status | String | Device is online or offline. Only returned if user signs in with a Microsoft account as part of Project Rome. |
| systemLabels | String collection | List of labels applied to the device by the system. Supports $filter (/$count eq 0, /$count ne 0). |
| trustType | String | Type of trust for the joined device. Read-only. Possible values: Workplace (indicates bring your own personal devices), AzureAd (Cloud only joined devices), ServerAd (on-premises domain joined devices joined to Microsoft Entra ID). For more information, see Introduction to device management in Microsoft Entra ID. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| commands | command collection | Set of commands sent to this device. |
| extensions | extension collection | The collection of open extensions defined for the device. Read-only. Nullable. |
| memberOf | directoryObject collection | Groups and administrative units that this device is a member of. Read-only. Nullable. Supports $expand. |
| registeredOwners | directoryObject collection | The user that cloud joined the device or registered their personal device. The registered owner is set at the time of registration. Read-only. Nullable. Supports $expand. |
| registeredUsers | directoryObject collection | Collection of 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. Read-only. Nullable. Supports $expand. |
| transitiveMemberOf | directoryObject collection | Groups and administrative units that this device is a member of. This operation is transitive. Supports $expand. |
| usageRights | usageRight collection | Represents the usage rights a device has been granted. |
JSON representation
The following JSON representation shows the resource type.
{
"accountEnabled": "Boolean",
"approximateLastSignInDateTime": "String (timestamp)",
"complianceExpirationDateTime": "String (timestamp)",
"deviceCategory": "String",
"deviceId": "String",
"deviceMetadata": "String",
"deviceOwnership": "String",
"deviceVersion": "Int32",
"displayName": "String",
"domainName": "String",
"enrollmentProfileName": "String",
"enrollmentType": "String",
"extensionAttributes": {"@odata.type": "microsoft.graph.onPremisesExtensionAttributes"},
"hostnames" : ["String"],
"id": "String (identifier)",
"isCompliant": "Boolean",
"isManaged": "Boolean",
"isRooted": "Boolean",
"kind": "String",
"managementType": "String",
"manufacturer": "String",
"mdmAppId": "String",
"model": "String",
"name": "String",
"onPremisesLastSyncDateTime": "String (timestamp)",
"onPremisesSecurityIdentifier": "String",
"onPremisesSyncEnabled": "Boolean",
"operatingSystem": "String",
"operatingSystemVersion": "String",
"physicalIds": ["String"],
"platform": "String",
"profileType": "String",
"registrationDateTime": "String (timestamp)",
"status": "String",
"systemLabels": ["String"],
"trustType": "String"
}