WorkOS · Schema

AuditLogsRetentionJson

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
retention_period_in_days integernull The number of days Audit Log events will be retained before being permanently deleted. Valid values are 30 and 365.
View JSON Schema on GitHub

JSON Schema

workos-auditlogsretentionjson-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AuditLogsRetentionJson",
  "title": "AuditLogsRetentionJson",
  "type": "object",
  "properties": {
    "retention_period_in_days": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The number of days Audit Log events will be retained before being permanently deleted. Valid values are 30 and 365.",
      "example": 30
    }
  },
  "required": [
    "retention_period_in_days"
  ]
}