Rule description
This rule adds Microsoft 365 users to cloud groups. A predefined instance of this rule called 'New User | DynamicAttributes Add to Azure Cloud groups' is linked to the New User | Create Office 365 User rule and New User (MS365) actions as a post-action rule in the Rules to run after section. The 'Run add to cloud group post creation tasks' setting on these Web UI actions must be set to 'Yes' for this rule to be executed automatically.
When to use this rule
Use this rule when you need to add Microsoft 365 users to Azure Cloud groups. You can add Microsoft 365 users to Azure Cloud groups that are specified directly in the rule or to groups dynamically based on the attribute mapping in the CSV file.
Query Section
Setting name | Description |
---|---|
General Settings | |
Limit scope to this Azure AD Administrative Unit |
This setting defines the search query scope. To improve query performance, limit the scope to a specific Azure Admin Unit.
Important: To test rule configuration, limit the rule scope to an Azure Admin Unit that contains test accounts or objects.
|
Query criteria
|
Query criteria are sent with the query and may improve query performance.
Tip: For different samples on the criteria builder, see KB20180410-1.
|
Post-query filter
|
To hide unwanted data based on criteria, not supported by the Microsoft 365 query criteria above, set the filtering conditions here.
Tip: For optimal performance, use the Query criteria above to filter objects whenever possible.
|
Properties to display |
Each object property defined in this setting matches the column that will be displayed in the Cayosoft Web portal for this web query. To display additional columns, add the required properties to the Properties to display list.
Tip: To add extension attribute 1 that is synchronized from AD you need to use a value like "OnPremisesExtensionAttributes/extensionAttribute1~Extension Attribute 1".
|
User account properties |
|
Account state |
Specify account state:
|
User type |
Specify user type:
|
Account sync status |
Specify account sync status:
|
Modern MFA status |
Specify modern MFA status:
Important: Due to the current nature of the Microsoft API that returns this information, users will be processed one by one by this MFA status post-filter. Expect 10 minutes of processing per every 300 returned users if this filter is enabled. Reduce the number of users by using query criteria to reduce the rule execution time.
|
Administrator role |
Specify administrator role:
|
Date time properties |
|
Minimum account age (hours) |
Specify the minimum account age for the Microsoft 365 user accounts. |
Maximum account age (hours) |
Specify the maximum account age for the Microsoft 365 user accounts. |
Last Microsoft 365 sign in (days ago) |
Set a minimum number of days past since a user signs in to Microsoft 365. Use 0 to disable this check.
Note: Using this parameter requires an Azure AD Premium P1/P2 license in the tenant.
|
Last password change (days ago) |
Set a minimum number of days past since a user changed the password. |
Last sync time (days ago) |
Set a minimum number of days past the last sync time. |
Extension Attributes |
|
Extension attribute1 - Extension attrbute15 |
If you use Microsoft 365 extension attributes to store additional information for user accounts, you could select these attributes and map them to Other Attributes. |
Mailbox and Licensing filters |
|
Mailbox type |
Specify mailbox type:
|
Include licensed users |
Specify which users should be included:
|
Filter by licenses |
You can filter users by assigned licenses and apps/services:
Also, you can add filtering by inheritance of assigned applications and services:
|
Organization Properties |
|
DisplayName/Email starts with EmployeeID starts with Employee type Job Title Division Cost center Department City State Country Postal code Usage location |
Specify organization properties for search. |
Map to text file |
|
Select data source |
Specifies the text file to be imported. The […] button allows the user to browse for the file and the Create/Edit button allows the creation or editing of the existing file in the built-in Data Source editor. |
Separator used in file |
Specify the separator that is used in the CSV file. |
Data source anchor attribute |
Select a column in the data source that contains the attribute value for identifying and mapping a user. |
System anchor attribute |
Specify user anchor attribute. |
Other Query Settings |
|
System properties |
List of properties required for this rule to be executed correctly. |
Sort by |
Sort result objects list. |
Limit result set |
The maximum number of users returned from Microsoft 365 by default is 2000.
Tip: It is possible to change the default value in Microsoft 365 extension settings.
|
MS Graph query condition (OData) |
By default, Query criteria are used. But when the MS Graph query condition is specified, it overrides the Query criteria setting. See this article for examples: How to use Query Builder dialog for Query Criteria and Filter rule settings – Cayosoft Help Center. |
MS Graph advanced queries |
Enables consistency level eventually which uses an index that might not be up-to-date with recent changes to the object. |
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.
{$global:DatePeriod = (Get-Date).AddDays(-10)}
|
Action Section
Setting name | Description |
---|---|
Target groups selection mode |
One of these values is possible:
|
Action |
Specify one of these actions:
|
Group names | Specify group names separated by ';' or click '...' to select from the cloud. |
Dynamic Mapping from File Settings | |
Data source |
This setting specifies the text file for import. The […] button allows the user to browse for the file and the Create button allows creation or editing of the file in the Cayosoft Administrator data source editor. |
Separator used in file | Use this setting to select the separator used in the file. |
Azure Active Directory anchor attribute |
Specify cloud user attribute. For each object returned by the query, the selected attribute value will be used to map the object with the selected data source anchor. |
CSV anchor match column | Select the CSV column that contains the values that will be matched to the AD anchor attribute values. |
Azure AD group column | Select the CSV file column containing the Azure AD group name if using a dynamic mapping file. |
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.