什么是WorkOS的审计日志服务?

什么是WorkOS的审计日志服务接口？

WorkOS的审计日志服务有哪些核心功能？

1. 定义事件 强大的开发人员友好界面允许您快速添加要跟踪的事件，为操作命名，为每个事件分配目标类型，并为您希望附加到每个事件的任何自定义元数据定义架构。 ‍ 使用 JSON 架构编辑器，您可以强制执行强类型元数据，以确保您的应用程序将一致的结构化且有效的事件数据发送到审核日志中。
2. 发送事件 使用我们的 SDK 之一（提供 Node.js、Ruby、Python、PHP、Go、.NET 等版本）快速开始将事件数据从您的应用程序发送到 WorkOS 审核日志 API。 将您自己的自定义元数据（键：值对）存储在事件对象、参与者或与事件关联的任何目标上。

 

3. 查看并导出日志 借助快速而强大的过滤引擎，我们使搜索、查看和导出审核日志数据变得轻而易举，让您可以专注于构建应用程序的更关键功能。
4. 创建事件并附加自定义元数据 将事件附加到不同的参与者类型 在用户、匿名和系统参与者类型之间进行选择以适合您的用例。 为每个事件分配目标 指定应用程序中与特定事件关联的对象类型。 使用 JSON 模式验证进行类型检查 确保您的应用程序发送的任何事件数据的结构和类型正确。 添加自定义元数据自定义元数据 可以添加到顶级事件、参与者或任何关联的目标。

WorkOS的审计日志服务的核心优势是什么？

在哪些场景会用到WorkOS的审计日志服务？

1.安装 WorkOS SDK
WorkOS 提供多种流行编程语言的本机 SDK。选择下面的语言以查看使用您的应用程序语言的说明。

2.设定密钥
要调用 WorkOS，请提供 API 密钥，在某些情况下还需要提供客户端 ID。将这些值存储为托管机密，例如WORKOS_API_KEY和WORKOS_CLIENT_ID ，并将它们作为环境变量或根据您的首选项直接传递到应用程序的配置中。

环境变量
WORKOS_API_KEY='sk_example_123456789'
WORKOS_CLIENT_ID='client_123456789'

3.登录您的 WorkOS Dashboard 帐户并配置审核日志事件架构
在发出任何审核日志事件之前，您必须配置允许的事件模式。首先，单击“创建事件”并输入user.signed_in作为操作，输入team作为目标，然后单击“保存事件”。

4.获取组织 ID
所有事件的范围仅限于组织，因此您需要组织的 ID 才能发出事件。

5.发出事件
使用组织的 ID，发出包含先前配置的action和targets审核日志事件。

import { WorkOS } from '@workos-inc/node';

const workos = new WorkOS('sk_example_123456789');

await workos.auditLogs.createEvent('org_01EHWNCE74X7JSDV0X3SZ3KJNY', {
  action: 'user.signed_in',
  occurredAt: new Date(),
  actor: {
    type: 'user',
    id: 'user_01GBNJC3MX9ZZJW1FSTF4C5938',
  },
  targets: [
    {
      type: 'team',
      id: 'team_01GBNJD4MKHVKJGEWK42JNMBGS',
    },
  ],
  context: {
    location: '123.123.123.123',
    userAgent: 'Chrome/104.0.0.0',
  },
});

在仪表板中查看摄取的事件
使用 WorkOS SDK 成功发出事件后，您可以在仪表板中与事件关联的组织下查看它们。

详情查看链接：https://workos.com/docs/audit-logs/emit-an-audit-log-event/view-ingested-events-in-the-dashboard