(Legacy) How to automatically suspend users on the specified date

Published: 03/02/2023

Applies to: Cayosoft Administrator 9.x or later.

Summary: This article contains step-by-step instructions on automatically suspending users on the specified date.

Overview

Cayosoft Administrator Web UI allows set dates and times when a user or group should be suspended or undo-suspended. To set the suspension user date and time automatically and then perform suspension you should use these rules:  

1. Text file | Update AD Users - configure this rule to add the suspension date to the accountNameHistory user attribute.
2. AD Users | Process Scheduled Suspends - schedule this rule to provide scheduled suspend.

Configuration

1. Create Text file | Update AD Users rule.
2. Specify the Data source anchor attribute and Active Directory anchor attribute to map the users specified in the CSV file to users in Active Directory
3. Specify OU in Active Directory to limit the users' scope.
4. Open the Other Properties section.
5. Copy and paste the script below to the Other properties script setting. This script will update the accountNameHistory attribute and set the suspension date <current date> + 30 days:
   Important: Please be advised that all values in accountNameHistory attribute will be replaced with date and time. All other dates will be lost after the update.

   {$dateSuspend=[DateTime]::UtcNow.AddDays(30).ToString("yyyy-MM-ddTHH:mm:ss.fffZ");
   @{'accountNameHistory'="<suspendOn date=""$dateSuspend""/>"} }

6. Save changes.
7. Create AD Users | Process Scheduled Suspends rule.
8. Specify suspend settings file where you can determine the actions that should be performed after suspension: attribute update, objects relocation and etc. For details, please see this video Create a User Suspend Policy Before Cayosoft Administrator Setup – Cayosoft Help Center and this article: Suspending users and groups – Cayosoft Help Center.
9. Schedule it to run daily to provide the scheduled suspension. 
10. Save changes.