Skip to content

Unlock authenticator by type

Client SDK
Backend API
Mobile approve
SSO
Sub-journey

Unlocks all authenticators of a given type for a user

Description

This step unlocks all authenticators of a specified type for a user, allowing them to authenticate again. Unlike the Unlock authenticator step which targets a single authenticator by ID, this step unlocks all authenticators of the chosen type at once. It can be used to reset the lockout state for authenticators that were locked either manually or by a lockout policy.

If the step completes successfully, the lockout state is cleared for all authenticators of the specified type and the journey continues to the next step. If it fails, the journey proceeds to a failure branch (if one is specified); otherwise, the journey is aborted and an error is sent to the client.

For more about which authenticator types support unlocking, see Manage user authenticators.

Configuration

FieldDescription
User auth stateIndicates if the user has authenticated in this journey. If the user is authenticated (default), the user context is provided implicitly by the journey. If not, a user identifier must be configured.
IdentifiersOnly configured if the journey doesn't authenticate the user before invoking this step. Can be an external user ID, email, phone number, username, or a custom identifier, if configured for B2C users in your tenant.
Authenticator typeThe type of authenticator to unlock (e.g., password, passkey, PIN, mobile biometrics, or face).
Error output variableName of the variable that stores any errors returned by the step.
Failure behaviorDetermines the behavior in case of failure, which either aborts the journey or proceeds to a failure branch of the control flow (default).
Journey event data

This step can be configured to record step input and output data, or a custom payload, which is then surfaced in journey events in Journey Analytics for diagnostic purposes. For details, see Additional data reporting.