AD Users | Set Proxy Addresses rule
This rule queries Active Directory for the specified users and adds or updates proxy addresses for them.
When to use this rule
Use this rule when you need:
Generate new proxy addresses for Active Directory users.
Add prefix to all addresses of the specified type for Active Directory users.
Remove prefix from all addresses of the specified type for Active Directory users.
Add proxy addresses to a new user account created in Web UI. Please see the How to configure one rule to run after another rule or a web action article for details.
Update mail attribute for user accounts.
Rule Settings
| Setting name | Description |
|---|---|
| Query Section | |
| Limit scope to this domain or OU |
This setting defines the search query scope. To improve query performance, limit the scope to a specific OU. IMPORTANT: To test the rule configuration, limit the rule scope to an OU that contains test accounts or objects and use the Preview feature. |
| Query criteria |
Query criteria are sent with the query and may improve query performance. TIP: For additional information on the criteria builder, see the How to use Query Builder dialog for Query Criteria and Filter rule settings. |
| More options | |
| Filter |
Set the filtering conditions to hide unwanted data based on criteria not supported in the Query criteria setting. Example: filter by the found object Distinguished Name. TIP: For optimal performance, use the Query criteria setting above to filter objects whenever possible. |
| Returned Properties | To display additional properties for each object found by the query, add those properties to the list. |
| Sort by | Sort result object list. |
| 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 the 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: Example: Update AD users, created in the last ten days.
|
| Action Section | |
| Address type | Specify address type to add, update, or remove. For SMTP address you can also choose to make it primary and set as 'mail' attribute. |
| Operation |
Select operation you need to perform on AD users' accounts:
|
| Address Prefix |
Specify address prefix. Example: All user accounts have SMTP address like address@mydomain.com. If you select to add the prefix MyPrefix_ to all SMTP addresses, the new SMTP addresses will be MyPrefix_address@mydomain.com". If you select to remove the prefix MyPrefix_ from all SMTP addresses, SMTP addresses will be reverted back to "address@mydomain.com". If SMTP addresses don't contain the specified prefix, they won't change. TIP: To extract address prefix from the mail attribute use this script |
| Address Suffix |
Specify address suffix. NOTE: This setting is only used when the Operation is set to Generate a new address. |
| Set generated address as the primary |
Select whether to set the generated address as primary or not. NOTE: This setting is only used when the Operation is set to Generate a new address. |
| Remove other email addresses |
Select whether to remove other email addresses or not. NOTE: This setting is only used when the Operation is set to Generate a new address. |
| Add integer counter if email already exists | Check for generated email address uniqueness and add the numeric counter to the name part in the email address (before "@"). |
| Counter format | Specify the counter format for the integer number to add to make a generated address unique across the organization. For example, to use two digits number specify '00', or to start from a specific number (5) specify '5'. |
| SMTP Address Additional Options | |
| Update mail attribute | Select whether to update the user mail attribute or not. |
Output Section
This section defines the output format of this rule.
To get more information about this section, please see the Rule 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 Rule Enforce/Schedule section article.
Change History
| Version | Notes |
|---|---|
| 9.1.0 | Domain Controller and Credentials settings have been removed. |
| 7.3.1 |
|
| 5.4.0 | The rule supports linking to web actions as rules to run after the web action. |
Comments
0 comments
Please sign in to leave a comment.