Overview
Microsoft 365 extension provides provisioning, update, suspension, and management of accounts and services located in Microsoft 365. These include Azure AD, Exchange Online, SharePoint Online, and OneDrive.
To access Microsoft 365, the Cayosoft Administrator needs connection settings to be specified. These settings are displayed in the Microsoft 365 extension in the Cayosoft Administrator console. In addition to Microsoft 365 connection settings, there are settings for the Cayosoft Administrator automation rules and Web actions.
Microsoft 365 extension settings
Setting name | Description |
---|---|
Extension is enabled |
Enable or disable the Microsoft 365 extension. Please, see the Select Extensions article section to determine which extensions must be enabled in your environment. |
Microsoft 365 credentials |
Specify the account to connect to Microsoft 365. Important: If multi-factor authentication (MFA) for the Microsoft 365 connection account is enabled with Conditional Access Policies, Security Defaults, or legacy MFA,
Cayosoft Administrator would prompt to complete additional configuration steps.
Microsoft 365 connection account should hold the Global Administrator role in Azure AD and must be a cloud-only account, i.e. not synchronized with on-premises Active Directory. To replace membership in the Global Administrator role with a set of more granular roles, please see the Permissions required for Microsoft 365 management. |
Admin Consent
|
Cayosoft Administrator Service uses the Microsoft Graph API for Microsoft 365 analytical data and Microsoft 365 object management. To access the Microsoft Graph, the Cayosoft Administrator must be granted Administrative Consent.
Consent Status values:
For details, please see these articles: |
Microsoft 365 name suffix
|
Change the Microsoft 365 name suffix. The default value for the Microsoft 365 name suffix is taken from the Microsoft 365 connection account. Microsoft 365 name suffix is used in AD Users | Create Office 365 Accounts (Cloud) rule during new Microsoft 365 user accounts creation and New User web action. |
Default Usage Location |
Specify the Usage Location to set by default for any newly created Microsoft 365 account, or when a Microsoft 365 license is assigned for the first time. The default setting value depends on the region of the computer running the Administration Service. The value of this setting is used in the New User | Create Office 365 User rule, when creating a new Microsoft 365 account that matches the user created in the Active Directory. |
Maximum returned results |
The maximum number of objects returned from Microsoft 365. By default, all objects that you have provisioned in Microsoft 365 are returned. |
Connect to Microsoft Teams (Skype for Business Online) |
Important: Starting from the 8.2.0 version, Cayosoft Administrator has been transitioned to a new Teams PowerShell module to replace the legacy Skype for Business Online Windows PowerShell Module. Run the Cayosoft Requirements Check tool to install the Microsoft Teams PowerShell module.
Skype rules should be replaced with the Teams rules. For details please see this article: How to configure Teams post-creation tasks instead of Skype Online tasks when provisioning a new user account – Cayosoft Help Center
Set this setting to Yes if you plan to use Teams rules and web actions. Note: If you don't plan to use automation rules and web actions listed above, it is recommended to keep this setting set to No for optimal performance.
|
Connect to SharePoint Online service |
Important: SharePoint Client-Side Object Model (CSOM) and SharePoint Online Management Shell are required to enable this feature. For more information, please see Installing components for working with SharePoint Online article.
Connect to SharePoint Online service setting works as follows: Set this setting to Yes if you plan to use one of the features:
Note: If you don't plan to use any of the features listed above, it is recommended to keep this setting set to No for optimal performance.
|
Advanced Settings |
|
SPO tenant admin URL SPO my site host URL |
You can manually specify the SharePoint tenant admin URL and SharePoint my site host URL. These URLs are calculated based on Microsoft recommendations. If the URLs in your environment don't meet recommendations and are calculated incorrectly you should specify them manually. |
SPO get site method |
Note: Contact Cayosoft support before changing the default value.
One of the following values is possible to get the SharePoint site:
|
Azure Environment
|
Select your Microsoft Azure environment from the list. For information on various Azure Environments, please see the MS Docs: https://docs.microsoft.com/en-us/office365/enterprise/office-365-endpoints. |
License Cache File |
The License Cache file contains the list of all Microsoft 365 licenses and options in your tenant. Cayosoft Administrator service updates this file automatically on service start. When new licenses or services were added or removed in your tenant, click the Update License Cache command to update the license cache file manually. For details, please see How to update license cache and rules when the Microsoft 365 license change detected KB article. |
Enforce License Precedence (Advanced) |
This is an advanced setting in Cayosoft Administrator that helps resolve Microsoft 365 license plan conflicts. For details, please see KB20181026-1. |
License Add-ins Services IDs (Advanced) |
This setting is used to determine the proper order in which certain license plans must be assigned or revoked in Microsoft 365. Some Microsoft 365 license plans are treated as add-ins to the core license plans. The add-in license plan cannot be assigned to the user without a corresponding core plan being assigned. Add-in plans must be assigned only after the core plan is assigned and must be revoked before the core plan is revoked. Otherwise, Microsoft 365 reports a license assignment error. If you have any custom add-ins, you should specify them in this setting. |
Microsoft 365 API URL (Advanced) |
This setting points to the Microsoft 365 API endpoint and depends on the selected Azure Environment. Note: This setting was introduced for advanced troubleshooting purposes. Please contact Cayosoft if you believe this setting needs to be changed in your environment.
|
Microsoft Graph Reporting API URL (Advanced) |
This setting points to the Microsoft Graph API endpoint. Note: This setting was introduced for advanced troubleshooting purposes. Please contact Cayosoft if you believe this setting needs to be changed in your environment.
|
Enable Modern Authentication (Advanced) |
Use this setting to enable modern authentication for Microsoft 365. For details please see this article: Modern Authentication and Azure AD Security Defaults impact on Cayosoft Administrator – Cayosoft Help Center Note: Starting from the 8.2 version, this setting is deprecated. Modern authentication is always enabled.
|
Dynamic Group target exclusions |
Use this setting to prevent selecting specific groups as Dynamic Group targets to prevent escalation. You can set multiple values separated by ";", each value is a mask for the target group name. Example: *Global Admins*;*Helpdesk Admins* |
Microsoft Teams membership enumeration page size |
Specify integer number. |
Apply fix for Get-FormatData error |
Contact Cayosoft support if you receive the error connecting to Microsoft 365: Data returned by the remote Get-FormatData command is not in the expected format. |
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. |
Use legacy EXO commands |
Microsoft provided a new set of commands based on REST API for managing Exchange Online. The recommendation is to use these newer Microsoft commands, but they might cause certain backward compatibility issues. Select 'Yes' to switch back to the legacy commands. |
Azure AD Administrative Units |
|
Azure AD Administrative Units |
You can limit the scope of Microsoft 365 web queries to the members of the specified Azure AD Administrative Unit. Click Configure to see the list of all Azure AD Administrative Units in your tenant and check which of them are set to treat as containers. In this case, selected Azure AD Administrative Units will behave like Active Directory Organizational Units: when a new member is added to this Azure AD Administrative Unit, the Cayosoft Administrator removes this member from all other Azure AD Administrative Units marked as containers. You can check\uncheck Treat as container setting for each Azure AD Administrative Unit. |
User Name Generation Rules (Web Interface) |
|
Display Name generation rule User Name prefix generation rule
|
Cayosoft Administrator can automatically generate user DisplayName and User Name during user creation. Select a generation rule from the list or create your own generation rule to satisfy your organization's requirements and policies. These rules are applied to the New User and Rename User web actions. |
User Name conflict resolution
|
Naming attributes should be unique in Microsoft 365. Cayosoft Administrator provides automatic name uniqueness check and conflict resolution. A unique name can be generated with alternative generation rules and applying unique counters. Select the desired behavior when a name conflict is identified:
For more information, please see the Name conflict resolution and alternative names generation section. |
Alternate Name Generation Rules (Web Interface) |
|
Alternative User Name prefix generation rule
|
If the Name conflict resolution option is set to Try alternative generation rule, and if fail-stop and notify a user or Try alternative generation rule, and if fail - continue and suffix the user name with a numeric counter, Cayosoft Administrator will use Alternate Name Generation Rules to generate user name during user creation. Select a generation rule from the list or create your own generation rule to satisfy your organization's requirements and policies. |
Counter format
|
If the Name conflict resolution option is set to Continue and suffix the user name with a numeric counter or Try alternative generation rule, and if fail - continue and suffix the user name with a numeric counter, the next available numeric counter will be added to the generated string. By default, the counter starts with 1. If you want to customize the counter format, use this setting to define the new format. For example, if you need to use two digits in the counter, you should enter 00 in the Counter format field. |
Other User Provisioning Settings (Web Interface) |
|
Default User Language Time Zone |
The values of Default User Language and Time zone settings will be used by default in the New User | Office 365 Mailbox post-creation tasks rule. |
Show email prefix and suffix controls |
Specify if email prefixes and suffixes should be displayed when creating resource mailboxes. |
Password Generation Options |
|
Password policy |
Password policy provides granular control over password complexity rules:
|
Customer Prices for Microsoft 365 Licenses |
|
License prices |
Specify prices for Microsoft 365 licenses, available in your tenant. You should input monthly cost - user/month. These prices are used in:
Note: Prices for Microsoft 365 license quotas need to be specified on each web query separately.
|
Cayosoft Suspend Default Configurations |
|
Default M365 User Suspend Configuration |
Starting from the 10.3 version, Suspend Tool has been migrated to Administrator Service with significantly improved functionality. For details, please see this article about New Suspend Configuration. If you want to use the New Suspend functionality you should set the 'Use modern suspend rules and configurations' setting to 'Yes'. Each Suspend Configuration has a number of settings that are split into sections and should be customized based on your requirements. Here is the list of M365 Suspend Configurations with links to corresponding documentation articles: |
Default M365 User Undo Suspend Configuration |
Actions
Command name | Description |
---|---|
Check settings |
This command validates the specified settings and verifies that:
|
Run components check | This command runs the Cayosoft Administrator System Check tool that verifies what required components are installed. |
Update license cache | This command updates the list of Microsoft 365 License plans and options that are present in your Microsoft 365 tenant. For details please see this KB article: https://support.cayosoft.com/hc/en-us/articles/360018057292 |
Copy Consent URL |
This command copies the consent URL into the clipboard so that you can paste it into any browser to grant consent directly. |
Notify Cayosoft | This command sends Cayosoft the list of Microsoft 365 licenses from the License cache file. |
Troubleshooting Microsoft 365 connection issues
How to grant admin consent to Azure APIs and connect to the Microsoft Graph API
Cayosoft Azure Admin Consent for Microsoft Graph API Assignment Details
KB20180503-1 Troubleshooting connection to Microsoft 365
KB20180823-1 Troubleshooting Cayosoft Administrator Grant Consent
Change History
Version | Notes |
---|---|
11.1.0 | Copy Consent URL command has been added. |
10.3.0 |
|
10.2 | Show email prefix and suffix controls setting has been added. |
10.1 |
|
9.1.0 | The Password Generation Options section has been added. |
8.2.0 |
|
8.0.0 | The Azure AD Administrative Units section is added. |
7.3.0 | Dynamic Group target exclusions, and Apply fix for Get-FormatData error settings are added. |
7.1.0 |
|
7.0.0 |
The Гpdate License command is renamed to Update License Cache. |
6.2.0 |
Azure Admin consent status values added. |
Comments
0 comments
Please sign in to leave a comment.