Delete User by Alias

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

The account alias must be an email address or other well-defined account alias and does not support arbitrary values from user records.

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.

Path Params
string
required

The SafeZone id

Query Params
string
required

The registered account alias (e.g. email address)

boolean
Defaults to false

Whether the completely purge all records associated with this user

boolean
Defaults to false

Whether to allow purging user records that have not been marked as deleted

Response

Language
Credentials
Basic
base64
:
LoadingLoading…