Rule description
This rule queries the specified data source and suspends user accounts according to the settings specified in the provided AD User Suspend configuration.
When to use this rule
Use this rule when you need to suspend AD user accounts based on the data in the external data source, for example, the HR system.
Rule Settings
Query Section
| Setting name | Description |
|---|---|
|
Select Data Source
|
Specify the text file for import. Press the […] button to browse for the file, or the Create button to create or edit the file in the Cayosoft Administrator data source editor. |
|
Limit Scope to this Domain or OU
|
This setting defines the search query scope. To improve query performance, limit the scope to specific OU. Important: To test rule configuration, limit the rule scope to an OU that contains test accounts or objects.
|
| More options | |
|
Filter CSV data |
This setting specifies the filter that can remove data rows from the imported text file that satisfies the specific condition. |
|
Filter
|
Set the filtering conditions to only return objects or data that need to be processed by the rule. Example: filter by Name column. |
|
Returned Properties
|
Select properties to display for each object found by the query.
|
| Sort by | Specify a column to sort the result objects list. |
|
Data Source Anchor attribute
|
Select the column in the data source that will be used to find a matching user account in Active Directory and determine if the user account already exists. The value of this column in the data source is compared to the Active Directory Anchor Attribute value in the Active Directory. |
|
Active Directory Anchor attribute
|
Select the attribute in the Active Directory to compare the Data Source Anchor attribute when searching for a matching user account. When a new user is created by this rule, the value of this AD attribute is set to the value of the data source anchor attribute. This guarantees the rule will find a matching user on its next run and will not create a duplicate user account. |
|
Initialization Script |
|
|
Initialization script |
Usually, rules use query criteria to limit the query search scope. It improves the performance of the executed rule. Due to PowerShell limitations, it is not possible to use calculated expressions in query criteria. That is the point where the initialization script can help. You can initialize a global variable in this setting and then use it in query criteria. Important: To use a variable, declared in the initialization script, in the query scope, it must be global: $global:<variable name>.
Example: Update AD users, created in the last ten days.
{$global:DatePeriod = (Get-Date).AddDays(-10)}
|
Action Section
| Setting name | Description |
|---|---|
| AD Suspend configuration |
Specify the existing AD User suspend configuration that should be applied during the object suspend. It is possible to use the default AD User Suspend configuration or create a custom Suspend configuration. |
| Microsoft 365 Suspend configuration |
Select an existing Microsoft 365 Suspend configuration that will be used to suspend related Microsoft 365 user accounts. |
Output Section
This section defines the output format of this rule.
To get more information about this section, please see the Output section article.
Enforce/Schedule section
This section defines the schedule for how often to run the rule.
To get more information about this section, please see the Enforce/Schedule section article.
Change History
| Version | Notes |
|---|---|
| 10.3.0 | The rule has been introduced in the product. |
Comments
0 comments
Please sign in to leave a comment.