Microsoft 365 User | Suspend rule

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.

Query criteria

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

Post-query filter

To hide unwanted data based on criteria, not supported by the Microsoft 365 query criteria above, set the filtering conditions here.

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.

User account properties

Account state

Specify account state:

1. Any
2. Enabled
3. Disabled

User type

Specify user type:

1. Any 
2. Member
3. Guest

Account sync status

Specify account sync status:

1. Any
2. Synced
3. Cloud-only

Modern MFA status

Specify modern MFA status:

1. Any
2. Configured - a user has at least one authentication method configured. 
3. Not configured - a user doesn't have any authentication methods configured.

Administrator role

Specify administrator role:

1. Any
2. Global Administrator
3. Or select a specific Administrator role from the picker dialog.

Date time properties

Minimum account age (hours)

Maximum account age (hours)

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.

Last password change (days ago)

Last sync time (days ago)

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.

How to add custom attributes to New Object and Object Properties wizards in Web Portal – Cayosoft Help Center.

Mailbox and Licensing filters

Mailbox type 

Specify mailbox type:

1. Do not filter
2. Any mailbox
3. No mailbox
4. User
5. Shared
6. Room
7. Equipment

Include licensed users

Specify which users should be included:

1. All users
2. Licensed users only
3. Unlicensed users only

Filter by licenses

You can filter users by assigned licenses and apps/services:

1. License filter conditions are split into two groups: filter by licenses and filter by apps/services.
2. Licenses can be filtered by ALL, ANY, and NOT:
   1. ALL - user must have all listed licenses assigned
   2. ANY - user must have at least one listed license assigned
   3. NOT - user must not have any listed licenses assigned.
3. Apps/services filter conditions: ENABLED (all specified) and DISABLED (all specified):
   1. ENABLED (all specified) - user must have all listed apps/services
   2. DISABLED (all specified) - user must not have all listed apps/services.

Also, you can add filtering by inheritance of assigned applications and services:

1. Filter by direct or inherited (GBL) assignments
2. Filter by direct assignments only
3. Filter by inherited assignments (GBL).

Organization Properties

DisplayName/Email starts with

EmployeeID starts with

Employee type

Job Title 

Division

Cost center

Department

City

State

Country 

Postal code

Usage location

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

Data source anchor attribute

System anchor attribute

Other Query Settings

System properties

Sort by

Sort result objects list.

Limit result set

The maximum number of users returned from Microsoft 365 by default is 2000.

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.

Example: Update AD users, created in the last ten days.

1. Add this initialization script:

{$global:DatePeriod = (Get-Date).AddDays(-10)}

2. Use $DatePeriod variable in the query criteria builder:

Microsoft 365 Suspend configuration 

Specify the existing Microsoft 365 Suspend configuration that should be applied during the Microsoft 365 user suspend.

It is possible to use the default Microsoft 365 User Suspend configuration or create a custom Suspend configuration.