Create an Audit Log Export. Exports are scoped to a single organization within a specified date range.
curl --request POST \ --url "https://api.workos.com/audit_logs/exports" \ --header "Authorization: Bearer sk_example_123456789" \ --header "Content-Type: application/json" \ -d @- <<'BODY' { "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT", "range_start": "2022-07-02T18:09:06.996Z", "range_end": "2022-09-02T18:09:06.996Z", "actions": [ "user.signed_in" ], "actor_names": [ "Jon Smith" ], "targets": [ "team" ] } BODY
{ "object": "audit_log_export", "id": "audit_log_export_01GBZK5MP7TD1YCFQHFR22180V", "state": "pending", "created_at": "2022-09-02T17:14:57.094Z", "updated_at": "2022-09-02T17:14:57.094Z" }
| curl --request POST \ | |
| --url "https://api.workos.com/audit_logs/exports" \ | |
| --header "Authorization: Bearer sk_example_123456789" \ | |
| --header "Content-Type: application/json" \ | |
| -d @- <<'BODY' | |
| { | |
| "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT", | |
| "range_start": "2022-07-02T18:09:06.996Z", | |
| "range_end": "2022-09-02T18:09:06.996Z", | |
| "actions": [ | |
| "user.signed_in" | |
| ], | |
| "actor_names": [ | |
| "Jon Smith" | |
| ], | |
| "targets": [ | |
| "team" | |
| ] | |
| } | |
| BODY |
| import { WorkOS } from '@workos-inc/node'; | |
| const workos = new WorkOS('sk_example_123456789'); | |
| const auditLogExport = await workos.auditLogs.createExport({ | |
| organizationId: 'org_01EHWNCE74X7JSDV0X3SZ3KJNY', | |
| rangeStart: new Date('2022-07-02T18:09:06.996Z'), | |
| rangeEnd: new Date('2022-09-02T18:09:06.996Z'), | |
| actions: ['user.signed_in'], | |
| actors: ['Jon Smith'], | |
| targets: ['team'], | |
| }); |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.key = "sk_example_123456789" | |
| end | |
| audit_log_export = WorkOS::AuditLogs.create_export( | |
| organization: "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| range_start: "2022-06-22T15:04:19.704Z", | |
| range_end: "2022-08-22T15:04:19.704Z", | |
| actions: ["user.signed_in"], | |
| actors: ["Jon Smith"], | |
| targets: ["team"] | |
| ) |
| from workos import WorkOSClient | |
| workos_client = WorkOSClient( | |
| api_key="sk_example_123456789", client_id="client_123456789" | |
| ) | |
| workos_client.audit_logs.create_export( | |
| organization_id="org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| range_start="2022-07-02T18:09:06.996Z", | |
| range_end="2022-09-02T18:09:06.996Z", | |
| actions=["user.signed_in"], | |
| actors=["Jon Smith"], | |
| targets=["team"], | |
| ) |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v3/pkg/auditlogs" | |
| ) | |
| func main() { | |
| auditlogs.SetAPIKey("sk_example_123456789") | |
| export, err := auditlogs.CreateExport(context.Background(), auditlogs.CreateExportOpts{ | |
| OrganizationID: "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| RangeStart: "2022-08-31T15:51:23.604Z", | |
| RangeEnd: "2022-08-31T15:51:23.604Z", | |
| Actions: []string{"user.signed_in"}, | |
| Actors: []string{"Jon Smith"}, | |
| Targets: []string{"team"}, | |
| }) | |
| } |
| <?php | |
| WorkOS\WorkOS::setApiKey("sk_example_123456789"); | |
| $auditLogs = new WorkOS\AuditLogs(); | |
| $auditLogExport = $auditLogs->createExport( | |
| organizationId: "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| rangeStart: "2022-06-31T15:51:23.604Z", | |
| rangeEnd: "2022-08-31T15:51:23.604Z", | |
| actions: ["user.signed_in"], | |
| actors: ["Jon Smith"], | |
| targets: ["team"] | |
| ); |
| import com.workos.WorkOS; | |
| import com.workos.auditlogs.AuditLogsApi.CreateAuditLogExportOptions; | |
| import com.workos.auditlogs.models.AuditLogExport; | |
| import java.util.Date; | |
| import java.util.List; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| Date rangeStart = new Date(); | |
| rangeStart.setMonth(rangeStart.getMonth() - 3); | |
| Date rangeEnd = new Date(); | |
| CreateAuditLogExportOptions options = CreateAuditLogExportOptions.builder() | |
| .organizationId("org_123") | |
| .rangeStart(rangeStart) | |
| .rangeEnd(rangeEnd) | |
| .actions(List.of("user.signed_in")) | |
| .actors(List.of("Jon Smith")) | |
| .targets(List.of("team")) | |
| .build(); | |
| AuditLogExport auditLogExport = workos.auditLogs.createExport(options); |
| WorkOS.SetApiKey("sk_example_123456789"); | |
| var auditLogsService = new AuditLogsService(); | |
| var options = new CreateAuditLogExportOptions() { | |
| OrganizationId = "org_123", | |
| RangeStart = DateTime.Now.AddMonths(-3), | |
| RangeEnd = DateTime.Now, | |
| Actions = new List<string>() { "user.signed_in" }, | |
| Actors = new List<string>() { "Jon Smith" }, | |
| Targets = new List<string>() { "team" }, | |
| }; | |
| var auditLogExport = await auditLogsService.CreateExport(options); |
| { | |
| "object": "audit_log_export", | |
| "id": "audit_log_export_01GBZK5MP7TD1YCFQHFR22180V", | |
| "state": "pending", | |
| "created_at": "2022-09-02T17:14:57.094Z", | |
| "updated_at": "2022-09-02T17:14:57.094Z" | |
| } |
POST/audit_logsReturns Get an Audit Log Export. The URL will expire after 10 minutes. If the export is needed again at a later time, refetching the export will regenerate the URL.
curl "https://api.workos.com/audit_logs/exports/audit_log_export_01GBZK5MP7TD1YCFQHFR22180V" \ --header "Authorization: Bearer sk_example_123456789"
{ "object": "audit_log_export", "id": "audit_log_export_01GBZK5MP7TD1YCFQHFR22180V", "state": "ready", "url": "https://exports.audit-logs.com/audit-log-exports/export.csv", "created_at": "2022-09-02T17:14:57.094Z", "updated_at": "2022-09-02T17:14:57.094Z" }
| curl "https://api.workos.com/audit_logs/exports/audit_log_export_01GBZK5MP7TD1YCFQHFR22180V" \ | |
| --header "Authorization: Bearer sk_example_123456789" |
| import { WorkOS } from '@workos-inc/node'; | |
| const workos = new WorkOS('sk_example_123456789'); | |
| const auditLogExport = await workos.auditLogs.getExport( | |
| 'audit_log_export_01GBZK5MP7TD1YCFQHFR22180V', | |
| ); |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.key = "sk_example_123456789" | |
| end | |
| audit_log_export = WorkOS::AuditLogs.get_export( | |
| id: "audit_log_export_01GBT9P815WPET6H8K0XHBACGS" | |
| ) |
| from workos import WorkOSClient | |
| workos_client = WorkOSClient( | |
| api_key="sk_example_123456789", client_id="client_123456789" | |
| ) | |
| audit_log_export = workos_client.audit_logs.get_export( | |
| audit_log_export_id="audit_log_export_01GBZK5MP7TD1YCFQHFR22180V" | |
| ) |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v3/pkg/auditlogs" | |
| ) | |
| func main() { | |
| auditlogs.SetAPIKey("sk_example_123456789") | |
| export, err := auditlogs.GetExport(context.Background(), auditlogs.GetExportOpts{ | |
| ExportID: "audit_log_export_01GBZK5MP7TD1YCFQHFR22180V", | |
| }) | |
| } |
| <?php | |
| WorkOS\WorkOS::setApiKey("sk_example_123456789"); | |
| $auditLogs = new WorkOS\AuditLogs(); | |
| $auditLogExport = $auditLogs->getExport( | |
| "audit_log_export_01GBT9P815WPET6H8K0XHBACGS" | |
| ); |
| import com.workos.WorkOS; | |
| import com.workos.auditlogs.models.AuditLogExport; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| String exportId = "audit_log_export_01GBZK5MP7TD1YCFQHFR22180V"; | |
| AuditLogExport auditLogExport = workos.auditLogs.getExport(exportId); |
| WorkOS.SetApiKey("sk_example_123456789"); | |
| var auditLogsService = new AuditLogsService(); | |
| var auditLogExportId = "audit_log_export_01GBZK5MP7TD1YCFQHFR22180V"; | |
| var auditLogExport = await auditLogsService.GetExport(auditLogExportId); |
| { | |
| "object": "audit_log_export", | |
| "id": "audit_log_export_01GBZK5MP7TD1YCFQHFR22180V", | |
| "state": "ready", | |
| "url": "https://exports.audit-logs.com/audit-log-exports/export.csv", | |
| "created_at": "2022-09-02T17:14:57.094Z", | |
| "updated_at": "2022-09-02T17:14:57.094Z" | |
| } |
GET/audit_logsParameters Returns