Get deleted item (directory object)

Articolo
11/15/2024

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.

Retrieve the properties of a recently deleted directory object from deleted items. The following types are supported:

administrativeUnit
application
certificateBasedAuthPki
[certificateAuthorityDetail](../resources/certificateauthoritydetail.md
externalUserProfile
group
pendingExternalUserProfile
servicePrincipal
user

Note: Deleted security groups are deleted permanently and can't be retrieved through this API.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	✅

Permissions

The following table shows the least privileged permission or permissions required to call this API on each supported resource type. Follow best practices to request least privileged permissions. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Supported resource	Delegated (work or school account)	Delegated (personal Microsoft account)	Application
administrativeUnit	AdministrativeUnit.Read.All	Not supported.	AdministrativeUnit.Read.All
application	Application.Read.All	Not supported.	Application.Read.All
externalUserProfile	ExternalUserProfile.Read.All	Not supported	ExternalUserProfile.Read.All
group	Group.Read.All	Not supported.	Group.Read.All
pendingExternalUserProfile	PendingExternalUserProfile.Read.All	Not supported	PendingExternalUserProfile.Read.All
servicePrincipal	Application.Read.All	Not supported.	Application.Read.All
user	User.Read.All	Not supported.	User.Read.All
certificateBasedAuthPki	PublicKeyInfrastructure.Read.All	Not supported.	PublicKeyInfrastructure.Read.All
certificateAuthorityDetail	PublicKeyInfrastructure.Read.All	Not supported.	PublicKeyInfrastructure.Read.All

HTTP request

GET /directory/deleteditems/{object-id}

Optional query parameters

This method supports the OData query parameters to help customize the response.

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Accept	application/json

Request body

Don't supply a request body for this method.

Response

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

Example

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/directory/deleteditems/46cc6179-19d0-473e-97ad-6ff84347bbbb


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Directory.DeletedItems["{directoryObject-id}"].GetAsync();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



mgc-beta directory deleted-items get --directory-object-id {directoryObject-id}

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
deletedItems, err := graphClient.Directory().DeletedItems().ByDirectoryObjectId("directoryObject-id").Get(context.Background(), nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

DirectoryObject result = graphClient.directory().deletedItems().byDirectoryObjectId("{directoryObject-id}").get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

let directoryObject = await client.api('/directory/deleteditems/46cc6179-19d0-473e-97ad-6ff84347bbbb')
	.version('beta')
	.get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->directory()->deletedItems()->byDirectoryObjectId('directoryObject-id')->get()->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

Get-MgBetaDirectoryDeletedItem -DirectoryObjectId $directoryObjectId

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.directory.deleted_items.by_directory_object_id('directoryObject-id').get()

Important

For details about how to add the SDK to your project and create an authProvider instance, see the 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/beta/$metadata#directoryObjects/$entity",
  "id":"46cc6179-19d0-473e-97ad-6ff84347bbbb",
  "displayName":"SampleGroup",
  "groupTypes":["Unified"],
  "mail":"example@contoso.com",
  "mailEnabled":true,
  "mailNickname":"Example",
  "securityEnabled":false,
  "visibility":"Public"
}

Condividi tramite

Get deleted item (directory object)

Permissions

HTTP request

Optional query parameters

Request headers

Request body

Response

Example

Request

Response

Commenti e suggerimenti

Risorse aggiuntive