Skip to content

users_backup_get

Admin

Returns all the users in the device including password hashes for backup purposes.

Params

attribute description
encryption_passphrase
string
A passphrase used to encrypt the downloaded file. If not sent, the file will not be encrypted.

Return

attribute description
base64*
string
Base64 encoded JSON file (.json) or encrypted ZIP file (*.zip) containing the configuration
extension*
'json'|'zip'
The file extension based on the type of the downloaded backup.
  • unencrypted data: JSON (*.json)
  • encrypted data: ZIP (*.zip)