名前空間: microsoft.graph
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
削除されたアイテムから最近削除されたディレクトリ オブジェクトの一覧を取得します。 次の種類がサポートされています。
- administrativeUnit
- application
- certificateBasedAuthPki
- certificateAuthorityDetail
- externalUserProfile
- group
- pendingExternalUserProfile
- servicePrincipal
- user
手記: 削除されたセキュリティ グループは完全に削除され、この API を使用して取得することはできません。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
アクセス許可
次の表は、サポートされている各リソースの種類でこの API を呼び出すために必要な最小特権のアクセス許可またはアクセス許可を示しています。 ベスト プラクティスに従って、最小限の特権のアクセス許可を要求します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
サポートされているリソース | 委任 (職場または学校のアカウント) | 委任 (個人用 Microsoft アカウント) | アプリケーション |
---|---|---|---|
administrativeUnit | AdministrativeUnit.Read.All | サポートされていません。 | AdministrativeUnit.Read.All |
application | Application.Read.All | サポートされていません。 | Application.Read.All |
externalUserProfile | ExternalUserProfile.Read.All | サポート対象外 | ExternalUserProfile.Read.All |
グループ | Group.Read.All | サポートされていません。 | Group.Read.All |
pendingExternalUserProfile | PendingExternalUserProfile.Read.All | サポート対象外 | PendingExternalUserProfile.Read.All |
servicePrincipal | Application.Read.All | サポートされていません。 | Application.Read.All |
user | User.Read.All | サポートされていません。 | User.Read.All |
certificateBasedAuthPki | PublicKeyInfrastructure.Read.All | サポートされていません。 | PublicKeyInfrastructure.Read.All |
certificateAuthorityDetail | PublicKeyInfrastructure.Read.All | サポートされていません。 | PublicKeyInfrastructure.Read.All |
重要
アプリケーションが directoryObject 型のコレクションを返すリレーションシップをクエリするときに、特定のリソース型を読み取るアクセス許可がない場合、その型のメンバーが返されますが、情報は限られます。 たとえば、@odata.type プロパティでは、オブジェクト型と ID だけが返され、その他のプロパティは null
と表示されます。 この動作により、アプリケーションは、Directory.* 権限が付与されたアクセス許可のセットに依存するのではなく、必要な最小限のアクセス許可を要求できます。 詳細については、「アクセスできないメンバー オブジェクトについて、限定された情報が返される」を参照してください。
重要
職場または学校アカウントを使用した委任されたシナリオでは、サインインしているユーザーに、サポートされているMicrosoft Entraロールまたはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 この操作では、次の最小特権ロールがサポートされています。
- 管理単位: ディレクトリ リーダー (読み取り専用)、グローバル リーダー (読み取り専用)、特権ロール管理者
- アプリケーション: ハイブリッド ID 管理者、クラウド アプリケーション管理者、アプリケーション管理者
- 外部ユーザー プロファイル: グローバル 閲覧者 (読み取り専用)、Skype for Business管理者、Teams 管理者
- グループ: グループ管理者 (ロール割り当て可能なグループを除く)、ユーザー管理者 (ロール割り当て可能なグループを除く)、特権ロール管理者 (ロール割り当て可能なグループの最小特権ロール)
- 保留中の外部ユーザー プロファイル: グローバル 閲覧者 (読み取り専用)、Skype for Business管理者、Teams 管理者
- サービス プリンシパル: ハイブリッド ID 管理者、クラウド アプリケーション管理者、アプリケーション管理者
- ユーザー: 認証管理者、特権認証管理者、ユーザー管理者。 ただし、特権管理者ロールを持つユーザーを復元するには、
- 委任されたシナリオでは、アプリに Directory.AccessAsUser.All 委任されたアクセス許可を割り当てる必要があります。また、「 機密性の高いアクションを実行できるユーザー」に示されているように、呼び出し元のユーザーに高い特権管理者ロールも割り当てる必要があります。
- アプリのみのシナリオでは、 User.ReadWrite.All アプリケーションのアクセス許可が付与されるだけでなく、「 機密性の高いアクションを実行できるユーザー」に示されているように、アプリに高い特権管理者ロールを割り当てる必要があります。
HTTP 要求
GET /directory/deleteditems/microsoft.graph.application
GET /directory/deleteditems/microsoft.graph.servicePrincipal
GET /directory/deleteditems/microsoft.graph.group
GET /directory/deletedItems/microsoft.graph.user
GET /directory/deletedItems/microsoft.graph.administrativeUnit
GET /directory/deletedItems/microsoft.graph.externalUserProfile
GET /directory/deletedItems/microsoft.graph.pendingExternalUserProfile
GET /directory/deletedItems/microsoft.graph.certificateBasedAuthPki
GET /directory/deletedItems/microsoft.graph.certificateAuthorityDetail
OData キャスト型は URI の必須部分であり、型を使用せずに GET /directory/deleteditems
を呼び出 すことはサポートされていません 。
オプションのクエリ パラメーター
このメソッドは、OData キャストによって指定されたリソースでサポートされるクエリ パラメーターをサポートします。 つまり、 $count
、 $expand
、 $filter
、 $orderby
、 $search
、 $select
、および $top
クエリ パラメーターです。 この API は、既定で 100 個のオブジェクトを返し、 $top
を使用してページあたり最大 999 個のオブジェクトを返します。
クエリの中には、ConsistencyLevel ヘッダーの設定を eventual
および $count
に使用した場合にのみサポートされるものもあります。 例:
https://graph.microsoft.com/beta/directory/deletedItems/microsoft.graph.group?&$count=true&$orderby=deletedDateTime desc&$select=id,displayName,deletedDateTime
ConsistencyLevel: eventual
この例では、$orderby
および$count
クエリ パラメーターがクエリで使用されるため、ConsistencyLevel ヘッダーが必要です。
OData クエリ パラメーターの例を$orderbyする
$orderby
OData クエリ パラメーターは、削除されたオブジェクト型の deletedDateTime、displayName、userPrincipalName プロパティでサポートされています。
deletedDateTime プロパティでは、クエリに高度なクエリ パラメーター (ConsistencyLevel ヘッダーが eventual
に設定され、クエリ文字列$count=true
) を追加する必要があります。
OData キャスト | $orderbyをサポートするプロパティ | 例 |
---|---|---|
microsoft.graph.user | deletedDateTime、displayName、userPrincipalName | /directory/deletedItems/microsoft.graph.user?$orderby=userPrincipalName |
microsoft.graph.group | deletedDateTime、displayName | /directory/deletedItems/microsoft.graph.group?$orderby=deletedDateTime asc&$count=true |
microsoft.graph.application | deletedDateTime、displayName | /directory/deletedItems/microsoft.graph.application?$orderby=displayName |
microsoft.graph.device | deletedDateTime、displayName | /directory/deletedItems/microsoft.graph.device?$orderby=deletedDateTime&$count=true |
要求ヘッダー
名前 | 説明 |
---|---|
Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
承諾 | application/json |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK
応答コードと、応答本文で directoryObject オブジェクトのコレクションを返します。
例
例 1: 削除されたグループを取得する
要求
GET https://graph.microsoft.com/beta/directory/deleteditems/microsoft.graph.group
応答
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#groups",
"value": [
{
"id":"46cc6179-19d0-473e-97ad-6ff84347bbbb",
"displayName":"SampleGroup",
"groupTypes":["Unified"],
"mail":"example@contoso.com",
"mailEnabled":true,
"mailNickname":"Example",
"securityEnabled":false,
"visibility":"Public"
}
]
}
例 2: 削除されたユーザー オブジェクトの数を取得し、deletedDateTime プロパティで結果を並べ替える
要求
GET https://graph.microsoft.com/beta/directory/deletedItems/microsoft.graph.group?$count=true&$orderby=deletedDateTime asc&$select=id,displayName,deletedDateTime
ConsistencyLevel: eventual
応答
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#groups(id,displayName,deletedDateTime)",
"@odata.count": 2,
"value": [
{
"id": "c31799b8-0683-4d70-9e91-e032c89d3035",
"displayName": "Role assignable group",
"deletedDateTime": "2021-10-26T16:56:36Z"
},
{
"id": "74e45ce0-a52a-4766-976c-7201b0f99370",
"displayName": "Role assignable group",
"deletedDateTime": "2021-10-26T16:58:37Z"
}
]
}