Skip to main content

Change Logs

Overview​

The Change Logs API provides a comprehensive audit trail of all configuration changes and system modifications within your cidaas instance. It tracks what changed, when it changed, who made the change, and what the previous and new values were.

Benefits​

Change Logs help you:

  • Audit Trail: Maintain a complete record of all system changes
  • Compliance: Meet regulatory requirements for change tracking
  • Troubleshooting: Identify when and why configurations changed
  • Accountability: Track who made specific changes to your system
  • Rollback Support: Understand previous configurations to restore if needed

What is Tracked​

Change Logs track modifications to:

  • User Management: Group assignments, role changes, user profile updates
  • Configuration Changes: App settings, scope modifications, template updates
  • System Settings: Field setup changes, webhook configurations, provider settings
  • Access Control: Permission changes, group memberships, role assignments

Change Log Information​

Each change log entry includes:

FieldDescription
eventTypeType of change event (e.g., GROUP_USER_ROLE_ADDED, APP_MODIFIED)
timeStampWhen the change occurred (ISO 8601 format)
subUser identifier who made the change
objectTypeType of object that was changed (e.g., users, apps, usergroups)
objectIdID of the object that was changed
changesJSON array describing what changed (path, from value, to value)
oldValuePrevious value before the change
newValueNew value after the change
typeType of change operation (create, update, delete)
clientIdClient application that triggered the change

Access Permissions​

Admin Users​

  • Must be part of CIDAAS_ADMINS group
  • Must have ADMIN or SECONDARY_ADMIN role
  • Can access all change logs (including self-initiated changes)

API Reference​

Use the Change Logs API to retrieve change log data with filtering and pagination.

Example Request​

{
  "eventType": ["GROUP_USER_ROLE_ADDED", "APP_MODIFIED"],
  "objectType": ["usergroups", "apps"],
  "from": 0,
  "size": 20,
  "dateFilter": {
    "from_date": "2023-03-02T11:33:55.515Z",
    "to_date": "2023-04-02T11:33:55.515Z"
  },
  "descending": true
}

Filtering Options​

You can filter change logs by:

  • Event Type: Specific change events (e.g., GROUP_CREATED, SCOPE_UPDATED)
  • Object Type: Type of object changed (e.g., usergroups, apps, scopes)
  • Object ID: Specific object that was changed
  • Date Range: Filter by from_date and to_date
  • Client ID: Filter by specific client application
  • User: Filter by user sub who made the change

Understanding Change Data​

Changes Field​

The changes field contains a JSON array with detailed change information:

[
  {
    "type": "update",
    "path": ["name"],
    "from": "Old Name",
    "to": "New Name"
  }
]

Old Value vs New Value​

  • oldValue: Complete object state before the change
  • newValue: Complete object state after the change
  • changes: Specific fields that changed (more granular)

Use Cases​

Configuration Audit​

Review all configuration changes to understand system evolution and identify unauthorized modifications.

Compliance Reporting​

Generate audit reports showing who changed what and when for compliance requirements.

Troubleshooting​

Identify configuration changes that may have caused issues or unexpected behavior.

Change Management​

Track all system modifications as part of your change management process.

Need Support?​

Please contact us directly on our support page.