[预览] 获取审核日志

根据组织名称获取组织的审核日志。

API 端点

https://{yourDomain}/audit_/api/auditlogs

作用域

需要以下作用域：

• PM.Audit
• PM.Audit.Read

请求标头

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

注意：如要获取 {access_token}，请确保通过描述的其中一种方法进行身份验证。

查询参数

查询参数	数据类型	描述
language (可选)	字符串	以缩写形式指定可用的显示语言。 例如 fr、de、en、ja 等。
top (可选)	Int32	显示审核的前 N 个条目。
skip (可选)	Int32	跳过显示前 N 个审核条目。
sortBy (可选)	字符串	指定用于对审核条目进行排序的 DTO 属性。 例如 category、email、createdOn 等。
sortOrder (可选)	字符串	指定排序顺序。 例如，升序 (asc) 或降序 (desc)。
api-version (可选)	字符串	指定您正在使用的 API 版本。

响应

200 OK

返回查询的审核事件。

请求示例

假设您收集了构建 API 调用所需的所有信息。

• 您的 {baseURL} 为： https://{yourDomain}/{organizationName}/{tenantName}/

• 您的 {access_token} 为：1234（出于长度考虑）。

• 您需要设置以下查询参数：

  • language = en
  • top = 2，显示前两个条目
  • skip = 2，跳过前两个条目
  • sortBy = createdOn，按创建名称对条目进行排序
  • sortOrder = asc，根据条目从旧到新的顺序排序

调用应如下所示 (cURL)：

curl --location --request GET '
				https://{yourDomain}/{organizationName}/{tenantName}/audit_/api/auditlogs/?language=en&top=2&skip=2&sortBy=createdOn&sortOrder=asc' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

以下是成功检索审核条目的响应正文：

{
    "totalCount": 29,
    "results": [
        {
            "createdOn": "2021-10-14T13:10:15.1964174+00:00",
            "category": "User",
            "action": "Login",
            "auditLogDetails": "{\r\n \"userName\": \"System Administrator admin\",\r\n \"email\": \"\"\r\n}", 
            "userName": "System Administrator",
            "email": "",
            "message": "User 'System Administrator admin' logged in",
            "detailsVersion": "1.0",
            "source": "Cis"
        },
....
        {
            "createdOn": "2021-10-14T12:41:00.3268964+00:00",
            "category": "User",
            "action": "Login",
            "auditLogDetails": "{\r\n \"userName\": \"System Administrator admin\",\r\n \"email\": \"\"\r\n}", 
            "userName": "System Administrator",
            "email": "",
            "message": "User 'System Administrator admin' logged in",
            "detailsVersion": "1.0",
            "source": "Cis"
        }
    ]
}