Disable user account

How this action disables a local user account on the device, what that changes and when the step fails.

Use this action to disable a local operating-system account on the device so nobody can sign in with it anymore. The device must be online.

Configuration fields

Field	Type	Required	Default	Description
Account name	text	Yes	—	Name of the local account you want to disable. Variables `${{ … }}` are allowed.

Platform support

Platform	Supported
Windows	Yes
Linux	Yes
macOS	Yes

Platform	What "disabled" means
Windows	The local account is disabled.
Linux	The password is locked and the login shell is set to `nologin` (or `/bin/false` if `nologin` isn't available).
macOS	The account is marked as disabled in the local directory, and its login shell is set to `/usr/bin/false`.

Outputs

Output	Description
`success`	Succeeded: `true` when the device disabled the account, `false` when it reported a failure.
`userName`	Account name: the account name after variables were resolved.

Result behaviour

Situation	Result
Account currently signed in	Succeeded. Existing sessions keep running; only new sign-ins are blocked.
Account is `root`, `daemon` or `nobody`	Failed, because the account is protected.
Account doesn't exist, or the device can't disable it	Failed. The device's error appears in the step details.
Account name empty after variables were resolved	Failed with The account name is empty.
Device doesn't answer in time	Timed out. The outcome is unknown, so check the account on the device.
Device offline when the step starts	Device offline. Depending on If device is offline, the run ends with this status or the step is skipped.

The step doesn't delete the account, its files or its group memberships. To enable the account again, use Enable user in the Local Users section of the device page.

Was this helpful?

Still need help? Ask the team