/{connector_id}/list_updated_accounts
Retrieve accounts that have been updated since a specified point in time.
This operation enables efficient account synchronization by allowing clients to fetch only accounts that have been modified since their last sync. This is particularly useful for maintaining up-to-date account information across large user bases without having to fetch all accounts on every request.
Use Cases
- Account Synchronization: Keep local account databases in sync with the remote system’s current state
- Audit Trails: Track account changes for compliance and security purposes
- Real-time Updates: Monitor account modifications for immediate action
- Data Migration: Identify accounts that need to be updated during system migrations or upgrades
Delta Query Support
This operation supports delta queries for incremental synchronization:
- Initial Request: Provide a
sinceto get all accounts updated since that time - Subsequent Requests: Use the
cursorfrom the previous response for efficient incremental updates - Cursor Management: Each response includes a new
cursorfor the next request
Account Update Detection
Different connectors may define “updates” differently based on their capabilities:
- Profile information changes (name, email, department, etc.)
- Permission or role modifications
- Account status changes (active/inactive, suspended, etc.)
- Custom attribute modifications
- Group membership changes
Rate Limiting Considerations
- Implement exponential backoff for repeated requests
- Consider batching requests for large account populations
- Monitor API rate limits specific to each connector
Path Parameters
Body
Authenticated request.
The main request payload.
Whether to include raw data in the response.
Pagination information for the request.
Connector-specific settings for the request.
These are settings that are shared across all capabilities.
Usually contain additional required configuration options not specified by the capability schema.
The authentication credentials for the request.
Response
The request has succeeded.
- Option 1
- Option 2
Response containing updated accounts information with delta synchronization support.
This response model wraps the UpdatedAccounts data and provides standard response metadata including success status and any error information.