Deregister TOTP
Users with a registered TOTP can deregister their configuration using the 'Deregister TOTP' activity. This guide will demonstrate how to set up a simple Process Definition that utilizes this activity to deregister TOTP from a given Identity Store User. Note that before deregistering TOTP, an existing TOTP must be present. See the TOTP Registration guide for more information on TOTP registration.
Deregistering via Process Definition
Step 1 - Create a Process Definition
- Create a new Process Definition by navigating to Process Definitions > New Process Definition in the Backoffice application.
- Add a 'Create Start Event' to the Process Designer.
- Click the 'Start' event to open the right-side contextual menu and enter a name for the 'Name' input parameter.
- Add a 'Create End Event' to the Process Designer and connect it to the 'Start' event using a sequence flow arrow.
- Click the 'End' event to open the right-side contextual menu and enter a name for the 'Name' input parameter.
Step 2 - (Optional) Get User
The Identity Store User that will be deregistered must be retrieved using the 'Get User' activity. This activity is only necessary when using the 'User Key' input parameter to identify the User.
- Add a 'Get User' activity to the Process Designer and connect it to the 'start' event using the global connect tool.
- The 'Get User' activity includes the following input parameters:
| Parameter | Description | Type | Default |
|---|---|---|---|
| Store Name | Required - Represents the Identity Store that the User belongs to. | String | |
| User External ID | The External ID of the User to be returned. | String | |
| User ID | The ID of the User to be returned. | String | |
| User Key | The User Key of the User to be returned. | String | user1 |
- Specify the ID of the User to use as part of the TOTP deregistration.
Step 3 - Deregister TOTP
The 'Deregister TOTP' activity performs TOTP deregistration given an Identity Store, User and TOTP Policy.
- Add the 'Deregister TOTP' activity to the Process Designer and connect it to the 'Get User' activity.
- The 'Deregister TOTP' activity supports the following input parameters:
| Parameter | Description | Type | Default |
|---|---|---|---|
| Store Name | The name of the Identity Store of the User. | String | |
| TOTP Policy | The TOTP policy that was used when registering the TOTP. | String | |
| User External ID | This field can be used to identify the Idenity Store User that was used to register the TOTP. | String | |
| User ID | This field can be used to identify the Idenity Store User that was used to register the TOTP. | String | |
| User Key | This field can be used to identify the Idenity Store User that was used to register the TOTP. | String | user1 |
The 'Deregister TOTP' activity includes the following error boundary events:
- No TOTP Registered - Triggered when the User has been found but no TOTP has been registered to the User.
- Failed Deregister TOTP - Triggered when TrustX fails to deregister the TOTP. This error may occur if the Identity Store or TOTP policy are not found.
Ensure that the User is the same as the User retrieved in Step 1 when using the User Key. Alternatively, use the 'User External ID' or 'User ID' fields.
Click the Save & Deploy button to finalize the Process Definition.