命名空间:microsoft.graph
获取Microsoft Entra ID生成的审核日志列表。 这包括Microsoft Entra ID内各种服务生成的审核日志,包括用户、应用、设备和组管理、特权标识管理 (PIM) 、访问评审、使用条款、标识保护、密码管理 (自助服务和管理员密码重置) ,以及自助服务组管理等。
此 API 可用于以下国家级云部署。
全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
✅ |
✅ |
✅ |
❌ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 |
最低特权权限 |
更高特权权限 |
委派(工作或学校帐户) |
AuditLog.Read.All 和 Directory.Read.All |
不可用。 |
委派(个人 Microsoft 帐户) |
不支持。 |
不支持。 |
应用程序 |
AuditLog.Read.All 和 Directory.Read.All |
不可用。 |
HTTP 请求
GET /auditLogs/directoryaudits
可选的查询参数
此方法支持 $filter
(eq
、、ge
、 le
startswith
) 、$top
、 $orderby
和 skiptoken
OData 查询参数来帮助自定义响应。 若要了解一般信息,请参阅 OData 查询参数。
名称 |
说明 |
Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法在响应正文中返回响应 200 OK
代码和 目录Audit 对象的集合。
示例
示例 1:检索审核日志列表
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/v1.0/auditLogs/directoryAudits
// 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.AuditLogs.DirectoryAudits.GetAsync();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
//other-imports
)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
directoryAudits, err := graphClient.AuditLogs().DirectoryAudits().Get(context.Background(), nil)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
DirectoryAuditCollectionResponse result = graphClient.auditLogs().directoryAudits().get();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
const options = {
authProvider,
};
const client = Client.init(options);
let directoryAudits = await client.api('/auditLogs/directoryAudits')
.get();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
<?php
use Microsoft\Graph\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->auditLogs()->directoryAudits()->get()->wait();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph 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.audit_logs.directory_audits.get()
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
请阅读 SDK 文档,了解如何将 SDK 添加到项目并创建 authProvider 实例的详细信息。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#auditlogs/directoryaudits",
"value": [{
"id": "id",
"category": "UserManagement",
"correlationId": "da159bfb-54fa-4092-8a38-6e1fa7870e30",
"result": "success",
"resultReason": "Successfully added member to group",
"activityDisplayName": "Add member to group",
"activityDateTime": "2018-01-09T21:20:02.7215374Z",
"loggedByService": "Core Directory",
"initiatedBy": {
"user": {
"id": "728309ae-1a37-4937-9afe-e35d964db09b",
"displayName": "Audry Oliver",
"userPrincipalName": "bob@wingtiptoysonline.com",
"ipAddress": "127.0.0.1"
},
"app": null
},
"targetResources": [{
"id": "ef7e527d-6c92-4234-8c6d-cf6fdfb57f95",
"displayName": "Example.com",
"Type": "Group",
"modifiedProperties": [{
"displayName": "Action Client Name",
"oldValue": null,
"newValue": "DirectorySync"}],
"groupType": "unifiedGroups"
},
{
"id": "1f0e98f5-3161-4c6b-9b50-d488572f2bb7",
"displayName": null,
"Type": "User",
"modifiedProperties": [],
"userPrincipalName": "bob@contoso.com"
}],
"additionalDetails": [{
"key": "Additional Detail Name",
"value": "Additional Detail Value"
}]
}]
}
示例 2:检索审核日志列表,其中包含针对 initiatedBy/user 的筛选器
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/v1.0/auditLogs/directoryAudits?$filter=initiatedBy/user/id eq '00000000-0000-0000-0000-000000000000'
// 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.AuditLogs.DirectoryAudits.GetAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.Filter = "initiatedBy/user/id eq '00000000-0000-0000-0000-000000000000'";
});
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
mgc audit-logs directory-audits list --filter "initiatedBy/user/id eq '00000000-0000-0000-0000-000000000000'"
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphauditlogs "github.com/microsoftgraph/msgraph-sdk-go/auditlogs"
//other-imports
)
requestFilter := "initiatedBy/user/id eq '00000000-0000-0000-0000-000000000000'"
requestParameters := &graphauditlogs.AuditLogsDirectoryAuditsRequestBuilderGetQueryParameters{
Filter: &requestFilter,
}
configuration := &graphauditlogs.AuditLogsDirectoryAuditsRequestBuilderGetRequestConfiguration{
QueryParameters: requestParameters,
}
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
directoryAudits, err := graphClient.AuditLogs().DirectoryAudits().Get(context.Background(), configuration)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
DirectoryAuditCollectionResponse result = graphClient.auditLogs().directoryAudits().get(requestConfiguration -> {
requestConfiguration.queryParameters.filter = "initiatedBy/user/id eq '00000000-0000-0000-0000-000000000000'";
});
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
const options = {
authProvider,
};
const client = Client.init(options);
let directoryAudits = await client.api('/auditLogs/directoryAudits')
.filter('initiatedBy/user/id eq \'00000000-0000-0000-0000-000000000000\'')
.get();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\AuditLogs\DirectoryAudits\DirectoryAuditsRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new DirectoryAuditsRequestBuilderGetRequestConfiguration();
$queryParameters = DirectoryAuditsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "initiatedBy/user/id eq '00000000-0000-0000-0000-000000000000'";
$requestConfiguration->queryParameters = $queryParameters;
$result = $graphServiceClient->auditLogs()->directoryAudits()->get($requestConfiguration)->wait();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
Import-Module Microsoft.Graph.Reports
Get-MgAuditLogDirectoryAudit -Filter "initiatedBy/user/id eq '00000000-0000-0000-0000-000000000000'"
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.audit_logs.directory_audits.directory_audits_request_builder import DirectoryAuditsRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = DirectoryAuditsRequestBuilder.DirectoryAuditsRequestBuilderGetQueryParameters(
filter = "initiatedBy/user/id eq '00000000-0000-0000-0000-000000000000'",
)
request_configuration = RequestConfiguration(
query_parameters = query_params,
)
result = await graph_client.audit_logs.directory_audits.get(request_configuration = request_configuration)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#auditLogs/directoryAudits",
"@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET auditLogs/directoryAudits?$select=activityDateTime,activityDisplayName",
"value": [
{
"id": "SSGM_b662f17a-4e4d-4e1c-9248-cdec180024b2_MCDC4_88453290",
"category": "GroupManagement",
"correlationId": "b662f17a-4e4d-4e1c-9248-cdec180024b2",
"result": "success",
"resultReason": "OK",
"activityDisplayName": "GroupLifecyclePolicies_Get",
"activityDateTime": "2024-12-27T10:01:19.5796748Z",
"loggedByService": "Self-service Group Management",
"operationType": "Update",
"initiatedBy": {
"app": null,
"user": {
"id": "00000000-0000-0000-0000-000000000000",
"displayName": null,
"userPrincipalName": null,
"ipAddress": "10.0.0.0",
"userType": null,
"homeTenantId": null,
"homeTenantName": null
}
},
"targetResources": [
{
"id": "00000000-0000-0000-0000-000000000000",
"displayName": null,
"type": "N/A",
"userPrincipalName": null,
"groupType": null,
"modifiedProperties": []
}
],
"additionalDetails": []
}
]
}