什么是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