Unlock User

Audience: Low-code Engineers

Skill Prerequisites: Actions, Tokens, Conditions

Unlocks a user account that was locked out, for example after too many failed login attempts. The result can be saved in a token.

Typical Use Cases

• A Listing button that lets an administrator unlock a selected user
• An admin form where support staff unlock an account by email address
• A workflow that unlocks an account after a successful identity check

Don't use it to

• Reset a forgotten password. Use Send User Reset Password Email instead.
• Let users unlock their own account from a public form. The action doesn't check who is running it.

Related Actions

Action Name	Description
User/Password Validation	Checks a username and password. Failed attempts can lock the account.
User Login	Logs the user in.
Send User Reset Password Email	Sends a password reset link.

Input Parameter Reference

Parameter	Description	Supports Tokens	Default	Required
User Identifier	The user to unlock. It can be a user ID, an email address or a username, for example [UserId] or [Email]. A whole number is treated as a user ID. Otherwise the action looks for a user with that email, then for a user with that username.	Yes	empty string	Yes
Result Token Name	The name of the token that receives the result, without brackets, for example IsUnlocked.	No	empty string	No

Output Parameters Reference

Token	Description
[<Result Token Name>]	true if the account was locked and is now unlocked. false if the account wasn't locked, or couldn't be unlocked. The values are lowercase.

Considerations

• It doesn't check permissions. Anyone who can run the action can unlock any account. Put it only in modules, workflows or APIs that administrators can use, or add a condition that checks the current user's role.
• An unknown user is an error. If no user matches User Identifier, the action fails with Could not find an user with the provided identifier: '<identifier>'. End users see this message too.
• false doesn't always mean failure. A user who wasn't locked also returns false. Nothing else changes in that case.
• Compare lowercase values. Use [IsUnlocked] == "true" in conditions.

Examples

tip

To understand how to use the below examples, please see Running Examples.

1. Unlock the user selected in a listing

This action unlocks the user in the UserId token and saves the result in IsUnlocked. It runs only for users in the Administrators role. Follow it with a message that uses [IsUnlocked].

{
    "Title": "Unlock User",
    "ActionType": "UserManagement.UnlockUser",
    "Description": "Unlock the selected user",
    "Condition": "[HasRole:Administrators] == \"true\"",
    "Parameters": {
        "UserIdentifier": "[UserId]",
        "ResultTokenName": "IsUnlocked"
    }
}

Revised 09/28/2026