获取审核事件

检索组织的审核日志。API 因日志记录体验而异。

统一的日志记录体验

统一日志记录体验使用这些 API 端点，并提供两个作用域：

• 组织级别： /orgaudit_/
• 租户级别： /tenantaudit_/

这些 API 返回加载到统一框架的 UiPath 服务的审核信息。

API 端点

要在统一日志记录体验中检索审核日志，您可以使用两个不同的端点：

• 元数据：检索所有可用的审核事件类型，并按来源、类别和活动的层次结构进行结构。

  范围	API 端点
  组织级别	GET https://cloud.uipath.com/{org-name}/orgaudit_/api/query/sources
  租户级别	GET https://cloud.uipath.com/{org-name}/{tenant-name}/tenantaudit_/api/query/sources

• “查询事件” ：使用高级筛选功能检索指定范围内的审核事件。

  范围	API 端点
  组织级别	GET https://cloud.uipath.com/{org-name}/orgaudit_/api/query/events
  租户级别	GEThttps://cloud.uipath.com/{org-name}/{tenant-name}/tenantaudit_/api/query/events

作用域

需要以下作用域之一：

• PM.Audit
• PM.Audit.Read

请求标头

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

查询参数

参数	数据类型	描述
from (可选)	Datetime	时间间隔开始。
to (可选)	Datetime	时间间隔结束。
source (可选)	数组 [String]	事件源列表（由元数据API 返回）。
target (可选)	数组 [String]	事件类别列表。
type (可选)	数组 [String]	活动类型列表。
userIds (可选)	数组 [String]	用户标识符列表。
searchTerm (可选)	字符串	要搜索的关键字或术语。
status (可选)	整数	0 = 成功 1 = 失败。
maxCount (可选)	整数	要返回的最大记录数。

响应

200 OK

返回包含以下内容的 JSON 对象：

• 审核事件列表

• 显示较新活动的next分页链接
• previous分页链接，显示较早的事件

响应示例

{
  "auditEvents": [
    {
      "id": "string",
      "createdOn": "2025-03-24T18:35:38.122Z",
      "organizationId": "string",
      "organizationName": "string",
      "tenantId": "string",
      "tenantName": "string",
      "actorId": "string",
      "actorName": "string",
      "actorEmail": "string",
      "eventType": "string",
      "eventSource": "string",
      "eventTarget": "string",
      "eventDetails": "string",
      "eventSummary": "string",
      "status": 0,
      "clientInfo": {
        "ipAddress": "string",
        "ipCountry": "string"
      }
    }
  ],
  "next": "string",
  "previous": "string"
}

请求示例

• 组织级别

  curl --location 'https://cloud.uipath.com/{org-name}/orgaudit_/api/query/events?status=0&from=2024-12-24T19%3A11%3A46.403Z&to=2025-03-24T19%3A11%3A46.403Z' \
  --header 'Authorization: Bearer {token}'

• 租户级别

  curl --location 'https://cloud.uipath.com/{org-name}/{tenant-name}/tenantaudit_/api/query/events?status=0&from=2024-12-24T19%3A11%3A46.403Z&to=2025-03-24T19%3A11%3A46.403Z' \
  --header 'Authorization: Bearer {token}'

传统日志记录体验

根据组织的名称检索组织的审核日志。

API 端点

GET https://cloud.uipath.com/audit_/api/auditlogs/partitionGlobalId

作用域

需要以下作用域之一：

• PM.Audit
• PM.Audit.Read

请求标头

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

查询参数

查询参数	数据类型	描述
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://cloud.uipath.com/{organizationName}
• 您的 {access_token} 为：1234（出于长度考虑）。

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

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

调用应类似于以下示例 (cURL)：

curl --location --request GET ' https://cloud.uipath.com/{organizationName}/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"
        }
    ]
}