AD Users web query
The AD Users web query displays Active Directory user objects, located in the domain or OU selected as a scope for the query. Default AD Users web query is included in the built-in Active Directory Admin Unit, and a custom copy of the AD Users web query is copied to every new custom Admin Unit.
Web queries in a custom Admin Unit are used as a scope for role delegation and attribute policy. When limiting the scope of web queries to a specific OU, you limit the scope of objects available for management to delegated administrators.
For more information, review the Managed domains article.
Web query settings
| Setting name | Description |
|---|---|
| Limit scope to this domain or OU | Define and limit the scope of the web query. Split the entire scope into multiple queries to granularly manage the items. |
Query criteria |
Use the setting to filter out objects by the property values. Query criteria are sent with the query to the target system; the target system filters data before it returns the resulting set. The default value for this setting is specified in the Web query default filter field in Active Directory extension settings, set to include all objects by default. TIP: See How to use Query Builder dialog for Query Criteria and Filter rule settings for use cases. |
| More Options | |
| Properties to display |
Each object property defined in this setting matches the column that will be displayed in the Web Portal for this web query. To display additional columns, add the required properties to the Properties to display list. To add extension attribute 1 that is synchronized from AD, you need to use a value like:
Copy
|
| Other required properties | Define a list of properties required for this rule to be executed correctly; use the list to create advanced filters. Refer to the following article for additional information: Using filters in web queries. |
| Filter |
Specify additional filter conditions to hide unwanted data based on criteria not supported by Active Directory query. E.g., use the setting to filter out objects based on their distinguished names. TIP: For optimal performance, use Query criteria above to filter objects whenever possible. |
| Sort by | Specify property to sort the resulting object list. |
| Disable partial name search | Disable the substring search functionality to improve search performance in your web query. This setting does not affect the wildcard search logic. |
| Global search mode |
Specify the Global Search mode:
|
| Additional query criteria |
Define additional criteria for all object pickers in this query. IMPORTANT: If the attribute in this criteria does not exist for the picker object type (e.g., user attributes for group pickers), the filter will not work correctly. If you want these criteria to work with some object pickers but not others, you can disable the use of these additional criteria per picker type in the object picker configuration. E.g., exclude some users from the search: |
| Default number of objects to show | Select the number of objects to display in the web query. By default, the global Web Portal setting from the Web Portal Settings > Default number of objects to show is used. |
| Action and Picker Scopes | |
| Default OU for the new user |
Specify default OU where new user objects will be created when running the New User or Clone User commands from this web query. The default AD Users web query, which is included in the built-in Active Directory Admin Unit, has this setting set to the default domain address. The custom AD Users web query, that is included in the custom Admin Unit, has this setting set to match the Admin Unit scope (Organizational Unit), selected during Admin Unit creation. NOTE: If you need to get the connected user domain and use it as a default value for Create In field in New objects web actions you should set the Default OU value to the Connected user domain. |
|
Each web query has the same settings that define default OUs for new objects. But in fact only one of these settings matters that match the web query object type: for AD Users query - Default OU for a new user, for AD Groups query - Default OU for a new group, etc. |
| Default Domain |
This setting defines the default UserPrincipalName suffix. For example, @cayo.com. The Default Domain value is the default domain suffix for the current forest. It is defined in the Forest Settings in the Active Directory extension settings. |
| Additional Scope(s) Object Selection |
Use this setting in two primary scenarios:
Object Picker dialog is used on multiple forms. The Object Picker dialog appears when you need to select an object inside the form. For example, in the Add to Groups form when selecting groups, the Properties form when selecting the user's manager, and so on. By default, this setting is empty, and only objects from the scope, specified in the Limit scope to this domain or OU setting, would be listed on Object Picker. To allow delegated administrators to select objects from additional Organizational Units, add those OUs to the Additional Scope(s) for Object Selection setting. Example: Let the AD Users web query scope is limited by In the Additional Scope for Object Selection, specify the distinguished names: |
| Move Scope(s) |
Specify additional scopes to search for Organizational Units on the Object Picker dialog. The Object Picker dialog appears when you need to select an object inside the form. The Object Picker dialog is used on Move forms for Active Directory users, groups, contacts, and computers. By default, this setting is empty, and only OUs from the scope, specified in the Limit scope to this domain or OU setting, would be listed in the Object Picker. To allow delegated administrators to move objects to additional Organizational Units, add those OUs to the Move Scope(s) setting. Example: Let the AD Users web query scope is limited by OU=OU1,DC=cayo,DC=com. We need to move User1, located in OU1, to OU2. In the Move Scope(s), specify the distinguished name of an additional OU: OU=OU2,DC=cayo,DC=com. This OU is not included in the AD Users web query scope. In this case, when you move a User1 to another OU, you could move this user not only to OUs located in OU1 but also to OU2. You would be able to find and select this OU in the Object Picker dialog. |
| Move Scope(s) Search Depth |
You can select the depth of the moving scope. There are two options:
|
| Suspend Configuration | |
| AD User Suspend configuration | Specify AD User Suspend configuration. By default, it is taken from the Admin Unit settings. |
| Microsoft 365 User Suspend configuration | Specify Microsoft 365 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. |
| Microsoft 365 User Undo Suspend configuration | Specify Microsoft 365 User Undo Suspend configuration. By default, it is taken from the Admin Unit settings. |
| Regional Settings | |
| Default country/region |
Define a country/region to assign to new users created in the Web Portal. If a cloud user account is provisioned for this user in Microsoft 365, a user country is automatically used as a Microsoft 365 usage location. The default value is set in the Active Directory extension settings > Default country/region setting. For more information about the Microsoft 365 settings, see the Microsoft 365 extension settings article. |
|
Default user language Time zone |
Define the default values for cases when a cloud user account is provisioned for AD users. The default values for these settings are specified in the Microsoft 365 extension settings > Other User Provisioning Settings section. Values are used in the Regional settings section in New User | Office 365 Mailbox post creation tasks rule. |
| Office 365 License Quota | |
|
Cayosoft Administrator allows allocating Office 365 licenses and assigning quota limits by Administrative Units. For example, having configured an Administrative Unit per department and then configuring License Quota in the AD Users web queries on these Administrative Units, you will prevent local department IT to over-use the Office 365 licenses and will get an overview of over-and under-use across departments. For step-by-step configuration instructions, please see the Microsoft 365 License Quotas article. |
Web Actions tab
For details review the following article: How to add, remove or re-arrange Web actions within a Web Query.
General settings
| Setting name | Description |
|---|---|
| Replace Web UI Help URL |
In the Web Portal, each web query has a help link that opens the corresponding section in the Cayosoft documentation. If you need you can replace the default link with your custom link to your intranet portal, for example. |
Change History
| Version | Notes |
|---|---|
| 11.3.0 | The Default number of objects to show setting has been added. |
| 10.3.0 | Suspend Configuration section has been added. |
| 8.4.0 |
|
| 7.1.0 | Disable partial name search setting is added. |
Comments
0 comments
Please sign in to leave a comment.