Skip to main content

Schedule user deletion

POST 
/users-srv/user/unregister/scheduler/schedule/:sub

This API schedules user account deletion with a grace period, allowing users to cancel the deletion before it is executed.

Key Features:

  • Grace Period: Deletion is scheduled based on the instance-level setting delete_unregistered_users_after_seconds (typically 2 days by default)
  • Email Notification: User receives an email with a cancellation link when deletion is scheduled
  • Cancellation: User can cancel the scheduled deletion at any time during the grace period by clicking the link in the email
  • Webhook Events: Triggers ACCOUNT_DELETION_SCHEDULED event. If cancelled, triggers ACCOUNT_ACTIVATED. If executed, triggers ACCOUNT_DELETED

Use Cases:

  • User-initiated account deletion (self-service with profile scope)
  • Admin-scheduled deletion with grace period (requires cidaas:users_write scope)
  • GDPR compliance scenarios requiring a retention period

Permissions:

  • Self-Service: User token with profile scope (user schedules their own deletion)
  • Admin: Admin token with cidaas:users_write scope (admin schedules deletion for any user)

Request​

Responses​

OK