hardis:org:user:freeze
Description
Mass freeze users in org before a maintenance or go live
See user guide in the following article
https://medium.com/@dimitrimonge/freeze-unfreeze-users-during-salesforce-deployment-8a1488bf8dd3
Parameters
| Name | Type | Description | Default | Required | Options |
|---|---|---|---|---|---|
| debug -d |
boolean | Activate debug mode (more logs) | |||
| excludeprofiles -e |
option | List of profiles that you want to NOT freeze, separated by commas | |||
| flags-dir | option | undefined | |||
| includeprofiles -p |
option | List of profiles that you want to freeze, separated by commas | |||
| json | boolean | Format output as json. | |||
| maxuserdisplay -m |
option | Maximum users to display in logs | 100 | ||
| name -n |
option | Filter according to Name criteria | |||
| skipauth | boolean | Skip authentication check when a default username is required | |||
| target-org -o |
option | undefined | |||
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration |
Examples
$ sf hardis:org:user:freeze
$ sf hardis:org:user:freeze --target-org myuser@myorg.com
$ sf hardis:org:user:freeze --includeprofiles 'Standard'
$ sf hardis:org:user:freeze --excludeprofiles 'System Administrator,Some Other Profile'