Articles in this section

See more
Print

AD Users | Set Proxy Addresses rule

Avatar
Tatiana Golubovich
  • Updated
Follow

Rule description

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:

  1. Generate new proxy addresses for Active Directory users

  2. Add prefix to all addresses of the specified type for Active Directory users

  3. Remove prefix from all addresses of the specified type for Active Directory users

  4. Add proxy addresses to a new user account created in Web UI. Please see the KB20181029-1 article for details.

  5. Update mail attribute for user accounts

 

Rule Settings

Query Section

Setting name Description

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.

Query criteria

Query criteria are sent with the query and may improve query performance.

Tip 1: For different samples on the criteria builder, see KB20180410-1.  
More options  

Filter

To hide unwanted data based on criteria, not supported by Active Directory query, set the filtering conditions here.

Example: filter by found object DN.

Tip 2: For optimal performance, use Query criteria 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

 

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.

  1. Add this initialization script:
{$global:DatePeriod = (Get-Date).AddDays(-10)}
  1. Use $DatePeriod variable in query criteria builder:

 

 

Action Section

Setting name Description

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:

  1. Generate a new address. The rule will generate a new address and add it to the user as a primary or secondary address, depending on the Set generated address as the primary setting value.
  2. Add prefix to all addresses. The rule will read the current addresses of the specified type on a user and add a text prefix, specified in the Address Prefix setting, to each address, and then replace addresses with new values.
  3. Remove prefix from all addresses. The rule will read the current addresses of the specified type on a user, remove the text prefix, specified in the Address Prefix setting, from each address, and then replace addresses with new values.

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 3: To extract address prefix from the mail attribute use this script:
 { $FoundObject.mail.Split('@')[0] }
If the user email address is user.name@domain.com, the address prefix will be user.name. 

Address Suffix

Specify address suffix.

Note: This setting is only used when 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 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 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 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
9.1.0 Domain Controller and Credentials settings have been removed. 
7.3.1
  1. Initialization Script section is added.
  2. The following settings are renamed:
    1. Generate new SMTP address -> Generate new address
    2. Add prefix to all primary and secondary SMTP addresses -> Add prefix to all addresses
    3. Remove prefix to all primary and secondary SMTP addresses -> Remove prefix from all addresses 
    4. Update email attribute -> Update 'mail' attribute
    5. Add integer counter if email already exists -> Add integer counter if address already exists
  3. Address type setting is added.
  4. SMTP Address Additional Options section is added.
5.4.0 The rule supports linking to web actions as rules to run after the web action.

 

 

Related articles

Comments

0 comments

Please sign in to leave a comment.