Onboarding a Microsoft user involves adding or syncing in users to Automate from the Microsoft portal (Microsoft Entra) with the correct licenses, moving users to the correct site, and provisioning them with the correct services.

Onboarding elements

The table describes the elements relevant for onboarding Microsoft users:

Element	Description
M365 User (Msoluser)	The base anchor for the user, and typically the first element pulled into Automate for a Microsoft user. Limited update options are available for this user. Automate can update usage location and licenses, depending on how the system is set up.
Usage location	Usage location is updated completely independent from licensing, provided a value for usage location is included in a configuration template (CFT) via Quick Add Group, Subscriber from Profile, or a field display policy (FDP). If usage location updates aren't required (either you're not using it or the permissions don't allow it), then exclude it from the CFT. The LicenseAssignment permission allows usage location update. Note that the Microsoft API sets the same usage location; it says it's updating usage location even if permissions don't exist.
Licenses	For onboarding, Quick User, Onboard user, or the field display policy (FDP) honors settings in the Quick Add Group configuration template (CFT) for the M365 user. Direct licenses are applied if they're included. If the CFT does not include any licenses, it won't try to apply licenses. Regardless of the license settings in the CFT, usage location can still be set. If using group licenses, this overrides any direct licenses configured in the onboarding CFTs.

Element

Description

M365 User (Msoluser)

The base anchor for the user, and typically the first element pulled into Automate for a Microsoft user. Limited update options are available for this user. Automate can update usage location and licenses, depending on how the system is set up.

Usage location

Usage location is updated completely independent from licensing, provided a value for usage location is included in a configuration template (CFT) via Quick Add Group, Subscriber from Profile, or a field display policy (FDP).

If usage location updates aren't required (either you're not using it or the permissions don't allow it), then exclude it from the CFT. The LicenseAssignment permission allows usage location update. Note that the Microsoft API sets the same usage location; it says it's updating usage location even if permissions don't exist.

Licenses

For onboarding, Quick User, Onboard user, or the field display policy (FDP) honors settings in the Quick Add Group configuration template (CFT) for the M365 user. Direct licenses are applied if they're included.

If the CFT does not include any licenses, it won't try to apply licenses. Regardless of the license settings in the CFT, usage location can still be set. If using group licenses, this overrides any direct licenses configured in the onboarding CFTs.

Scenario	Description
No M365 template in your Quick Add Group	Used when the LicenseAssignment permission is not assigned to the application. In this case: Msoluser is left untouched - usage location and license is not updated.
M365 user template exists in your Quick Add Group	Usage location entry: Automate updates the usage location according to definition in the CFT License data (LicenseAssignment permission required): Automate adds any license/s defined in the CFT (direct license assignment to the user) Any existing licenses the user has (direct) are replaced with what was configured in the template
MS Group Add template exists in your Quick Add Group	Used to add group memberships to the user/s (for licensing or other purposes). The user is assigned to the group/s in the CFT, in addition to any existing group memberships the user has.

Common onboarding scenarios and setup

The table describes example common onboarding scenarios and the setup required, whether using Quick User, Onboard user, or a field display policy (FDPs):

Example onboard scenario	Setup
No update to Msoluser at all (usage location and/or licenses)	Do NOT include a M365 template in the Quick Add Group.
Update usage location, no license update	Include a M365 CFT in your QAG. The CFT must include the usage location logic you require (for example, macro from site default, etc). Leave the license fields blank in the CFT.
Update usage location, and update license (direct licensing)	Include a M365 CFT in your Quick Add Group that includes the usage location logic and licenses you require (e.g. macro from site default, etc).
Update usage location and group assignment (for license or other purposes)	Include a M365 CFT in your Quick Add Group that includes the usage location logic you require (e.g. macro from site default, etc.) Include a Add Group CFT in your Quick Add Group that includes the groups you wish to add to the user.

Syncing in and onboarding Microsoft users

Automate provides two onboarding sync options for Microsoft users:

Sync users to customer level, and then to sites

Automate Configuration and Sync

This option starts with an initial import of dial plans, policies, licenses, and Microsoft users, to the customer level (sync all to the tenant).

Then you will need to set up the configuration and user move criteria before moving users to the sites (set up model filter criteria, site defaults, quick add groups, user profiles, and number inventory).

Finally, you have two options to move users to the sites as fully provisioned users:

Run the overbuild to move multiple users to your sites at once.
Update single users via Microsoft Quick User

When moving users to site, the Automate automated workflow applies the required configuration, services, lines, policies, and licenses.

Sync users directly to sites

Sync to Site with Flow Through Provisioning

In this option, you run the initial sync together with flow through provisioning. In this case, you start by setting up the configuration and user move criteria before running the initial sync. That is, to set up the model filter criteria, site defaults, quick add groups, and user profiles.

In addition, you will need to:

Configure flow through provisioning criteria
Enable flow through in the Global Settings

Once changes are synced in from the Microsoft Cloud, Automate automated workflows move the tenant dial plan, policies, and licenses to the customer level, and moves users directly to the appropriate sites as fully provisioned users.

Note

Automate v21.2 introduced sync with flow through provisioning for Microsoft users. In 21.3, this feature extends the functionality to users synced in from LDAP and Cisco UCM.
Only Add is supported for syncs with flow through provisioning. Update and delete are not supported since the requirements may differ depending on the customer scenario.
For details on the generic flow through provisioning feature (which includes Microsoft, LDAP, or Cisco UCM users), see Flow through provisioning (FTP)

Related topics

Prevent duplicate numbers

Onboard user (Cisco)

This procedure adds a user from a profile to enable user onboarding via defined a pre-defined profile determining services and service settings.

Model Details: view/AddSubscriberFromProfile

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title			Description	Details
Subscriber Details			Group Assigned by FDP	Field Name: Subscriber Details Type: Object
	Username *		Username of the subscriber.	Field Name: Subscriber Details.username Type: String
	First Name		First name of the subscriber.	Field Name: Subscriber Details.firstname Type: String
	Last Name		Last name of the subscriber.	Field Name: Subscriber Details.lastname Type: String
	Email Address		Email address of the subscriber.	Field Name: Subscriber Details.email Type: String Pattern: ^([^.@]+)(\.[^.@]+)*@([^.@]+\.)+([^.@]+)$
	Send welcome email		Send Email to user using predefined HTML Email Template. Email template used is 'Quick Add Subscriber'	Field Name: Subscriber Details.send_email Type: Boolean
	Mobile Number		Mobile number of the subscriber.	Field Name: Subscriber Details.mobile_number Type: String
	Subscriber Profile *		The profile to use for subscriber configuration.	Field Name: Subscriber Details.subscriber_profile Type: String
	Password		The corresponding CUCM, CUC and WebEx user password will be set with this password	Field Name: Subscriber Details.password Type: String Is Password: True
	PIN		The corresponding CUCM and CUC user PIN will be set with this PIN	Field Name: Subscriber Details.pin Type: String Is Password: True
	Use generated phone name		A random phone name will be generated by the system. This is only applicable if the selected Subscriber Profile has the Voice service enabled. Default: true	Field Name: Subscriber Details.generate_phone_name Type: Boolean Default: true
	Phone Name		Name to be used when provisioning a phone for e.g. SEPAABBCCDDEEFF. The specific format is dependent on the phone type specified in the profile configuration. This is only applicable if the selected Subscriber Profile has the Voice service enabled.	Field Name: Subscriber Details.phone_name Type: String
	Use next available line		Use the next available line from the inventory. Default: true	Field Name: Subscriber Details.automatic_line Type: Boolean Default: true
	Inventory Filter			Field Name: Subscriber Details.automatic_line_filter Type: String
	Inventory Filter			Field Name: Subscriber Details.line_filter Type: String
	Line		The line number to use for this subscriber.	Field Name: Subscriber Details.line Type: String
Existing Services			Group Assigned by FDP	Field Name: Existing Services Type: Object
	Existing Services		Subscriber's existing services.	Field Name: existing Type: Object
		Phones		Field Name: Existing Services.existing.phones Type: String
		Extension Mobility Profile		Field Name: Existing Services.existing.ext_mobilities Type: String
		Voicemail Extension		Field Name: Existing Services.existing.voicemail Type: String
		Single Number Reach		Field Name: Existing Services.existing.snr Type: String
		Webex Meetings		Field Name: Existing Services.existing.webex Type: String
		Webex App		Field Name: Existing Services.existing.spark Type: String
		Pexip Conferencing		Field Name: Existing Services.existing.pexip Type: String
		Contact Center		Field Name: Existing Services.existing.contact_center Type: String
		Microsoft Hosted Voicemail		Field Name: Existing Services.existing.microsoft_hosted_voice_mail Type: String
		Microsoft Teams Phone System		Field Name: Existing Services.existing.microsoft_enterprise_voice_enabled Type: String
		Hybrid Service		Field Name: Existing Services.existing.hybrid Type: String
New Services			Group Assigned by FDP	Field Name: New Services Type: Object
	New Services		Subscriber Profile Services that will be added.	Field Name: subscriber_profile_services Type: Object
		Line		Field Name: New Services.subscriber_profile_services.line Type: String
		Phone		Field Name: New Services.subscriber_profile_services.phone Type: String
		Extension Mobility Profile		Field Name: New Services.subscriber_profile_services.ext_mobilities Type: String
		Voicemail Extension		Field Name: New Services.subscriber_profile_services.voicemail Type: String
		Single Number Reach		Field Name: New Services.subscriber_profile_services.snr Type: String
		Jabber (iPhone)		Field Name: New Services.subscriber_profile_services.jabber_iphone Type: String
		Jabber (Android)		Field Name: New Services.subscriber_profile_services.jabber_android Type: String
		Jabber (Tablet)		Field Name: New Services.subscriber_profile_services.jabber_tablet Type: String
		Jabber (CSF)		Field Name: New Services.subscriber_profile_services.jabber_csf Type: String
		Jabber (CIM)		Field Name: New Services.subscriber_profile_services.jabber_cim Type: String
		Jabber (CTI)		Field Name: New Services.subscriber_profile_services.jabber_cti Type: String
		WebEx		Field Name: New Services.subscriber_profile_services.webex Type: String
		Webex Calling		Field Name: New Services.subscriber_profile_services.webex_calling Type: String
		Webex App		Field Name: New Services.subscriber_profile_services.spark Type: String
		Pexip Conferencing		Field Name: New Services.subscriber_profile_services.pexip Type: String
		Contact Center		Field Name: New Services.subscriber_profile_services.contact_center Type: String
		Microsoft Hosted Voicemail		Field Name: New Services.subscriber_profile_services.microsoft_hosted_voice_mail Type: String
		Microsoft Teams Phone System		Field Name: New Services.subscriber_profile_services.microsoft_enterprise_voice_enabled Type: String

Model: view/AddSubscriberFromProfile

Onboard user (Microsoft)