directoryObject 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 Microsoft Entra object. The directoryObject type is the base type for the following directory entity types generally referred to as directory objects:
- application
- administrativeUnit
- appRoleAssignment
- directoryObject
- directoryRole
- device
- externalProfile
- group
- orgContact
- servicePrincipal
- user
This resource supports:
- Using delta query to track incremental additions, deletions, and updates, by providing a delta function.
Methods
| Method | Return Type | Description |
|---|---|---|
| Get directory object | directoryObject | Read the properties of a directory object. |
| Get delta for directory object | directoryObject collection | Get incremental changes for directory objects such as users, groups, applications, and service principals. Filtering is required on either the id of the derived type or the derived type itself. For more information on delta queries, see the Use delta query to track changes in Microsoft Graph data. |
| Delete directory object | None | Delete a directory object. |
| Check member groups | String collection | Check for membership in a specified list of groups, and return from that list those groups of which the specified user, group, service principal, organizational contact, or directory object is a member. The check is transitive. |
| Get member groups | String collection | Return all groups that the user, group, service principal, organizational contact, device, or directory object is a member of. The check is transitive. |
| Check member objects | String collection | Check for membership in a list of group, administrative units, or directory roles for the specified user, group, device, organizational contact, or directory object. This method is transitive. |
| Get member objects | String collection | Return all groups, administrative units, and directory roles that the user, group, device, organizational contact, or directory object is a member of. The check is transitive. |
| Get directoryObjects by ids | directoryObject collection | Get a set of directory objects based on a set of supplied ids. |
| Validate properties | JSON | Validate a Microsoft 365 group's display name or mail nickname complies with naming policies. |
Properties
| Property | Type | Description |
|---|---|---|
| deletedDateTime | DateTimeOffset | Date and time when this object was deleted. Always null when the object hasn't been deleted. |
| id | String | The unique identifier for the object. For example, 12345678-9abc-def0-1234-56789abcde. The value of the id property is often but not exclusively in the form of a GUID; treat it as an opaque identifier and do not rely on it being a GUID. Key. Not nullable. Read-only. |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"deletedDateTime": "String (timestamp)",
"id": "String (identifier)"
}