Skip to main content

User Lifecycle Scheduling

Automatically send verification reminders and manage user accounts based on verification status.

How It Works

Note: Schedules are part of the user account structure. Each user account (UserAccount) contains a schedules field that stores all planned or executed scheduled tasks for that user. This includes verification reminders, status changes, and deletion schedules. See Account Structure for details on the complete user account model.

cidaas supports two types of schedules:

Schedule TypeWhen CreatedApplies ToUse Case
Auto SchedulesAutomatically during registrationAll new usersStandard verification reminders, automatic deactivation/deletion
Manual SchedulesVia API callSpecific usersCustom lifecycle management for individual users

Auto Schedules

  • Created automatically when users register
  • Use global schedule setups configured in Admin Portal
  • Apply to all new users
  • No API calls needed

Manual Schedules

  • Created via API for specific users
  • Independent of global setups
  • Custom timing and actions per user
  • Requires API access with proper scopes

Configure Auto Schedules (Global Setup)

Auto schedules are configured once in the Admin Portal and automatically apply to all new users.

Setup Steps:

  1. Go to Settings > User schedules in Admin Portal
  2. Configure schedule parameters (see table below)
  3. Click Save

user-schedule-edit-setup

Schedule Configuration Options

OptionDescriptionRules
RemindersSend up to 5 verification remindersMust be sequential (1, 2, 3...). Each reminder must be scheduled later than the previous one. Delete in reverse order (5, 4, 3...).
Status ChangeAutomatically change user status (e.g., DECLINED)Time must be after all reminders are sent
DeletionAutomatically delete user accountTime must be after all reminders and status changes
Periodic TasksRecurring schedulesMinimum 24 hours (86400 seconds). Repeats until canceled

Example: Reminder 1 at 5 minutes, Reminder 2 at 60 minutes, Status change at 7 days, Deletion at 30 days.

Create Manual Schedules

Create custom schedules for specific users via API when you need different timing or actions than the global setup.

When to use:

  • User needs different reminder timing
  • Custom status change schedule for specific user
  • One-off deletion schedule
  • User-specific lifecycle management

API: POST /user-scheduling-srv/user/schedules with scheduleSpecificSchedulesOnly: true

Technical Integration

Schedule Setups (Global Configurations)

APIDescriptionLink
Get all schedule setupsRetrieve the list of all configured schedule setupsAPI Documentation
Get schedule setup by IDRetrieve a specific schedule setup configurationAPI Documentation
Create or update schedule setupCreate a new schedule setup or update an existing oneAPI Documentation
Delete schedule setupDelete a configured schedule setupAPI Documentation

User Schedule Management

APIDescriptionLink
Create user schedulesCreate scheduled tasks for a specific user (Auto-User or User Related)API Documentation
Postpone user scheduleUpdate the execution time of an existing scheduled taskAPI Documentation
Cancel user scheduleCancel and remove a scheduled taskAPI Documentation

Examples

ScenarioTypeConfiguration
Email verification reminderAutoCondition: COMMUNICATION_VERIFICATION_MEDIUM
Action: REMIND_VERIFICATION
Time: 24 hours (86400 seconds)
Reminder: 1
Auto-deactivate unverified accountsAutoCondition: COMMUNICATION_VERIFICATION_MEDIUM
Action: CHANGE_USERSTATUS
Time: 7 days (604800 seconds)
Status: DECLINED
Custom schedule for specific userManualAPI: POST /user-scheduling-srv/user/schedules
scheduleSpecificSchedulesOnly: true
Custom timing/actions

Actions & Conditions

ActionDescription
REMIND_VERIFICATIONSend verification reminder email
CHANGE_USERSTATUSChange user status (VERIFIED, UNVERIFIED, DECLINED, DELETED)
SCHEDULE_DELETIONSchedule account deletion
DELETEImmediately delete user account
ConditionWhen Action Executes
NONEAlways
COMMUNICATION_VERIFICATION_MEDIUMOnly if email/mobile is not verified

Retry Mechanism

If retryRequired: true, failed tasks automatically retry:

RetryTime After Failure
Retry 11 minute
Retry 210 minutes
Retry 31 hour

After 3 failed retries, the task is marked as failed.

Support

Need Help?

For any further assistance, feel free to visit our Support Portal.