This method can be used to either soft-delete a user record, or to immediately and permanently delete all records associated with that user.

Soft-deleted records (purge = false), still retain any historical data (alerts, assets, checkins) associated with the user. Soft-delete records will remain in the system unless data-retention has been configured to clean them up after a period of time. Soft-deleted user records can be restored providing they have not been cleaned up by data-retention.

Hard-deleted records (purge = true) will immediately purge all records associated with the user from the system. Purged records are erased permanently and are non-recoverable. It is an error to attempt to purge a user record that has not been marked as soft-deleted, unless the force parameter is set to true.