Snapshots#

Snapshots are the foundation of Idsync's backup system. They capture the complete state of your identity provider at a specific point in time.

What's Included in a Snapshot?#

Each snapshot captures:

User Data#

• User profiles and attributes
• Custom user attributes
• Account status and metadata

Groups & Roles#

• Group definitions and memberships
• Role assignments
• Permission configurations

Configuration#

• Authentication settings
• MFA configurations
• Password policies
• App client configurations

Custom Resources#

• Lambda triggers
• Custom domains
• Resource servers

Snapshot Types#

Full Snapshots#

Complete capture of all IDP data. Recommended for:

• Initial backup
• Weekly scheduled backups
• Before major changes

Incremental Snapshots#

Only captures changes since the last snapshot. Benefits:

• Faster execution
• Lower storage costs
• Reduced API calls

Scheduling#

Configure automatic snapshots:

yaml
schedule:
  full:
    frequency: weekly
    day: sunday
    time: "02:00"
  incremental:
    frequency: daily
    time: "06:00"

Storage#

Snapshots are stored in your own cloud storage:

Retention Policies#

Configure how long snapshots are retained:

• Hot Storage: Recent snapshots (30 days)
• Warm Storage: Monthly snapshots (1 year)
• Cold Storage: Annual snapshots (7 years)

Best Practices#

1. Regular Full Backups - Schedule weekly full snapshots
2. Pre-Change Snapshots - Always snapshot before changes
3. Test Restores - Periodically verify snapshot integrity
4. Monitor Storage - Set up alerts for storage usage

Related#

• Recovery Operations
• Storage Configuration