什么是WorkOS的審計(jì)日志服務(wù)?

什么是WorkOS的審計(jì)日志服務(wù)接口？

WorkOS的審計(jì)日志服務(wù)有哪些核心功能？

1. 定義事件 強(qiáng)大的開(kāi)發(fā)人員友好界面允許您快速添加要跟蹤的事件，為操作命名，為每個(gè)事件分配目標(biāo)類(lèi)型，并為您希望附加到每個(gè)事件的任何自定義元數(shù)據(jù)定義架構(gòu)。 ‍ 使用 JSON 架構(gòu)編輯器，您可以強(qiáng)制執(zhí)行強(qiáng)類(lèi)型元數(shù)據(jù)，以確保您的應(yīng)用程序?qū)⒁恢碌慕Y(jié)構(gòu)化且有效的事件數(shù)據(jù)發(fā)送到審核日志中。
2. 發(fā)送事件 使用我們的 SDK 之一（提供 Node.js、Ruby、Python、PHP、Go、.NET 等版本）快速開(kāi)始將事件數(shù)據(jù)從您的應(yīng)用程序發(fā)送到 WorkOS 審核日志 API。 將您自己的自定義元數(shù)據(jù)（鍵：值對(duì)）存儲(chǔ)在事件對(duì)象、參與者或與事件關(guān)聯(lián)的任何目標(biāo)上。

 

3. 查看并導(dǎo)出日志 借助快速而強(qiáng)大的過(guò)濾引擎，我們使搜索、查看和導(dǎo)出審核日志數(shù)據(jù)變得輕而易舉，讓您可以專(zhuān)注于構(gòu)建應(yīng)用程序的更關(guān)鍵功能。
4. 創(chuàng)建事件并附加自定義元數(shù)據(jù) 將事件附加到不同的參與者類(lèi)型 在用戶、匿名和系統(tǒng)參與者類(lèi)型之間進(jìn)行選擇以適合您的用例。 為每個(gè)事件分配目標(biāo) 指定應(yīng)用程序中與特定事件關(guān)聯(lián)的對(duì)象類(lèi)型。 使用 JSON 模式驗(yàn)證進(jìn)行類(lèi)型檢查 確保您的應(yīng)用程序發(fā)送的任何事件數(shù)據(jù)的結(jié)構(gòu)和類(lèi)型正確。 添加自定義元數(shù)據(jù)自定義元數(shù)據(jù) 可以添加到頂級(jí)事件、參與者或任何關(guān)聯(lián)的目標(biāo)。

WorkOS的審計(jì)日志服務(wù)的核心優(yōu)勢(shì)是什么？

在哪些場(chǎng)景會(huì)用到WorkOS的審計(jì)日志服務(wù)？

1.安裝 WorkOS SDK
WorkOS 提供多種流行編程語(yǔ)言的本機(jī) SDK。選擇下面的語(yǔ)言以查看使用您的應(yīng)用程序語(yǔ)言的說(shuō)明。

2.設(shè)定密鑰
要調(diào)用 WorkOS，請(qǐng)?zhí)峁?API 密鑰，在某些情況下還需要提供客戶端 ID。將這些值存儲(chǔ)為托管機(jī)密，例如WORKOS_API_KEY和WORKOS_CLIENT_ID ，并將它們作為環(huán)境變量或根據(jù)您的首選項(xiàng)直接傳遞到應(yīng)用程序的配置中。

環(huán)境變量
WORKOS_API_KEY='sk_example_123456789'
WORKOS_CLIENT_ID='client_123456789'

3.登錄您的 WorkOS Dashboard 帳戶并配置審核日志事件架構(gòu)
在發(fā)出任何審核日志事件之前，您必須配置允許的事件模式。首先，單擊“創(chuàng)建事件”并輸入user.signed_in作為操作，輸入team作為目標(biāo)，然后單擊“保存事件”。

4.獲取組織 ID
所有事件的范圍僅限于組織，因此您需要組織的 ID 才能發(fā)出事件。

5.發(fā)出事件
使用組織的 ID，發(fā)出包含先前配置的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 成功發(fā)出事件后，您可以在儀表板中與事件關(guān)聯(lián)的組織下查看它們。

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

1.安裝 WorkOS SDK
WorkOS 提供多種流行編程語(yǔ)言的本機(jī) SDK。選擇下面的語(yǔ)言以查看使用您的應(yīng)用程序語(yǔ)言的說(shuō)明。

2.設(shè)定密鑰
要調(diào)用 WorkOS，請(qǐng)?zhí)峁?API 密鑰，在某些情況下還需要提供客戶端 ID。將這些值存儲(chǔ)為托管機(jī)密，例如WORKOS_API_KEY和WORKOS_CLIENT_ID ，并將它們作為環(huán)境變量或根據(jù)您的首選項(xiàng)直接傳遞到應(yīng)用程序的配置中。

環(huán)境變量
WORKOS_API_KEY='sk_example_123456789'
WORKOS_CLIENT_ID='client_123456789'

3.登錄您的 WorkOS Dashboard 帳戶并配置審核日志事件架構(gòu)
在發(fā)出任何審核日志事件之前，您必須配置允許的事件模式。首先，單擊“創(chuàng)建事件”并輸入user.signed_in作為操作，輸入team作為目標(biāo)，然后單擊“保存事件”。

4.獲取組織 ID
所有事件的范圍僅限于組織，因此您需要組織的 ID 才能發(fā)出事件。

5.發(fā)出事件
使用組織的 ID，發(fā)出包含先前配置的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 成功發(fā)出事件后，您可以在儀表板中與事件關(guān)聯(lián)的組織下查看它們。

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