Change Logs

The Change Logs API provides an audit trail of configuration changes and system modifications in your cidaas instance. Each entry records what changed, when it changed, who made the change, and the previous and new values.

Reports Changelog User Activity

Change Logs API

User Activities

Event Retention

Why use Change Logs

Complete audit trail

Keep a durable record of system and configuration changes over time.

Compliance

Meet regulatory requirements for tracking who changed what and when.

Troubleshooting

Identify when a configuration change may have caused unexpected behaviour.

Rollback context

Inspect previous values so you can restore or compare configurations with confidence.

What is tracked

Change Logs cover modifications across major areas of the platform:

User managementGroup assignments, role changes, profile updates

ConfigurationApp settings, scopes, templates

System settingsField setup, webhooks, providers

Access controlPermissions, memberships, role assignments

Change log fields

Each change log entry includes:

Field	Description
eventType	Type of change event (for example GROUP_USER_ROLE_ADDED, APP_MODIFIED)
timeStamp	When the change occurred (ISO 8601)
sub	User identifier who made the change
objectType	Type of object that was changed (for example users, apps, usergroups)
objectId	ID of the object that was changed
changes	JSON array describing what changed (path, from value, to value)
oldValue	Previous value before the change
newValue	New value after the change
type	Change operation (create, update, delete)
clientId	Client application that triggered the change

Access permissions

Admin only: Callers must be members of CIDAAS_ADMINS with the ADMIN or SECONDARY_ADMIN role. They can access all change logs, including changes they initiated themselves.

How to query change logs

1

Authenticate as admin

Use a bearer token for a user in CIDAAS_ADMINS with an admin role.

2

Filter the trail

Narrow by event type, object type or ID, date range, client, or actor.

3

Inspect the delta

Use changes for field-level diffs, or oldValue / newValue for full object state.

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 (for example GROUP_CREATED, SCOPE_UPDATED)
• Object type: type of object changed (for example usergroups, apps, scopes)
• Object ID: a specific object that was changed
• Date range: from_date and to_date
• Client ID: a specific client application
• User: filter by user sub who made the change

Understanding change data

The changes field

The changes field contains a JSON array with field-level details:

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

Old value vs new value

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

Use changes when you need a precise diff. Use oldValue / newValue when you need the full before-and-after documents.

Common use cases

Configuration auditReview how the system evolved and spot unauthorized changes

Compliance reportingShow who changed what and when for auditors

Incident responseFind the change that may have caused an outage or misconfiguration

Change managementTrack modifications as part of your operational process

Related documentation

User Activities

Query historical user actions for support, security, and compliance.

Event Retention

Configure how long changelog events are kept before they are removed.

Webhook Management

Receive real-time event notifications when something happens in cidaas.

Trustdesk Reports

Where change logs and related reporting live in the Trustdesk UI.

Change Logs API

Full OpenAPI reference for querying the audit trail.

Need Support?

Please contact us directly on our support page or reach out to cidaas support at [email protected].