Skip to content
Client SDK
Mobile approve
SSO
Sub-journey

Suspends a device, blocks its cryptographic keys, and locks associated device-bound authenticators

Description

This step suspends a device associated with a user, changing its status to Suspended. When a device is suspended, it is also rejected by the Known Device Status step, which routes it to the No branch.

Suspending a device also affects its linked credentials:

  • Device cryptographic keys associated with the device are blocked.
  • Device-bound authenticators (mobile biometrics and PIN) linked to this device via registering_device are locked. This means authentication attempts using those authenticators will fail, regardless of whether device context is provided.

Suspended devices can be restored to Active using the Reactivate Device step.

Note

If the device is already suspended, the step returns an error.

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.
Device sourceSpecifies a device. Defines whether to obtain the device ID from the journey context or specify it explicitly for this step. For more, see Device context.
Error output variableName of the variable that stores any errors returned by the action
Failure behaviorDetermines the behavior in case of failure, which either aborts the journey (default) or proceeds to a failure branch of the control flow.
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.