Meta tags:
description=Ingest and export Audit Log Events from your application.;

Headings (most frequently used words):

audit, emit, an, log, event, the, workos, in, dashboard, events, logs, on, this, page, introduction, what, you, ll, build, before, getting, started, api, object, definitions, install, sdk, set, secrets, sign, to, your, account, and, configure, schemas, get, organization, id, view, ingested, idempotency,

Text of the page (most frequently used words):
#workos (78), events (32), the (29), event (29), new (28), 123 (24), audit (21), user (21), log (19), type (18), action (17), and (15), you (14), auditlogevent (13), context (11), targets (11), actor (11), metadata (11), your (10), team (10), signed_in (10), api (9), chrome (9), 104 (9), resource (9), emit (9), organization (8), from (8), org_01ehwnce74x7jsdv0x3sz3kjny (8), location (8), auditlogeventtarget (8), import (8), inc (7), admin (7), are (7), data (7), key (7), logs (7), team_01gbnjd4mkhvkjgewk42jnmbgs (7), user_01gbnjc3mx9zzjw1fstf4c5938 (7), sk_example_123456789 (7), with (6), sdk (6), dashboard (6), idempotency (6), options (6), createevent (6), occurredat (6), auditlogs (6), idempotencykey (6), user_123 (6), version (6), use (6), node (6), sdks (6), install (6), portal (5), this (5), provide (5), useragent (5), auditlogeventcontext (5), auditlogeventactor (5), datetime (5), com (5), schemas (5), start (5), for (5), reference (5), sign (4), that (4), when (4), will (4), organizationid (4), createauditlogeventoptions (4), java (4), extra (4), jon (4), smith (4), name (4), php (4), client (4), organization_id (4), javascript (4), configure (4), yarn (4), npm (4), application (4), taken (4), getting (4), started (4), what (4), migrate (4), integrations (4), streams (4), editing (4), schema (4), exporting (4), quick (4), can (3), view (3), based (3), one (3), using (3), don (3), auditlogsservice (3), var (3), now (3), build (3), date (3), requestoptions (3), laravel (3), time (3), audit_logs (3), user_agent (3), occurred_at (3), ruby (3), need (3), get (3), before (3), create (3), account (3), secrets (3), collection (3), export (3), security (2), resources (2), them (2), ingested (2), duplicate (2), automatically (2), content (2), requests (2), same (2), request (2), 884793cd (2), bef4 (2), 46cf (2), 8790 (2), ed49257a09c6 (2), role (2), datetimeimmutable (2), err (2), main (2), create_event (2), workos_client (2), client_123456789 (2), api_key (2), workosclient (2), 2022 (2), python (2), net (2), click (2), workos_client_id (2), workos_api_key (2), environment (2), variables (2), these (2), app (2), set (2), dependency (2), artifactid (2), groupid (2), gem (2), add (2), below (2), see (2), language (2), where (2), object (2), definitions (2), guide (2), they (2), actions (2), details (2), introduction (2), page (2), going (2), live (2), search (2), docs (2), privacy, legal, careers, customers, about, company, support, pricing, podcast, blog, status, changelog, documentation, developers, fine, grained, authorization, directory, sync, single, authkit, features, once, have, successfully, emitted, under, associated, provides, basic, protection, alone, generates, prevents, being, created, due, network, retries, other, issues, subsequent, return, response, creates, hashed, combining, provided, supports, ensure, not, duplicated, retrying, header, creation, generate, list, setapikey, target, builder, util, auditlogsapi, facades, handle, error, nil, string, rfc3339, format, auditlogscreateeventparams, background, newclient, func, github, package, isoformat, utc, client_id, types, 08t19, 435z, require, await, const, previously, configured, all, scoped, order, any, must, allowed, enter, save, make, calls, some, cases, store, values, managed, such, pass, either, directly, configuration, preferences, implementation, dependencies, command, contact, offers, native, several, popular, programming, languages, choose, instructions, describes, customer, originate, exported, csv, file, individual, represents, within, most, out, versions, custom, show, how, similar, analytic, but, fundamentally, different, their, intent, aren, typically, used, active, monitoring, alerting, rather, exist, paper, trail, potentially, sensitive, members, compliance, reasons, 29t19, 336z, contain, information, relevant, notable, users, every, contains, regarding, kind, was, who, performed, were, affected, additional, took, place, copy, ingest, feedback, press, homepage,

Text of the page (random words):
audit logs workos docs workos docs homepage audit logs audit logs press k to search k search api reference feedback dashboard sign in getting started quick start quick start going live exporting events exporting events metadata schema metadata schema editing events editing events admin portal admin portal log streams log streams api reference api reference events events integrations integrations migrate to workos migrate to workos sdks sdks getting started quick start quick start going live exporting events exporting events metadata schema metadata schema editing events editing events admin portal admin portal log streams log streams api reference api reference events events integrations integrations migrate to workos migrate to workos sdks sdks audit logs ingest and export audit log events from your application copy page on this page introduction what you ll build before getting started api object definitions emit an audit log event install the workos sdk set secrets sign in to your workos dashboard account and configure audit log event schemas get an organization id emit events view ingested events in the dashboard introduction audit logs are a collection of events that contain information relevant to notable actions taken by users in your application every event in the collection contains details regarding what kind of action was taken action who performed the action actor what resources were affected by the action targets and additional details of when and where the action took place action user signed_in occurred_at 2022 08 29t19 47 52 336z actor type user id user_01gbnjc3mx9zzjw1fstf4c5938 targets type team id team_01gbnjd4mkhvkjgewk42jnmbgs context location 123 123 123 123 user_agent chrome 104 0 0 0 these events are similar to application logs and analytic events but are fundamentally different in their intent they aren t typically used for active monitoring alerting rather they exist as a paper trail of potentially sensitive actions taken by members of an organization for compliance and security reasons what you ll build this guide will show you how to configure and emit audit log events export audit log events create custom metadata schemas for audit log events create new versions of audit log event schemas before getting started to get the most out of this guide you ll need a workos account api object definitions audit log event an individual event that represents an action taken by an actor within your app audit log export a collection of audit log events that are exported from workos as a csv file organization describes a customer where audit log events originate from emit an audit log event install the workos sdk workos offers native sdks in several popular programming languages choose a language below to see instructions in your application s language node js ruby python go php laravel java net don t see an sdk you need contact us to request an sdk install the sdk using the command below npm npm yarn yarn javascript java javascript ruby npm install workos inc node yarn add workos inc node npm install workos inc node yarn add workos inc node gem install workos gem workos dependency groupid com workos groupid artifactid workos artifactid version version version dependency dependencies implementation com workos workos version set secrets to make calls to workos provide the api key and in some cases the client id store these values as managed secrets such as workos_api_key and workos_client_id and pass them to the sdks either as environment variables or directly in your app s configuration based on your preferences environment variables workos_api_key sk_example_123456789 workos_client_id client_123456789 sign in to your workos dashboard account and configure audit log event schemas before you can emit any audit log events you must configure the allowed event schemas to start click create an event and enter user signed_in for action team for targets and click save event get an organization id all events are scoped to an organization so you will need the id of an organization in order to emit events emit events using the id from the organization emit an audit log event with the action and targets previously configured emit event javascript net go java javascript laravel php python ruby 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 require workos workos workos client new api_key sk_example_123456789 event action user signed_in occurred_at 2022 09 08t19 46 03 435z actor id user_01gbnjc3mx9zzjw1fstf4c5938 type user targets id team_01gbnjd4mkhvkjgewk42jnmbgs type team context location 1 1 1 1 user_agent chrome 104 0 0 0 workos audit_logs create_event organization_id org_01ehwnce74x7jsdv0x3sz3kjny event event import datetime from workos import workosclient from workos types audit_logs import auditlogevent workos_client workosclient api_key sk_example_123456789 client_id client_123456789 organization_id org_01ehwnce74x7jsdv0x3sz3kjny event auditlogevent action user signed_in occurred_at datetime datetime now tz datetime utc isoformat actor type user id user_01gbnjc3mx9zzjw1fstf4c5938 targets type team id team_01gbnjd4mkhvkjgewk42jnmbgs context location 123 123 123 123 user_agent chrome 104 0 0 0 workos_client audit_logs create_event organization_id organization_id event event package main import context workos github com workos workos go v9 time func main client workos newclient sk_example_123456789 _ err client auditlogs createevent context background workos auditlogscreateeventparams organizationid org_01ehwnce74x7jsdv0x3sz3kjny event workos auditlogevent action user signed_in occurredat time now format time rfc3339 actor workos auditlogeventactor id user_01gbnjc3mx9zzjw1fstf4c5938 type user targets workos auditlogeventtarget id team_01gbnjd4mkhvkjgewk42jnmbgs type team context workos auditlogeventcontext location 123 123 123 123 useragent workos string chrome 104 0 0 0 if err nil handle the error php workos new workos workos auditlogevent new workos resource auditlogevent action user signed_in occurredat new datetimeimmutable version 1 actor new workos resource auditlogeventactor id user_123 type user name jon smith metadata role admin targets new workos resource auditlogeventtarget id user_123 type user name jon smith new workos resource auditlogeventtarget id user_123 type team metadata extra data context new workos resource auditlogeventcontext location 1 1 1 1 useragent chrome 104 0 0 0 metadata extra data idempotencykey 884793cd bef4 46cf 8790 ed49257a09c6 workos auditlogs createevent organizationid org_01ehwnce74x7jsdv0x3sz3kjny event auditlogevent options new workos requestoptions idempotencykey idempotencykey php use workos laravel facades workos use workos resource auditlogevent use workos resource auditlogeventactor use workos resource auditlogeventcontext use workos resource auditlogeventtarget use workos requestoptions auditlogevent new auditlogevent action user signed_in occurredat new datetimeimmutable version 1 actor new auditlogeventactor id user_123 type user name jon smith metadata role admin targets new auditlogeventtarget id user_123 type user name jon smith new auditlogeventtarget id user_123 type team metadata extra data context new auditlogeventcontext location 1 1 1 1 useragent chrome 104 0 0 0 metadata extra data idempotencykey 884793cd bef4 46cf 8790 ed49257a09c6 workos auditlogs createevent organizationid org_01ehwnce74x7jsdv0x3sz3kjny event auditlogevent options new requestoptions idempotencykey idempotencykey import com workos workos import com workos auditlogs auditlogsapi createauditlogeventoptions import java util date workos workos new workos sk_example_123456789 createauditlogeventoptions options createauditlogeventoptions builder action user signed_in occurredat new date actor user_01gbnjc3mx9zzjw1fstf4c5938 user target team_01gbnjd4mkhvkjgewk42jnmbgs team context 123 123 123 123 chrome 104 0 0 0 build workos auditlogs createevent org_01ehwnce74x7jsdv0x3sz3kjny options workos setapikey sk_example_123456789 var auditlogsservice new auditlogsservice var auditlogevent new auditlogevent action user signed_in occurredat datetime now actor new auditlogeventactor id user_01gbnjc3mx9zzjw1fstf4c5938 type user targets new list auditlogeventtarget new auditlogeventtarget id team_01gbnjd4mkhvkjgewk42jnmbgs type team context new auditlogeventcontext location 123 123 123 123 useragent chrome 104 0 0 0 var options new createauditlogeventoptions organizationid org_01ehwnce74x7jsdv0x3sz3kjny event auditlogevent auditlogsservice createevent options idempotency workos audit logs supports idempotency to ensure events are not duplicated when retrying requests you can provide an idempotency key header with your event creation request if you don t provide one workos will automatically generate one based on the event content when you provide an idempotency key workos creates a hashed key combining your provided key with the event data subsequent requests with the same idempotency key and event data will return the same response this prevents duplicate events from being created due to network retries or other issues when you don t provide an idempotency key workos automatically generates one using the event content this provides basic duplicate protection based on event data alone view ingested events in the dashboard once you have successfully emitted events with the workos sdk you can view them in the dashboard under the organization that the events are associated with workos inc features authkit single sign on directory sync admin portal fine grained authorization developers documentation changelog api status resources blog podcast pricing security support company about customers careers legal privacy workos inc