Automated Directory Cleanup

As an administrator, you can leverage EmpowerID to automate the process of deactivating and retiring stale user accounts based on your organization’s security policies. Rather than relying on time-consuming and potentially risky manual methods or scripts to mark accounts as inactive, disabling and deleting them based on policy, you can configure a few simple settings in EmpowerID. Not only does this remove the burden and risks associated with other methods, it provides a safety net to mitigate against accidental deletion of any user account by first marking the accounts for deactivation and notifying the managers of those users, as well as other administrators, that the accounts have been identified for cleanup. The managers and administrators must give approval before EmpowerID does anything further with them. If approved, EmpowerID moves those accounts into a designated OU within your directory, where they remain until their deletion undergoes a multi-step approval process. Accounts not approved for deletion are moved back to their originating OU. Additionally, EmpowerID provides “mock run” capabilities that allow you to generate reports of what would occur in your environment using this feature.

The process involves a number of account store and resource system settings, EmpowerID system settings, workflows, Sets and SetGroups. Each of these settings can be enabled and configured to run based on your own particular security needs. Sets and SetGroups are configured out of the box but can be customized as needed. These settings, workflows, Sets and SetGroups and their function within the cleanup process include the following.

Account Store Directory Cleanup Settings

Directory Clean Up Enabled — This setting specifies whether the Submit Account Terminations permanent workflow should claim the account store for processing account terminations. When enabled, accounts in the account store that meet the qualifications are moved into a special OU within the external directory and disabled.
Report Only Mode (No Changes) — When enabled, EmpowerID generates a report of what the Directory Clean Up process would do if it was fully implemented. The process itself is ignored and all accounts are set to Termination Pending.
OU to Move Stale Accounts — This setting specifies the external directory in which to move accounts marked for termination. The location must exist in the directory.

The below image shows the Directory Cleanup Settings on an example account store.

Resource System Configuration Parameters

These settings are used by the Submit Account Terminations workflow.

ApprovalApproverManagementRoleGUID — This setting specifies the GUID of the Management Role containing people who should receive notification that they need to approve the deletion of the stale accounts selected for termination.
SubmitAccountTerminationsApprovalInitiatorPersonID — This setting specifies the PersonID of the EmpowerID Person used to approve account terminations.
TaskApprovalPendingStatus — This setting is a Boolean that specifies whether a task for the account store is pending approval. The value is set by the Submit Account Terminations workflow when a task has been submitted for approval. This prevents the task from being created more than one time.
TerminationAccountAdvancedInitiatorPersonID — This setting specifies the PersonID of the EmpowerID Person used to initiate the TerminateAccountAdvanced workflow. This workflow is used by the EmpowerID system to terminate all people submitted to it. As a best practice, the Person account you use should not belong to an actual EmpowerID user.
TerminationNotProcessedSetGroupGUID — This setting specifies the GUID of the SetGroup containing all user accounts to be moved and disabled.
TerminationBeforeProcessingSetGroupGUID — This setting specifies the GUID of the SetGroup containing all people needing to receive notification of a pending move and disabling of a user account.
TerminationProcessedSetGroupGUID — This setting specifies the GUID of the SetGroup containing all user accounts to be terminated. Claims the accounts of one account store at at time belonging to the respective SetGroup.
ThresholdOnAccounts — This setting specifies the maximum number of user accounts that can be processed at a given time.

The below image shows the Configuration Parameters for the resource system associated with an example account store.

Workflows

Submit Account Terminations — This is a permanent workflow that claims user accounts meeting the criteria for cleanup in account stores (managed external user directories) where CleanUpEnabled is set to true. The workflow processes the claimed accounts based on the values given to the following parameters.
- AdminManagementRoleGuids — This parameter specifies the GUID of the Management Role containing all people delegated to receive notification of accounts meeting the criteria for cleanup.
- DisableAccountOnMove — This parameter takes a Boolean value of true or false. When set to true, the workflow disables the accounts when moved into the specified OU.
- EmailTemplateAdminPreMoveNotification — This parameter specifies the email to be used when notifying admins that one or more user accounts have been selected to be moved to the specified OU.
- EmailTemplateAdminMoveNotification — This parameter specifies the email template to be used when notifying admin users that one or more user accounts have been moved to the specified OU.
- EmailTemplateManagerPreMoveNotification — This parameter specifies the email template to be used when notifying managers that one or more user accounts belonging to their direct reports have been selected to be moved to the specified OU.
- EmailTemplateManagerMoveNotification — This parameter specifies the email template to be used when notifying managers that one or more user accounts belonging to their direct reports have been moved to the specified OU.
Submit Account Terminations Approval — This workflow creates an approval task and routes the task to all people belonging to the Management Role specified by the AdminManagementRoleGuids parameter set on the Submit Account Terminations workflow.
Terminate Account Advanced — This workflow claims all accounts approved for deletion and deletes them. For each account deleted, the workflow sends email notifications based on the values given to the following parameters:
- AdminManagementRoleGuids — This parameter specifies the GUID of the Management Role containing all people delegated to receive notification of accounts that have been deleted.
- EmailTemplateAdminDeletionNotification — This parameter specifies the email to be used when notifying admin users that one or more user accounts have been deleted.
- EmailTemplateManagerDeletionNotification — This parameter specifies the email to be used when notifying managers users that one or more user accounts belonging to their direct reports have been deleted.
- NotifyAdminManagementRole — This parameter takes a Boolean value of true or false. When set to true, the workflow sends an email listing all user accounts that have been deleted to all admin users belonging to the Management Role specified by the AdminManagementRoleGuids parameter.
- NotifyManager — This parameter takes a Boolean value of true or false. When set to true, the workflow sends an email to the managers of users with user accounts that have been deleted.

SetGroups (Query-Based Collections)

Submit Account Terminations — This is a permanent workflow that claims user accounts meeting the criteria for cleanup in account stores (managed external user directories) where CleanUpEnabled is set to true. The workflow processes the claimed accounts based on the values given to the following parameters.
- AdminManagementRoleGuids — This parameter specifies the GUID of the Management Role containing all people delegated to receive notification of accounts meeting the criteria for cleanup.
- DisableAccountOnMove — This parameter takes a Boolean value of true or false. When set to true, the workflow disables the accounts when moved into the specified OU.
- EmailTemplateAdminPreMoveNotification — This parameter specifies the email to be used when notifying admins that one or more user accounts have been selected to be moved to the specified OU.
- EmailTemplateAdminMoveNotification — This parameter specifies the email template to be used when notifying admin users that one or more user accounts have been moved to the specified OU.
- EmailTemplateManagerPreMoveNotification — This parameter specifies the email template to be used when notifying managers that one or more user accounts belonging to their direct reports have been selected to be moved to the specified OU.
- EmailTemplateManagerMoveNotification — This parameter specifies the email template to be used when notifying managers that one or more user accounts belonging to their direct reports have been moved to the specified OU.
Submit Account Terminations Approval — This workflow creates an approval task and routes the task to all people belonging to the Management Role specified by the AdminManagementRoleGuids parameter set on the Submit Account Terminations workflow.
Terminate Account Advanced — This workflow claims all accounts approved for deletion and deletes them. For each account deleted, the workflow sends email notifications based on the values given to the following parameters:
- AdminManagementRoleGuids — This parameter specifies the GUID of the Management Role containing all people delegated to receive notification of accounts that have been deleted.
- EmailTemplateAdminDeletionNotification — This parameter specifies the email to be used when notifying admin users that one or more user accounts have been deleted.
- EmailTemplateManagerDeletionNotification — This parameter specifies the email to be used when notifying managers users that one or more user accounts belonging to their direct reports have been deleted.
- NotifyAdminManagementRole — This parameter takes a Boolean value of true or false. When set to true, the workflow sends an email listing all user accounts that have been deleted to all admin users belonging to the Management Role specified by the AdminManagementRoleGuids parameter.
- NotifyManager — This parameter takes a Boolean value of true or false. When set to true, the workflow sends an email to the managers of users with user accounts that have been deleted.

Process Flow

The process for automating the deactivating and retiring of stale Active Directory user accounts is depicted in the below image. An explanation of the process follows the image.

Submit Account Terminations workflow

This workflow claims account stores where CleanUpEnabled is set to true and gets the following SetGroup GUIDS from Resource System Config Settings in order to process those groups:
- TerminationBeforeProcessingSetGroupGUID — This setting specifies the GUID of the SetGroup containing all people needing to receive notification of a pending move and disabling of a user account.
- TerminationNotProcessedSetGroupGUID — This setting specifies the GUID of the SetGroup containing all user accounts to be be moved and disabled.
- TerminationProcessedSetGroupGUID — This setting specifies the GUID of the SetGroup containing all user accounts to be terminated. The workflow processes one account store at a time.
If CleanUpReportModeOnly is set to true, all the account processing steps are ignored and the account’s AccountOrganizationStatusID is set to 3 (TerminationPending). This logs everything that the workflow would do if Report Only Mode was turned off.
Else if CleanUpReportModeOnly is turned off and whether CleanUpStaleAccountOU has a valid External OrgZone.
If the CleanUpStaleAccountOU setting on the account store is not valid, the account store is ignored, No accounts will be disabled and moved. Else it continues to claim the accounts and process the claimed accounts.
If the number of accounts in the account store reaches the specified threshold, the SubmitAccTerminationsApproval workflow is invoked.
Else if the number of accounts of the account store is under the ThresholdOnAccounts Resource System Config Setting value, SubmitAccountTerminations workflow moves the accounts to the OU specified by the CleanUpStaleAccountOU setting.
If the DisabledAccountOnMove setting on the Workflow parameters is set to true, the accounts are disabled when moved; else the accounts are not disabled and moved.
When an account is moved, the AccountOrganizationStatusID is set to 5 (Transfer) and the TransferDate is set to current date and time on the account.
Emails are sent to manager and admin after the account is moved. EmailTemplateManagerMoveNotification and EmailTemplateAdminMoveNotification are used as templates to send emails.
The AdminManagementRoleGuids workflow parameter determines which admin users should receive the email notification.
Once the emails are sent, an AssigneeNotification is inserted for that account and will not be claimed again to send notifications before moving accounts.
The accounts claimed earlier for termination will be processed by invoking the Terminate Account Advanced workflow for each account that is to be terminated.

Submit Acc Terminations Approval workflow

This workflow creates an approval task for all accounts belonging to the Management Role specified by the ApprovalApproverManagementRoleGUID parameter of the Submit Account Terminations workflow. At least one user belonging to the Management Role needs to select and approve each account to be terminated.
Once a task is created for an account store, the TaskApprovalPendingStatus Resource System Config Setting is set to true. This prevents the system from recreating the task.
If the task is approved, all accounts selected from the Task Approval Form of the workflow are disabled and moved, and the TaskApprovalPendingStatus setting is set to false.

Terminate Account Advanced workflow

This workflow claims all accounts approved for termination, moves and terminates each one, setting the AccountOrganizationStatusID = 2 (Terminated).
Once an account is terminated, the workflow checks whether the NotifyManager and the NotifyAdminManagementRole parameters are set to true.
If NotifyManager and NotifyAdminManagementRole are set to true, the workflow checks the EmailTemplateManagerDeletionNotification and the EmailTemplateAdminDeletionNotification parameters for the email template that is to be used to send emails to the managers of each terminated user, as well as all admin users belonging to the Management Role specified by the AdminManagementRoleGuids parameter.