Overview
Users' web query displays Microsoft 365 user objects, including guest accounts, resource mailboxes, and shared mailboxes. Users' web query is included in the built-in Microsoft 365 container.
Users web query settings
Setting name | Description |
---|---|
Limit scope to this Azure AD Administrative Unit |
You can select Azure AD Administrative Unit to limit the Web Query scope. By default, the value is taken from the Virtual Admin Unit setting. |
Query criteria |
Query criteria are sent to the target platform with other query parameters to reduce the number of returned objects and may improve query performance. |
Default user state filter value |
Specify the state of users to include in the web query scope:
|
Default user type filter value |
Specify the type of users to include in the web query scope:
|
Other Query Settings |
|
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". |
System properties |
List of properties required for this rule to be executed correctly. |
Post-query filter |
To hide unwanted data based on criteria, not supported by the target system in the query criteria, set the filtering conditions here. Tip 1: For optimal performance, use the Query criteria above to filter objects whenever possible.
Tip 2: To filter by extension attribute 1 that is synchronized from AD you need to use a condition like: {$_."OnPremisesExtensionAttributes/extensionAttribute1" -eq "Sales"}.
|
Sort by |
Sort result object list. |
Limit result set |
The maximum number of user accounts returned from Microsoft 365. The default value is taken from the Users web query Show setting in Cayosoft Web Portal. |
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. |
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>.
|
MS Graph advanced queries |
Enables consistency level eventual which uses an index that might not be up-to-date with recent changes to the object. |
Office 365 License Quota |
|
Enable quota management Licenses list with settings Licensing quota notification contacts |
Cayosoft Administrator allows allocating Microsoft 365 licenses and assigning quota limits by Administrative Units. Having configured an Administrative Unit per department and then configured License Quotas in Users web queries on these Administrative Units, you will prevent local department IT to over-use the Microsoft 365 licenses. You will get an overview of over-and under-use across departments. For step-by-step configuration instructions, please see the Office 365 License Quotas article. |
Suspend Configuration |
|
AD User Suspend configuration |
Specify AD User Suspend configuration. By default, it is taken from the Admin Unit settings. |
AD User Undo Suspend configuration |
Specify AD User Undo Suspend configuration. By default, it is taken from the Admin Unit settings. |
General settings
Setting name | Description |
---|---|
Replace Web UI Help URL |
In Cayosoft Web Portal each web query has a help link that opens the corresponding section in Cayosoft documentation. If you need you can replace the default link with your custom link to your intranet portal. |
Web Actions tab
For details please see this article: Re-arranging Web Queries actions – Cayosoft Help Center.
Output Section
This section defines the output format of this rule.
To get more information about this section, please see the Output section article.
Change History
Version | Notes |
---|---|
10.3.0 |
|
8.2.0 | MS Graph advanced queries setting is added. |
7.4.0 | Active Users web query is renamed to Users web query. |
7.2.0 | Limit scope to this Azure AD Administrative Unit setting is added. |
Comments
0 comments
Please sign in to leave a comment.