diff --git a/server_admin/keycloak-images/delete-account-confirm.png b/server_admin/keycloak-images/delete-account-confirm.png new file mode 100644 index 0000000000..0d086b5a63 Binary files /dev/null and b/server_admin/keycloak-images/delete-account-confirm.png differ diff --git a/server_admin/keycloak-images/delete-account-landing-screen.png b/server_admin/keycloak-images/delete-account-landing-screen.png new file mode 100644 index 0000000000..5a1b5aa6a2 Binary files /dev/null and b/server_admin/keycloak-images/delete-account-landing-screen.png differ diff --git a/server_admin/keycloak-images/delete-account-page.png b/server_admin/keycloak-images/delete-account-page.png new file mode 100644 index 0000000000..3c7a3f853a Binary files /dev/null and b/server_admin/keycloak-images/delete-account-page.png differ diff --git a/server_admin/keycloak-images/delete-account-role.png b/server_admin/keycloak-images/delete-account-role.png new file mode 100644 index 0000000000..76fd5b2ce0 Binary files /dev/null and b/server_admin/keycloak-images/delete-account-role.png differ diff --git a/server_admin/keycloak-images/enable-delete-account-action.png b/server_admin/keycloak-images/enable-delete-account-action.png new file mode 100644 index 0000000000..69b0e39729 Binary files /dev/null and b/server_admin/keycloak-images/enable-delete-account-action.png differ diff --git a/server_admin/topics.adoc b/server_admin/topics.adoc index 0a23ac5611..f49591a587 100644 --- a/server_admin/topics.adoc +++ b/server_admin/topics.adoc @@ -21,6 +21,7 @@ include::topics/users/impersonation.adoc[] include::topics/users/user-registration.adoc[] include::topics/users/recaptcha.adoc[] include::topics/users/personal_data.adoc[] +include::topics/users/allow-user-to-delete-account.adoc[] include::topics/login-settings.adoc[] include::topics/login-settings/forgot-password.adoc[] include::topics/login-settings/remember-me.adoc[] diff --git a/server_admin/topics/users/allow-user-to-delete-account.adoc b/server_admin/topics/users/allow-user-to-delete-account.adoc new file mode 100644 index 0000000000..5083ab511f --- /dev/null +++ b/server_admin/topics/users/allow-user-to-delete-account.adoc @@ -0,0 +1,46 @@ + + +=== Enabling account deletion by users + +{project_name} can allow applications end users to delete their account through the Account Console. The functionality is not enabled by default. To enable it, the following steps needs be taken: + +* Enabling the "Delete Account" Required Action + +Allowing the user to delete their account is done through an AIA (Application Initiated Action). You need first of all to enable the action from the admin console. In Authentication menu, go to the Required Actions tab and tick the enabled checkbox for the "Delete Account" action. + +image:{project_images}/enable-delete-account-action.png[] + +* Making sure the Account Console client has the `delete-account` role: + +The second requirement to enable the delete account functionality is to make sure the "account" client has the `delete-account` role. The `delete-account` role is assigned by default, unless removed by the {project_name} admin. To enable the delete account role, go to Clients menu, and click on the "account" client. +Then go to the roles tab, and check if the `delete-account` is among the roles. In case it is not, you can add it by clicking on "Add Role". + +image:{project_images}/delete-account-role.png[] + + +=== Deleting a user in action + + +Once the functionlity is enabled, the user will see a new section named "Delete Account" appear in the user's account console + +image:{project_images}/delete-account-landing-screen.png[] + + +image:{project_images}/delete-account-page.png[] + + +As stated by the warning message, this action is irreversible, and it implies the deletion of all the user's data in Keycloak. + +Once the user clicks on Delete, he will be prompted to enter his credentials again and redirected to the final confirmation step: + + +image:{project_images}/delete-account-confirm.png[] + + + +After confirming, the user's account will be deleted. + + + + +