Removing References to Deleted User Identities

This section covers how to remove references to deleted user identities in WSO2 SP by running the Forget-me tool.

Before you begin

Note that this tool is designed to run in offline mode (i.e., the server should be shut down or run on another machine) in order to prevent unnecessary load to the server. If this tool runs in online mode (i.e., when the server is running), DB lock situations on the H2 databases may occur.
If you have configured any JDBC database other than the H2 database provided by default, copy the relevant JDBC driver to the <SP_HOME>/wso2/tools/identity-anonymization-tool/lib directory.

Open a new terminal window and navigate to the <SP_HOME>/bin directory.

Execute one of the following commands depending on your operating system:

On Linux/Mac OS: ./forgetme.sh -U <username>
On Windows: forgetme.bat -U <username>

Note

The commands specified above use only the -U <username> option, which is the only required option to run the tool. There are several other optional command line options that you can specify based on your requirement. The supported options are described in detail below.

Command Line Option	Description	Required	Sample Value
U	The name of the user whose identity references you want to remove.	Yes	`-U john.doe`
d	The configuration directory to use when the tool is run. If you do not specify a value for this option, the `<SP_HOME>/wso2/tools/identity-anonymization-tool-x.x.x/conf` directory (which is the default configuration directory of the tool) is used.	No	`-d <TOOL_HOME>/conf`
T	The tenant domain of the user whose identity references you want to remove. If you specify a tenant domain via this option, use the `TID` option to specify the ID of which the references must be removed.	No	`-T acme-company` The default value is `carbon.super`
TID	The tenant ID of the user whose identity references you want to remove. It is required to specify a tenant ID if you have specified a tenant domain via the `TID` option.	No	`-TID 2346`
D	The user store domain name of the user whose identity references you want to remove.	No	`-D Finance-Domain` The default value is `PRIMARY`.
pu	The pseudonym with which the user name of the user whose identity references you want to remove should be replaced. If you do not specify a pseudonym when you run the tool, a random UUID value is generated as the pseudonym by default.	No	`-pu “123-343-435-545-dfd-4”`
carbon	The CARBON HOME. This should be replaced with the variable `$CARBON_HOME` in directories configured in the main configuration file.	No	`-carbon “/usr/bin/wso2sp/wso2sp4.1.0`