Apifox 帮助文档
帮助文档
常见问题Apifox 官网私有化部署
开发者中心
开发者中心
  • 开放 API
  • Apifox Markdown
  • 更新日志
  • Road Map
下载
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
帮助文档
常见问题Apifox 官网私有化部署
开发者中心
开发者中心
  • 开放 API
  • Apifox Markdown
  • 更新日志
  • Road Map
下载
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
  1. 管理组织
  • 帮助中心
  • 更新日志
  • 入门
    • 产品介绍
    • 私有化部署
    • 联系我们
  • 开始使用
    • 下载 Apifox
    • 基本概念
    • 注册与登录
    • 页面布局
    • 快速上手
      • 概述
      • 新建接口
      • 发送接口请求
      • 快捷请求
      • 添加断言
      • 新建测试场景
      • 分享 API 文档
      • 了解更多
    • 导入导出数据
      • 导出数据
      • 概述
      • 定时导入(绑定数据源)
      • 导入设置
      • 手动导入
      • 其它方式导入
        • 导入 cURL
        • 导入 Markdown
        • 导入 Insomnia
        • 导入 apiDoc
        • 导入 .har 文件
        • 导入 Apipost
        • 导入 Eolink
        • 导入 knife4j
        • 导入 NEI
        • 导入小幺鸡(docway)
        • 导入 Apizza
        • 导入 WSDL
        • 导入 Postman
        • 导入 OpenAPI/Swagger
  • 设计 API
    • 概述
    • 新建 API 项目
    • 接口基础知识
    • 接口设计规范
    • 模块
    • 请求体多示例配置
    • 响应组件
    • 常用字段
    • 全局参数
    • 历史记录
    • 接口评论
    • 批量管理
    • 通用接口文档
    • 以 OpenAPI 文件维护接口
    • 基础知识
      • 接口基本信息
        • 请求头
        • HTTP/2
        • 请求参数编码解码
        • 请求参数与请求体
        • 请求 URL 与方法
      • 认证与授权
        • 概述
        • 支持的授权类型
        • Digest Auth
        • OAuth 1.0
        • OAuth 2.0
        • Hawk Authentication
        • Kerberos
        • NTLM
        • Akamai EdgeGrid
        • CA 和客户端证书
      • 响应与 Cookie
        • 概述
        • API 响应
        • 创建和发送 Cookie
        • 实际请求
        • 提取响应示例
      • 请求代理
        • 网页端中的请求代理
        • 分享文档中的请求代理
        • 客户端中的请求代理
      • API Hub
        • API Hub
    • 数据模型
      • 概述
      • 高级数据类型
      • 构建数据模型
      • 通过 JSON 等生成
      • 新建数据模型
      • 数据模型进阶
        • 使用 oneOf / anyOf / allOf 构建组合模式
        • 使用 discriminator 实现多态数据结构
    • 鉴权组件
      • 概述
      • 创建鉴权组件
      • 使用鉴权组件
      • 在线文档中的鉴权组件
    • 高级功能
      • 参数列表外观
      • 接口唯一标识
      • 关联测试场景
      • 接口状态
      • 接口字段
  • 开发和调试 API
    • 概述
    • 生成请求
    • 发送请求
    • 请求历史
    • 接口调试用例
    • 单接口用例
    • 动态值
    • 校验响应
    • 文档模式/调试模式
    • 生成代码
    • 环境和变量
      • 概述
      • 环境管理
      • 全局/环境/模块/临时变量
      • Vault Secrets(密钥库)
        • 功能简介
    • 前后置操作&脚本
      • 概述
      • 断言
      • 提取变量
      • 等待时间
      • 安全性
      • 数据库操作
        • 概述
        • MySQL
        • MongoDB
        • Redis
        • Oracle
      • 使用脚本
        • 概述
        • 前置脚本
        • 后置脚本
        • 公共脚本
        • pm 脚本 API
        • 使用 JS 类库
        • 响应数据可视化
        • 调用外部程序
      • 脚本示例
        • 断言示例
        • 脚本使用变量
        • 脚本读取/修改接口请求信息
      • 常见问题
        • 如何获取动态参数的真实值并加密?
        • 脚本运行后,提取的数字(bigint)精度丢失应该如何处理?
    • API 调试
      • SSE 调试
      • MCP 调试
      • GraphQL 调试
      • WebSocket 调试
      • Socket.IO 调试
      • SOAP/WebService
      • gRPC 调试
      • Webhook 调试
      • AI Agent Debugger
      • A2A Debugger
      • 使用请求代理调试
      • Dubbo 调试
        • 新建 Dubbo 接口
        • 调试 Dubbo 接口
        • Dubbo 接口文档
      • TCP(Socket)
        • Socket 接口功能简介
        • 报文数据处理器
  • Mock 数据
    • 概述
    • 智能 Mock
    • 自定义 Mock
    • Mock 优先级
    • Mock 脚本
    • 云端 Mock
    • 自托管 Runner Mock
  • 自动化测试
    • 概述
    • 编排场景用例
      • 新建场景用例
      • 测试步骤间传递数据
      • 测试流程控制条件
      • 从接口/用例同步数据
      • 跨项目导入接口/用例
      • 导出场景用例数据
    • 运行场景用例
      • 运行场景用例
      • 批量运行场景用例
      • 数据驱动测试
      • 共用测试数据
      • 定时任务
      • 管理其它项目接口的运行环境
    • 测试套件
      • 概述
      • 新建测试套件
      • 编排测试套件
      • 本地运行测试套件
      • 定时任务
    • 测试报告
      • 测试报告
    • API 测试
      • 性能测试
      • 集成测试
      • 端到端测试
      • 回归测试
      • 契约测试
  • Apifox CLI
    • 概述
    • 安装和运行 CLI
    • CLI 命令选项
    • CLI 运行测试套件
    • 使用 Apifox CLI 搭配 AI Agent
    • CI/CD
      • 概述
      • Git 提交自动触发测试
      • 与 Gitlab 集成
      • 与 Jenkins 集成
      • 与 Github Actions 集成
      • 与其它更多 CI/CD 平台集成
  • 发布 API 文档
    • 自定义域名
    • 概述
    • 快捷分享
    • SEO 设置
    • 页面布局设置
    • AI 相关特性
    • 发布文档站
    • 自定义页面代码
    • 查看 API 文档
    • 高级设置
      • 文档站搜索设置
      • 跨域代理
      • 文档站接入 Google Analytics
      • 文档左侧目录设置
      • 文档可见性设置
      • 在线 URL 链接规范
    • API 版本
      • 功能简介
      • 创建 API 版本
      • 发布 API 版本
      • 快捷分享 API 版本
  • 迭代分支
    • 功能简介
    • 新建迭代分支
    • 在迭代分支中改动 API
    • 在迭代分支中测试 API
    • 合并迭代分支
    • 管理迭代分支
    • AI 分支
  • 管理中心
    • 基本概念
    • 团队入驻
    • 管理项目
      • 项目基本操作
      • 项目成员管理
      • 通知设置
        • 功能简介
        • 通知对象
        • 通知事件
      • 项目资源
        • 数据库连接
        • Git 仓库连接
    • 管理团队
      • 团队基本操作
      • 团队成员管理
      • 成员角色与权限设置
      • 团队动态
      • 团队资源
        • 通用 Runner
        • 请求代理 Agent(Proxy)
        • 团队变量
      • 实时协作
        • 团队协作
    • 管理组织
      • 组织基本操作
      • 审计日志
      • 管理组织内的团队
      • 单点登录(SSO)
        • 功能简介
        • 为组织配置单点登录
        • 管理用户账号
        • 将组映射到团队
        • Microsoft Entra ID
      • SCIM 用户管理
        • 功能简介
        • Microsoft Entra ID
      • 组织资源
        • 自托管 Runner
    • 安全管理
      • 密钥扫描
    • 订单管理
      • 管理订阅
      • 组织付费经理
  • 离线空间
    • 功能简介
  • IDEA 插件
    • 快速上手
    • 生成接口文档
    • 生成数据模型
    • 配置
      • 全局配置
      • 项目内配置
      • 可配置规则
      • 脚本工具
      • Groovy 本地扩展
    • 进阶配置
      • 注释规范说明
      • 框架支持
    • 常见问题
      • 常见问题
  • 浏览器扩展
    • Chrome
    • Microsoft Edge
  • Apifox AI 功能
    • 总览
    • 启用 AI 功能
    • 生成测试用例
    • 修改数据模型
    • 接口规范性检测
    • 接口文档完整性检测
    • 字段命名
    • 常见问题
  • Apifox MCP Server
    • 新版 MCP 内测
    • 概述
    • 通过 MCP 使用 Apifox 项目内的 API 文档
    • 通过 MCP 使用公开发布的 API 文档
    • 通过 MCP 使用 OpenAPI/Swagger文档
  • 最佳实践
    • 概述
    • 接口之间如何传递数据
    • 登录态(Auth)如何处理
    • 接口签名如何处理
    • 如何加密/解密接口数据
    • Jenkins 定时触发任务
    • 如何计算 AI 问答成本
    • 与其他成员共用数据库连接配置
    • 通过 CLI 运行包含云端数据库连接配置的测试场景
    • 通过 Runner 运行包含云端数据库连接配置的测试场景
    • Apifox 测试步骤之间怎么传递数据?
  • 账号&应用设置
    • 账号设置
    • API 访问令牌
    • 通知
    • 语言设置
    • 快捷键
    • 网络代理
    • 数据备份与恢复
    • 更新 Apifox
    • 实验性功能
  • 身份验证 & Auth 鉴权指南
    • 什么是 API Key
    • 什么是 Bearer Token
    • 什么是 JWT
    • 什么是 Basic Auth
    • 什么是 Digest Auth
    • 什么是 OAuth 1.0
    • 什么是 OAuth 2.0
      • 什么是 OAuth 2.0
      • 授权码授权类型
      • 授权码授权类型,带有 PKCE
      • 隐式授权类型
      • 密码凭证授权类型
      • 客户端凭证授权类型
  • 服务与隐私协议
    • 服务协议
    • 隐私协议
    • 服务等级协议
  • 参考资料
    • API 设计优先理念
    • JSON Schema 介绍
    • JSONPath 介绍
    • XPath 介绍
    • Apifox Markdown 语法
    • CSV 格式规范
    • 正则表达式
    • 安装 Java 环境
    • Runner 运行环境
    • 常见编程语言对应的数据类型
    • Socket 粘包和分包问题
    • 词汇表
    • Apifox Swagger 扩展
      • 概述
      • x-apifox-folder
      • x-apifox-status
      • x-apifox-name
      • x-apifox-maintainer
    • Apifox JSON Schema 扩展
      • 概述
      • x-apifox-mock
      • x-apifox-orders
      • x-apifox-enum
    • 动态值表达式
  • 常见问题
  1. 管理组织

审计日志

审计日志允许企业版组织查看与安全相关的组织活动。组织所有者和组织管理员可以通过审计日志检查谁执行了某项操作、操作发生的时间、来源 IP 地址,以及受影响的组织资源。
审计日志适用于 企业版组织。审计日志数据保留 180 天。
审计日志可用于安全审查、内部审计、合规检查,以及排查组织级变更,例如成员更新、角色变更、身份验证活动、访问令牌变更、SSO 和 SCIM 活动、公开访问设置变更和数据导出等。
image.png

可用性和权限#

角色查看审计日志导出 CSV通过 API 查询
组织所有者支持支持支持
组织管理员支持支持支持
组织成员不支持不支持不支持
审计日志是组织级日志。身份验证事件只有在 Apifox 能够可靠地将该事件归因到对应组织时才会显示。

查看审计日志#

1
进入 组织设置。
2
前往 安全 部分。
3
选择 审计日志。
审计日志页面会以表格形式展示组织级事件。每条日志记录包含操作者、事件、描述、IP 地址和时间。

筛选审计日志#

在排查问题时,可以使用筛选条件缩小审计日志范围。
筛选项说明
时间范围按最近 7 天、最近 30 天、最近 90 天、最近 180 天,或 180 天保留期内的自定义时间范围筛选日志。
事件按事件类型筛选日志,例如成员角色变更、登录失败、访问令牌变更或审计日志导出等。
操作者按执行操作的用户或集成筛选日志。
image.png

导出审计日志#

你可以将审计日志导出为 CSV 文件,用于离线审查、安全评估或归档流程。CSV 导出会使用审计日志页面当前应用的筛选条件,并包含 180 天保留期内匹配的日志。
1
应用需要使用的 筛选条件。
2
点击 导出审计日志。
3
下载 生成的 CSV 文件。
导出审计日志的操作本身也会被记录到审计日志中。

通过 API 查询审计日志#

企业版组织可以通过审计日志 API 以编程方式查询审计日志。当团队希望按计划采集日志,并将其导入外部 SIEM、安全监控系统或内部审计流水线时,该能力会很有用。
审计日志 API 支持在 180 天保留期内进行时间窗口查询和游标分页。每次审计日志 API 查询都会被记录为一条查询摘要,其中包括调用方、IP 地址、查询时间窗口、limit、结果和时间戳等信息。审计日志元数据不会复制完整的返回内容。
审计日志支持通过 API 采集日志。目前暂不支持原生 SIEM 连接器、Syslog、通用 Webhook 转发和实时日志流。

敏感数据保护#

审计日志用于记录与安全相关的活动,同时避免存储敏感值。Apifox 在审计日志页面、CSV 导出和 API 响应中使用相同的脱敏策略。
审计日志不会暴露令牌值、密码、密钥值、原始 SAML 断言、重置令牌、私钥或导出内容。
事件范围敏感数据处理
访问令牌不暴露令牌值。
SCIM不暴露 SCIM 令牌值。
共享文档不暴露共享文档密码。
Vault 和密钥不暴露密钥值。
SSO不暴露原始 SAML 响应和断言。
数据导出不会将导出文件内容复制到审计日志元数据中。

支持的审计日志事件#

审计日志支持以下事件类别。
类别说明
成员和权限一个或多个用户被邀请加入组织。
成员和权限邀请了邮箱域名与组织允许的邮箱域名不匹配的外部成员加入组织、团队或项目。
成员和权限用户成为组织成员,例如通过接受邀请、SCIM 配置、SSO 即时加入、项目邀请或团队转移加入组织。
成员和权限成员的组织级角色发生变更。
成员和权限成员被移出组织,包括手动移除或通过 SCIM 取消配置。
成员和权限组织成员被添加到团队。
成员和权限成员在组织团队中的角色发生变更。
成员和权限成员被移出组织团队。
成员和权限团队成员关系通过 SAML 组映射或目录同步发生更新。
成员和权限创建了自定义组织项目角色。
成员和权限自定义组织项目角色发生变更,例如名称或权限发生变化。
成员和权限自定义组织项目角色被删除。
成员和权限组织内一个或多个团队的所有权发生移交。
组织边界已有团队被移动到组织中。
组织边界组织的成员邮箱域名限制策略被开启或关闭。
组织边界组织允许的邮箱域名列表发生变更。
组织边界组织的团队创建策略被开启或关闭。
组织边界组织信息发生变更,例如组织名称。
组织边界组织被删除。
组织边界组织所有者发生变更。
访问令牌创建了访问令牌。令牌值不会被暴露。
访问令牌访问令牌设置发生变更。令牌值不会被暴露。
访问令牌访问令牌被重新生成或轮换。旧令牌值和新令牌值都不会被暴露。
访问令牌访问令牌被删除或撤销。
身份验证和会话用户成功登录。
身份验证和会话登录尝试失败。
身份验证和会话SAML SSO 登录失败。
身份验证和会话用户退出登录。
身份验证和会话用户完成密码重置。
SSO 和 SCIM组织的 SSO 配置被创建或变更。
SSO 和 SCIM组织的 SSO 强制认证设置被开启或关闭。
SSO 和 SCIMSCIM 配置令牌被重置或重新生成。令牌值不会被暴露。
SSO 和 SCIM用户通过 SCIM 完成配置。
SSO 和 SCIM用户通过 SCIM 被取消配置。
数据导出创建了数据导出请求或导出任务。
审计日志活动审计日志被导出,例如通过 CSV 导出。
审计日志活动通过审计日志 API 查询了审计日志。
公开访问治理文档站点的可见性或访问设置发生变更。
公开访问治理文档站点域名设置发生变更,包括自定义域名变更。
公开访问治理共享文档的可见性或访问设置发生变更。
公开访问治理共享文档的密码保护发生变更。密码值不会被暴露。
Vault 和密钥Vault 服务商配置被创建、变更或删除。密钥配置值不会被暴露。
Vault 和密钥Vault 密钥条目发生变更。密钥值不会被暴露。
项目生命周期项目中的模块被删除。
项目生命周期项目中的环境被删除。
项目生命周期组织内的项目被删除。
授权对受保护资源或操作的访问被拒绝。

常见问题#

审计日志和团队动态一样吗?
不一样。审计日志关注与安全相关的组织活动和管理操作,主要用于组织级安全审查、合规检查和审计流程。团队动态用于跟踪项目和团队协作活动。
审计日志包含资源历史或回滚能力吗?
审计日志会记录完整的请求和响应正文吗?
上一页
组织基本操作
下一页
管理组织内的团队
Built with