User Activities

Overview

The User Activities API allows you to track and monitor user actions within your cidaas system. It provides detailed information about when and how users interact with your application, including device information, location data, and activity types.

Benefits

User Activities help you:

• Security Auditing: Track user actions for security compliance and investigation
• User Behavior Analysis: Understand how users interact with your system
• Troubleshooting: Review historical user actions to diagnose issues
• Compliance: Maintain audit logs for regulatory requirements

What is Tracked

The User Activities API tracks various user actions including:

• Account creation and modifications
• Login and logout events
• Password changes and resets
• Profile updates
• Device registrations
• And many more user-related events

Note: Only activities of active customers are tracked.

Activity Information

Each activity record includes:

Field	Description
eventType	Type of activity (e.g., ACCOUNT_CREATED_WITH_CIDAAS_IDENTITY, LOGIN_WITH_CIDAAS)
timeStamp	When the activity occurred (ISO 8601 format)
sub	User identifier
objectType	Type of object affected (e.g., users, apps)
objectId	ID of the affected object
deviceInfo	Device details (OS, browser, device type, model)
location	Geographic location (IP, country, city, coordinates)
summary	Human-readable summary of the activity
clientId	Client application that triggered the activity

Access Permissions

Admin Users

• Must be part of CIDAAS_ADMINS group
• Must have ADMIN or SECONDARY_ADMIN role
• Can access all user activities (including self)

Regular Users

• Can only access their own activities
• sub in the request must match the token's sub

Group Admins

• Can access activities of users in common groups
• sub and token sub must be members of at least one common group

API Reference

Use the User Activities API to retrieve user activity data with filtering and pagination.

Example Request

{
  "eventType": ["ACCOUNT_CREATED_WITH_CIDAAS_IDENTITY", "LOGIN_WITH_CIDAAS"],
  "sub": "89c77e6e-4c49-4dad-b3d9-21a19fcad783",
  "from": 0,
  "size": 10,
  "dateFilter": {
    "from_date": "2023-03-02T11:33:55.515Z",
    "to_date": "2023-04-02T11:33:55.515Z"
  },
  "descending": true
}

Filtering Options

You can filter activities by:

• Event Type: Specific activity types (e.g., ACCOUNT_MODIFIED, LOGIN_WITH_CIDAAS)
• User: Filter by user sub or identifier (email, username)
• Date Range: Filter by from_date and to_date
• Object Type: Filter by object type (e.g., users, apps)
• Object ID: Filter by specific object ID
• Client ID: Filter by specific client application

Use Cases

Security Monitoring

Track suspicious login attempts, account modifications, or unusual user behavior patterns.

User Support

Review user activity history to help troubleshoot issues or answer support questions.

Compliance Reporting

Generate audit reports showing user actions for compliance requirements.

Analytics

Analyze user behavior patterns to improve your application's user experience.

---

Need Support?

Please contact us directly on our support page.