名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
削除 済みアイテムから最近削除されたディレクトリ オブジェクトを復元します。 次の種類がサポートされています。
アイテムを誤って削除した場合は、アイテムを完全に復元できます。 さらに、アプリケーションを復元しても、関連付けられているサービス プリンシパルは自動的には復元されません。 削除されたサービス プリンシパルを明示的に復元するには、この API を呼び出す必要があります。
最近削除されたアイテムは最大 30 日間利用できます。 30 日が経過すると、アイテムは完全に削除されます。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス |
米国政府機関 L4 |
米国政府機関 L5 (DOD) |
21Vianet が運営する中国 |
| ✅ |
✅ |
✅ |
✅ |
アクセス許可
次の表は、サポートされている各リソースの種類でこの API を呼び出すために必要な最小特権アクセス許可を示しています。
ベスト プラクティスに従って、最低特権のアクセス許可を要求します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| サポートされているリソース |
委任 (職場または学校のアカウント) |
委任 (個人用 Microsoft アカウント) |
アプリケーション |
|
administrativeUnit |
AdministrativeUnit.ReadWrite.All |
サポートされていません。 |
AdministrativeUnit.ReadWrite.All |
|
application |
Application.ReadWrite.All |
サポートされていません。 |
Application.ReadWrite.OwnedBy |
|
agentIdentity |
AgentIdentity.DeleteRestore.All |
サポートされていません。 |
AgentIdentity.DeleteRestore.All |
|
agentIdentityBlueprint |
AgentIdentityBlueprint.DeleteRestore.All |
サポートされていません。 |
AgentIdentityBlueprint.DeleteRestore.All |
|
agentIdentityBlueprintPrincipal |
AgentIdentityBlueprintPrincipal.DeleteRestore.All |
サポートされていません。 |
AgentIdentityBlueprintPrincipal.DeleteRestore.All |
|
agentUser |
AgentIdUser.ReadWrite.IdentityParentedBy |
サポートされていません。 |
AgentIdUser.ReadWrite.IdentityParentedBy |
|
certificateBasedAuthPki |
PublicKeyInfrastructure.Read.All |
サポートされていません。 |
PublicKeyInfrastructure.Read.All |
|
certificateAuthorityDetail |
PublicKeyInfrastructure.Read.All |
サポートされていません。 |
PublicKeyInfrastructure.Read.All |
|
externalUserProfile |
ExternalUserProfile.ReadWrite.All |
サポート対象外 |
ExternalUserProfile.ReadWrite.All |
|
グループ |
Group.ReadWrite.All |
サポートされていません。 |
Group.ReadWrite.All |
|
pendingExternalUserProfile |
PendingExternalUserProfile.ReadWrite.All |
サポート対象外 |
PendingExternalUserProfile.ReadWrite.All |
|
servicePrincipal |
Application.ReadWrite.All |
サポートされていません。 |
Application.ReadWrite.OwnedBy |
|
user |
User.DeleteRestore.All |
サポートされていません。 |
User.DeleteRestore.All |
重要
職場または学校アカウントを使用してアクセスを委任するには、サインインしたユーザーに、サポートされている Microsoft Entra ロール、またはこの操作に必要なアクセス許可を付与するカスタム ロールが割り当てられている必要があります。 この操作では、必要最小限の特権のみを提供する次の組み込みロールがサポートされます。
- エージェント ID、エージェント ID ブループリント、エージェント ID ブループリント プリンシパル: エージェント ID 管理者
- 管理単位: ディレクトリ閲覧者 (読み取り専用)、グローバル閲覧者 (読み取り専用)、特権ロール管理者
- アプリケーション: ハイブリッド ID 管理者、クラウド アプリケーション管理者、アプリケーション管理者
- 外部ユーザー プロファイル: グローバル閲覧者 (読み取り専用)、Skype for Business 管理者、Teams 管理者
- グループ: グループ管理者 (役割が割り当て可能なグループを除く)、ユーザー管理者 (役割が割り当て可能なグループを除く)、特権役割管理者 (役割が割り当て可能なグループの最小権限ロール)
- 保留中の外部ユーザー プロファイル: グローバル閲覧者 (読み取り専用)、Skype for Business 管理者、Teams 管理者
- サービス プリンシパル: ハイブリッド ID 管理者、クラウド アプリケーション管理者、アプリケーション管理者
- ユーザー: 認証管理者、特権認証管理者、ユーザー管理者。 ただし、特権管理者ロールを持つユーザーを復元するには:
- 委任されたシナリオでは、アプリに Directory.AccessAsUser.All の委任されたアクセス許可を割り当てる必要があり、呼び出し元のユーザーには、「 機密性の高いアクションを実行できるユーザーは?」に示されているように、より高い特権を持つ管理者ロールも割り当てる必要があります。
- アプリのみのシナリオでは、 User.ReadWrite.All アプリケーション アクセス許可を付与するだけでなく、「 機密性の高い操作を実行できるユーザー」に示されているように、アプリにより高い特権の管理者ロールを割り当てる必要があります。
HTTP 要求
POST /directory/deletedItems/{id}/restore
| 名前 |
説明 |
| Authorization |
ベアラー {token}。 必須です。
認証と認可についての詳細をご覧ください。 |
| Content-type |
application/json |
要求本文
要求本文で、パラメーターの JSON 表現を指定します。
次の表に、このアクションを呼び出すときに必要なパラメーターを示します。
| パラメーター |
型 |
説明 |
| autoReconcileProxyConflict |
ブール型 |
オプションのパラメーター。 アクティブ ユーザーに 1 つ以上のプロキシ アドレスが現在使用されているソフト削除されたユーザーを復元する際に、Microsoft Entra ID が競合するプロキシ アドレスを削除する必要があるかどうかを示します。 論理的に削除された ユーザーの復元にのみ使用されます。 このパラメーターの既定値は false です。 |
| newUserPrincipalName |
文字列 |
復元されたユーザーに追加する新しい userPrincipalName。 省略可能。 |
応答
成功した場合、このメソッドは 200 OK 応答コードと、応答本文で directoryObject オブジェクトを返します。
例
例 1: 削除されたディレクトリ オブジェクトを復元する
要求
POST https://graph.microsoft.com/beta/directory/deletedItems/46cc6179-19d0-473e-97ad-6ff84347bbbb/restore
// 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}"].Restore.PostAsync();
// 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
restore, err := graphClient.Directory().DeletedItems().ByDirectoryObjectId("directoryObject-id").Restore().Post(context.Background(), nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
var result = graphClient.directory().deletedItems().byDirectoryObjectId("{directoryObject-id}").restore().post();
const options = {
authProvider,
};
const client = Client.init(options);
await client.api('/directory/deletedItems/46cc6179-19d0-473e-97ad-6ff84347bbbb/restore')
.version('beta')
.post();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->directory()->deletedItems()->byDirectoryObjectId('directoryObject-id')->restore()->post()->wait();
Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement
Restore-MgBetaDirectoryDeletedItem -DirectoryObjectId $directoryObjectId
# 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').restore.post()
応答
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#directoryObjects/$entity",
"@odata.type":"#microsoft.graph.group",
"id":"46cc6179-19d0-473e-97ad-6ff84347bbbb",
"displayName":"SampleGroup",
"groupTypes":["Unified"],
"mail":"example@contoso.com",
"mailEnabled":true,
"mailNickname":"Example",
"securityEnabled":false,
"visibility":"Public"
}
例 2:削除されたユーザーを復元し、競合しているプロキシ アドレスを削除する
要求
POST https://graph.microsoft.com/beta/directory/deletedItems/78bf875b-9343-4edc-9130-0d3958113563/restore
Content-Type: application/json
{
"autoReconcileProxyConflict": true
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.DirectoryNamespace.DeletedItems.Item.Restore;
var requestBody = new RestorePostRequestBody
{
AdditionalData = new Dictionary<string, object>
{
{
"autoReconcileProxyConflict" , true
},
},
};
// 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}"].Restore.PostAsync(requestBody);
// 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"
graphdirectory "github.com/microsoftgraph/msgraph-beta-sdk-go/directory"
//other-imports
)
requestBody := graphdirectory.NewRestorePostRequestBody()
additionalData := map[string]interface{}{
autoReconcileProxyConflict := true
requestBody.SetAutoReconcileProxyConflict(&autoReconcileProxyConflict)
}
requestBody.SetAdditionalData(additionalData)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
restore, err := graphClient.Directory().DeletedItems().ByDirectoryObjectId("directoryObject-id").Restore().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.directory.deleteditems.item.restore.RestorePostRequestBody restorePostRequestBody = new com.microsoft.graph.beta.directory.deleteditems.item.restore.RestorePostRequestBody();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("autoReconcileProxyConflict", true);
restorePostRequestBody.setAdditionalData(additionalData);
var result = graphClient.directory().deletedItems().byDirectoryObjectId("{directoryObject-id}").restore().post(restorePostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const directoryObject = {
autoReconcileProxyConflict: true
};
await client.api('/directory/deletedItems/78bf875b-9343-4edc-9130-0d3958113563/restore')
.version('beta')
.post(directoryObject);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Directory\DeletedItems\Item\Restore\RestorePostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new RestorePostRequestBody();
$additionalData = [
'autoReconcileProxyConflict' => true,
];
$requestBody->setAdditionalData($additionalData);
$result = $graphServiceClient->directory()->deletedItems()->byDirectoryObjectId('directoryObject-id')->restore()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement
$params = @{
autoReconcileProxyConflict = $true
}
Restore-MgBetaDirectoryDeletedItem -DirectoryObjectId $directoryObjectId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.directory.deleteditems.item.restore.restore_post_request_body import RestorePostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = RestorePostRequestBody(
additional_data = {
"auto_reconcile_proxy_conflict" : True,
}
)
result = await graph_client.directory.deleted_items.by_directory_object_id('directoryObject-id').restore.post(request_body)
応答
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#users/$entity",
"@odata.type": "#microsoft.graph.user",
"id": "78bf875b-9343-4edc-9130-0d3958113563",
"businessPhones": [],
"displayName": "SampleUser",
"givenName": "Sample",
"jobTitle": "Product Marketing Manager",
"mail": "sampleuser@contoso.com",
"mobilePhone": "+1 425 555 0109",
"officeLocation": "18/2111",
"preferredLanguage": "en-US",
"surname": "Vance",
"userPrincipalName": "sampleuser@contoso.com"
}
例 3: 削除されたユーザーを復元し、新しい userPrincipalName を割り当てる
要求
POST https://graph.microsoft.com/beta/directory/deletedItems/78bf875b-9343-4edc-9130-0d3958113563/restore
Content-Type: application/json
{
"newUserPrincipalName": "johndoe@contoso.com"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.DirectoryNamespace.DeletedItems.Item.Restore;
var requestBody = new RestorePostRequestBody
{
AdditionalData = new Dictionary<string, object>
{
{
"newUserPrincipalName" , "johndoe@contoso.com"
},
},
};
// 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}"].Restore.PostAsync(requestBody);
// 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"
graphdirectory "github.com/microsoftgraph/msgraph-beta-sdk-go/directory"
//other-imports
)
requestBody := graphdirectory.NewRestorePostRequestBody()
additionalData := map[string]interface{}{
"newUserPrincipalName" : "johndoe@contoso.com",
}
requestBody.SetAdditionalData(additionalData)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
restore, err := graphClient.Directory().DeletedItems().ByDirectoryObjectId("directoryObject-id").Restore().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.directory.deleteditems.item.restore.RestorePostRequestBody restorePostRequestBody = new com.microsoft.graph.beta.directory.deleteditems.item.restore.RestorePostRequestBody();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("newUserPrincipalName", "johndoe@contoso.com");
restorePostRequestBody.setAdditionalData(additionalData);
var result = graphClient.directory().deletedItems().byDirectoryObjectId("{directoryObject-id}").restore().post(restorePostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const directoryObject = {
newUserPrincipalName: 'johndoe@contoso.com'
};
await client.api('/directory/deletedItems/78bf875b-9343-4edc-9130-0d3958113563/restore')
.version('beta')
.post(directoryObject);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Directory\DeletedItems\Item\Restore\RestorePostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new RestorePostRequestBody();
$additionalData = [
'newUserPrincipalName' => 'johndoe@contoso.com',
];
$requestBody->setAdditionalData($additionalData);
$result = $graphServiceClient->directory()->deletedItems()->byDirectoryObjectId('directoryObject-id')->restore()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement
$params = @{
newUserPrincipalName = "johndoe@contoso.com"
}
Restore-MgBetaDirectoryDeletedItem -DirectoryObjectId $directoryObjectId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.directory.deleteditems.item.restore.restore_post_request_body import RestorePostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = RestorePostRequestBody(
additional_data = {
"new_user_principal_name" : "johndoe@contoso.com",
}
)
result = await graph_client.directory.deleted_items.by_directory_object_id('directoryObject-id').restore.post(request_body)
応答
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#directoryObjects/$entity",
"@odata.type": "#microsoft.graph.user",
"id": "78bf875b-9343-4edc-9130-0d3958113563",
"businessPhones": [],
"displayName": "SampleUser",
"givenName": "Sample",
"mobilePhone": "+1 425 555 0109",
"officeLocation": "18/2111",
"preferredLanguage": "en-US",
"surname": "Vance",
"userPrincipalName": "johndoe@contoso.com"
}