{ "opencollection": "1.0.0", "info": { "name": "Microsoft Graph Admin Admin.admin directory.directoryObject API", "version": "1.0.0" }, "items": [ { "info": { "name": "directory.directoryObject", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Graph Get deleted item (directory object)", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems", "params": [ { "name": "$top", "value": "50", "type": "query", "description": "Show only the first n items" }, { "name": "$skip", "value": "", "type": "query", "description": "Skip the first n items" }, { "name": "$search", "value": "", "type": "query", "description": "Search items by search phrases" }, { "name": "$filter", "value": "", "type": "query", "description": "Filter items by property values" }, { "name": "$count", "value": "", "type": "query", "description": "Include count of items" }, { "name": "$orderby", "value": "", "type": "query", "description": "Order items by property values" }, { "name": "$select", "value": "", "type": "query", "description": "Select properties to be returned" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand related entities" } ] }, "docs": "Retrieve the properties of a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. Retrieve the properties of a recently deleted directory object from deleted items. The following types are supported:\r\n- administrativeUnit\r\n- application\r\n- certificateBasedAuthPki\r\n- certificateAuthorityDetail\r\n- group\r\n- servicePrincipal\r\n- user" }, { "info": { "name": "Microsoft Graph Get deleted item (directory object)", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/:directoryObject-id", "params": [ { "name": "directoryObject-id", "value": "", "type": "path", "description": "The unique identifier of directoryObject" }, { "name": "$select", "value": "", "type": "query", "description": "Select properties to be returned" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand related entities" } ] }, "docs": "Retrieve the properties of a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. Retrieve the properties of a recently deleted directory object from deleted items. The following types are supported:\r\n- administrativeUnit\r\n- application\r\n- certificateBasedAuthPki\r\n- certificateAuthorityDetail\r\n- group\r\n- servicePrincipal\r\n- user" }, { "info": { "name": "Microsoft Graph Permanently delete an item (directory object)", "type": "http" }, "http": { "method": "DELETE", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/:directoryObject-id", "headers": [ { "name": "If-Match", "value": "" } ], "params": [ { "name": "directoryObject-id", "value": "", "type": "path", "description": "The unique identifier of directoryObject" } ] }, "docs": "Permanently delete a recently deleted application, group, servicePrincipal, or user object from deleted items. After an item is permanently deleted, it cannot be restored. Permanently delete a recently deleted directory object from deleted items. The following types are supported:\r\n- certificateBasedAuthPki\r\n- certificateAuthorityDetail After an item is permanently deleted, it cannot be restored. Administrative units cannot be permanently deleted by using the deletedItems API. Soft-deleted admin" }, { "info": { "name": "Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.administrativeUnit", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/:directoryObject-id/graph.administrativeUnit", "params": [ { "name": "directoryObject-id", "value": "", "type": "path", "description": "The unique identifier of directoryObject" }, { "name": "$select", "value": "", "type": "query", "description": "Select properties to be returned" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand related entities" } ] }, "docs": "Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.administrativeUnit" }, { "info": { "name": "Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.application", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/:directoryObject-id/graph.application", "params": [ { "name": "directoryObject-id", "value": "", "type": "path", "description": "The unique identifier of directoryObject" }, { "name": "$select", "value": "", "type": "query", "description": "Select properties to be returned" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand related entities" } ] }, "docs": "Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.application" }, { "info": { "name": "Microsoft Graph Invoke action checkMemberGroups", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/:directoryObject-id/checkMemberGroups", "params": [ { "name": "directoryObject-id", "value": "", "type": "path", "description": "The unique identifier of directoryObject" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Check for membership in a specified list of group IDs, and return from that list the IDs of groups where a specified object is a member. The specified object can be of one of the following types:\r\n- user\r\n- group\r\n- service principal\r\n- organizational contact\r\n- device\r\n- directory object This function is transitive. You can check up to a maximum of 20 groups per request. This function supports all groups provisioned in Microsoft Entra ID. Because Microsoft 365 groups cannot contain other groups" }, { "info": { "name": "Microsoft Graph Invoke action checkMemberObjects", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/:directoryObject-id/checkMemberObjects", "params": [ { "name": "directoryObject-id", "value": "", "type": "path", "description": "The unique identifier of directoryObject" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Microsoft Graph Invoke action checkMemberObjects" }, { "info": { "name": "Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.device", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/:directoryObject-id/graph.device", "params": [ { "name": "directoryObject-id", "value": "", "type": "path", "description": "The unique identifier of directoryObject" }, { "name": "$select", "value": "", "type": "query", "description": "Select properties to be returned" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand related entities" } ] }, "docs": "Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.device" }, { "info": { "name": "Microsoft Graph Invoke action getMemberGroups", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/:directoryObject-id/getMemberGroups", "params": [ { "name": "directoryObject-id", "value": "", "type": "path", "description": "The unique identifier of directoryObject" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return all the group IDs for the groups that the specified user, group, service principal, organizational contact, device, or directory object is a member of. This function is transitive. This API returns up to 11,000 group IDs. If more than 11,000 results are available, it returns a 400 Bad Request error with the DirectoryResultSizeLimitExceeded error code. If you get the DirectoryResultSizeLimitExceeded error code, use the List group transitive memberOf API instead." }, { "info": { "name": "Microsoft Graph Invoke action getMemberObjects", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/:directoryObject-id/getMemberObjects", "params": [ { "name": "directoryObject-id", "value": "", "type": "path", "description": "The unique identifier of directoryObject" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return all IDs for the groups, administrative units, and directory roles that an object of one of the following types is a member of:\r\n- user\r\n- group\r\n- service principal\r\n- organizational contact\r\n- device\r\n- directory object This function is transitive. Only users and role-enabled groups can be members of directory roles." }, { "info": { "name": "Microsoft Graph List deletedItems (directory objects)", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/:directoryObject-id/graph.group", "params": [ { "name": "directoryObject-id", "value": "", "type": "path", "description": "The unique identifier of directoryObject" }, { "name": "$select", "value": "", "type": "query", "description": "Select properties to be returned" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand related entities" } ] }, "docs": "Retrieve a list of recently deleted directory objects. Currently, deleted items functionality is only supported for the application, servicePrincipal, group, administrative unit, and user resources. Retrieve a list of recently deleted directory objects from deleted items. The following types are supported:\r\n- administrativeUnit\r\n- application\r\n- certificateBasedAuthPki\r\n- certificateAuthorityDetail\r\n- group\r\n- servicePrincipal\r\n- user" }, { "info": { "name": "Microsoft Graph Invoke action restore", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/:directoryObject-id/restore", "params": [ { "name": "directoryObject-id", "value": "", "type": "path", "description": "The unique identifier of directoryObject" } ] }, "docs": "Restore a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. Restore a recently deleted directory object from deleted items. The following types are supported:\r\n- administrativeUnit\r\n- application\r\n- certificateBasedAuthPki\r\n- certificateAuthorityDetail\r\n- group\r\n- servicePrincipal\r\n- user If an item is accidentally deleted, you can fully restore the item. Additionally, restoring an application doesn't automatically restore the associa" }, { "info": { "name": "Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.servicePrincipal", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/:directoryObject-id/graph.servicePrincipal", "params": [ { "name": "directoryObject-id", "value": "", "type": "path", "description": "The unique identifier of directoryObject" }, { "name": "$select", "value": "", "type": "query", "description": "Select properties to be returned" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand related entities" } ] }, "docs": "Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.servicePrincipal" }, { "info": { "name": "Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.user", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/:directoryObject-id/graph.user", "params": [ { "name": "directoryObject-id", "value": "", "type": "path", "description": "The unique identifier of directoryObject" }, { "name": "$select", "value": "", "type": "query", "description": "Select properties to be returned" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand related entities" } ] }, "docs": "Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.user" }, { "info": { "name": "Microsoft Graph Get the number of the resource", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/$count", "params": [ { "name": "$search", "value": "", "type": "query", "description": "Search items by search phrases" }, { "name": "$filter", "value": "", "type": "query", "description": "Filter items by property values" } ] }, "docs": "Microsoft Graph Get the number of the resource" }, { "info": { "name": "Microsoft Graph Get the items of type microsoft.graph.administrativeUnit in the microsoft.graph.directoryObject collection", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/graph.administrativeUnit", "params": [ { "name": "$top", "value": "50", "type": "query", "description": "Show only the first n items" }, { "name": "$skip", "value": "", "type": "query", "description": "Skip the first n items" }, { "name": "$search", "value": "", "type": "query", "description": "Search items by search phrases" }, { "name": "$filter", "value": "", "type": "query", "description": "Filter items by property values" }, { "name": "$count", "value": "", "type": "query", "description": "Include count of items" }, { "name": "$orderby", "value": "", "type": "query", "description": "Order items by property values" }, { "name": "$select", "value": "", "type": "query", "description": "Select properties to be returned" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand related entities" } ] }, "docs": "Microsoft Graph Get the items of type microsoft.graph.administrativeUnit in the microsoft.graph.directoryObject collection" }, { "info": { "name": "Microsoft Graph Get the number of the resource", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/graph.administrativeUnit/$count", "params": [ { "name": "$search", "value": "", "type": "query", "description": "Search items by search phrases" }, { "name": "$filter", "value": "", "type": "query", "description": "Filter items by property values" } ] }, "docs": "Microsoft Graph Get the number of the resource" }, { "info": { "name": "Microsoft Graph Get the items of type microsoft.graph.application in the microsoft.graph.directoryObject collection", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/graph.application", "params": [ { "name": "$top", "value": "50", "type": "query", "description": "Show only the first n items" }, { "name": "$skip", "value": "", "type": "query", "description": "Skip the first n items" }, { "name": "$search", "value": "", "type": "query", "description": "Search items by search phrases" }, { "name": "$filter", "value": "", "type": "query", "description": "Filter items by property values" }, { "name": "$count", "value": "", "type": "query", "description": "Include count of items" }, { "name": "$orderby", "value": "", "type": "query", "description": "Order items by property values" }, { "name": "$select", "value": "", "type": "query", "description": "Select properties to be returned" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand related entities" } ] }, "docs": "Microsoft Graph Get the items of type microsoft.graph.application in the microsoft.graph.directoryObject collection" }, { "info": { "name": "Microsoft Graph Get the number of the resource", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/graph.application/$count", "params": [ { "name": "$search", "value": "", "type": "query", "description": "Search items by search phrases" }, { "name": "$filter", "value": "", "type": "query", "description": "Filter items by property values" } ] }, "docs": "Microsoft Graph Get the number of the resource" }, { "info": { "name": "Microsoft Graph Get the items of type microsoft.graph.device in the microsoft.graph.directoryObject collection", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/graph.device", "params": [ { "name": "$top", "value": "50", "type": "query", "description": "Show only the first n items" }, { "name": "$skip", "value": "", "type": "query", "description": "Skip the first n items" }, { "name": "$search", "value": "", "type": "query", "description": "Search items by search phrases" }, { "name": "$filter", "value": "", "type": "query", "description": "Filter items by property values" }, { "name": "$count", "value": "", "type": "query", "description": "Include count of items" }, { "name": "$orderby", "value": "", "type": "query", "description": "Order items by property values" }, { "name": "$select", "value": "", "type": "query", "description": "Select properties to be returned" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand related entities" } ] }, "docs": "Microsoft Graph Get the items of type microsoft.graph.device in the microsoft.graph.directoryObject collection" }, { "info": { "name": "Microsoft Graph Get the number of the resource", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/graph.device/$count", "params": [ { "name": "$search", "value": "", "type": "query", "description": "Search items by search phrases" }, { "name": "$filter", "value": "", "type": "query", "description": "Filter items by property values" } ] }, "docs": "Microsoft Graph Get the number of the resource" }, { "info": { "name": "Microsoft Graph Invoke action getAvailableExtensionProperties", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/getAvailableExtensionProperties", "body": { "type": "json", "data": "{}" } }, "docs": "Return all directory extension definitions that are registered in a directory, including through multitenant apps. The following entities support extension properties:" }, { "info": { "name": "Microsoft Graph Invoke action getByIds", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/getByIds", "body": { "type": "json", "data": "{}" } }, "docs": "Return the directory objects specified in a list of IDs. Only a subset of user properties are returned by default in v1.0. Some common uses for this function are to:" }, { "info": { "name": "Microsoft Graph List deletedItems (directory objects)", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/graph.group", "params": [ { "name": "$top", "value": "50", "type": "query", "description": "Show only the first n items" }, { "name": "$skip", "value": "", "type": "query", "description": "Skip the first n items" }, { "name": "$search", "value": "", "type": "query", "description": "Search items by search phrases" }, { "name": "$filter", "value": "", "type": "query", "description": "Filter items by property values" }, { "name": "$count", "value": "", "type": "query", "description": "Include count of items" }, { "name": "$orderby", "value": "", "type": "query", "description": "Order items by property values" }, { "name": "$select", "value": "", "type": "query", "description": "Select properties to be returned" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand related entities" } ] }, "docs": "Retrieve a list of recently deleted directory objects. Currently, deleted items functionality is only supported for the application, servicePrincipal, group, administrative unit, and user resources. Retrieve a list of recently deleted directory objects from deleted items. The following types are supported:\r\n- administrativeUnit\r\n- application\r\n- certificateBasedAuthPki\r\n- certificateAuthorityDetail\r\n- group\r\n- servicePrincipal\r\n- user" }, { "info": { "name": "Microsoft Graph Get the number of the resource", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/graph.group/$count", "params": [ { "name": "$search", "value": "", "type": "query", "description": "Search items by search phrases" }, { "name": "$filter", "value": "", "type": "query", "description": "Filter items by property values" } ] }, "docs": "Microsoft Graph Get the number of the resource" }, { "info": { "name": "Microsoft Graph Get the items of type microsoft.graph.servicePrincipal in the microsoft.graph.directoryObject collection", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/graph.servicePrincipal", "params": [ { "name": "$top", "value": "50", "type": "query", "description": "Show only the first n items" }, { "name": "$skip", "value": "", "type": "query", "description": "Skip the first n items" }, { "name": "$search", "value": "", "type": "query", "description": "Search items by search phrases" }, { "name": "$filter", "value": "", "type": "query", "description": "Filter items by property values" }, { "name": "$count", "value": "", "type": "query", "description": "Include count of items" }, { "name": "$orderby", "value": "", "type": "query", "description": "Order items by property values" }, { "name": "$select", "value": "", "type": "query", "description": "Select properties to be returned" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand related entities" } ] }, "docs": "Microsoft Graph Get the items of type microsoft.graph.servicePrincipal in the microsoft.graph.directoryObject collection" }, { "info": { "name": "Microsoft Graph Get the number of the resource", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/graph.servicePrincipal/$count", "params": [ { "name": "$search", "value": "", "type": "query", "description": "Search items by search phrases" }, { "name": "$filter", "value": "", "type": "query", "description": "Filter items by property values" } ] }, "docs": "Microsoft Graph Get the number of the resource" }, { "info": { "name": "Microsoft Graph Get the items of type microsoft.graph.user in the microsoft.graph.directoryObject collection", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/graph.user", "params": [ { "name": "$top", "value": "50", "type": "query", "description": "Show only the first n items" }, { "name": "$skip", "value": "", "type": "query", "description": "Skip the first n items" }, { "name": "$search", "value": "", "type": "query", "description": "Search items by search phrases" }, { "name": "$filter", "value": "", "type": "query", "description": "Filter items by property values" }, { "name": "$count", "value": "", "type": "query", "description": "Include count of items" }, { "name": "$orderby", "value": "", "type": "query", "description": "Order items by property values" }, { "name": "$select", "value": "", "type": "query", "description": "Select properties to be returned" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand related entities" } ] }, "docs": "Microsoft Graph Get the items of type microsoft.graph.user in the microsoft.graph.directoryObject collection" }, { "info": { "name": "Microsoft Graph Get the number of the resource", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/graph.user/$count", "params": [ { "name": "$search", "value": "", "type": "query", "description": "Search items by search phrases" }, { "name": "$filter", "value": "", "type": "query", "description": "Filter items by property values" } ] }, "docs": "Microsoft Graph Get the number of the resource" }, { "info": { "name": "Microsoft Graph Invoke action validateProperties", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/directory/deletedItems/validateProperties", "body": { "type": "json", "data": "{}" } }, "docs": "Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. To validate the properties of an existing group, use the group: validateProperties function. The following policy validations are performed for the display name and mail nickname properties:\r\n1. Validate the prefix and suffix naming policy\r\n2. Validate the custom ban" } ] } ], "bundled": true }