[Index]

Model: device/msgraph/MsolUser

Microsoft users

Full HTML Help

Tip

Use the Action search to navigate Automate

Overview

Microsoft users must be onboarded in VOSS before they can be fully provisioned and managed. Onboarding involves importing users and related data from the Microsoft Cloud, placing users in the correct customer and site hierarchies, and applying configuration, policies, and licenses through automated workflows.

Once users are synced at the customer or site level, administrators can manage Microsoft users centrally from the VOSS UI. Targeted backend synchronizations continuously poll for changes at the device model layer to:

Note

License management for Microsoft users is available only when Enable Microsoft User License Enforcement is set to True (Yes) in Global Settings (User settings). When enabled, users can be added only if sufficient license allocation exists for their hierarchy.

To access the flowcharts, view the topic via the release documentation at: https://documentation.voss-solutions.com/automate.html

Related topics

Microsoft Overview in the Core Feature Guide

Configuration and Sync for Microsoft Services in the Core Feature Guide

Sync to Site with Flow Through in the Core Feature Guide

Microsoft Exchange in the Core Feature Guide

View and edit Microsoft users

View a summary list of all Microsoft users

This procedure displays a list of Microsoft users at the selected hierarchy.

  1. Log in to the VOSS Admin Portal.

  2. Choose the hierarchy.

  3. Go to the Microsoft User Details page.

  4. View a summary of Microsoft users at the current hierarchy.

    The list view shows the following details for each user:

    • User Principal Name (UPN)
    • First and last name
    • Whether the user is licensed (Is Licensed, True or False)
    • Account enabled status (Microsoft Entra account, True or False)
    • Assigned licenses (Licenses Summary)
    • Department
    • Employee ID and Employee Type
    • City, country, phone number, office, company name
    • User type
    • Location (hierarchy)
    • Associated device

    From the list view you can click on a user to open their settings, or select one or more users to apply bulk actions via the toolbar icons (filter, refresh, export, or move).

Related topics

View and update a Microsoft user

This procedure displays and edits details for an individual Microsoft user.

Note

This workflow applies to Microsoft-only users. For Cisco-Microsoft hybrid users, use the hybrid multi vendor actions. The Hybrid Status Message field displays the user's hybrid state. See Cisco-Microsoft Hybrid Users

  1. Log in to the VOSS Admin Portal.

  2. Select the required hierarchy.

  3. Go to the Microsoft User Details.

  4. Click on a user in the list to open their settings.

  5. Select a tab (or panel) to view and update settings:

    Note

    VOSS supports either a tab or panel layout via a toolbar button. The tabs/panels that display depend on enabled functionality.

Related topics

Microsoft user details (tab/panels)

This section describes Microsoft user settings available via Microsoft User Details:

Related Topics

Microsoft Exchange in the Core Feature Guide

User account enabled state

The read-only AccountEnabled attribute indicates whether a Microsoft Entra ID (Azure AD) user account is enabled. This value is synced from Microsoft and cannot be modified in VOSS.

VOSS uses this attribute to determine whether a user should be included in analytics reporting, and license optimization workflows:

Migration behavior

To avoid excessive resynchronization and performance impact during upgrades, AccountEnabled defaults to True during migration. After synchronization completes:

Manage a user's MS Teams policies

This procedure updates Microsoft Teams policies assigned to an individual user.

Note

Some policies support full CRUD (create, update, delete) operations in VOSS. This workflow applies to Microsoft-only users.

  1. Go to the Microsoft User Details.
  2. Select a user.
  3. Open the MS Teams tab.
  4. Review currently applied policies.
  5. Select alternative policies from the drop-down lists as required.
  6. Save your changes.

Policy updates are synced back to Microsoft during an overbuild or synchronization.

Related topics

Licensing for Microsoft users

Overview

This section describes how licensing is applied, enforced, and managed for Microsoft users in VOSS

VOSS supports assigning, modifying, and removing Microsoft licenses for users as part of onboarding, offboarding, and ongoing user management.

To enable license management:

When license management is enabled:

Licensing during onboarding and offboarding

Important

VOSS requires the LicenseAssignment permission to manage Microsoft licenses.

Group-based and direct licensing behavior

This behavior applies across onboarding, updates, and offboarding workflows.

Licensing via Quick Add Groups and Flow Through Provisioning

Licensing by group membership can be configured:

VOSS provides reference configuration templates:

Best practice is to use separate Quick Add Groups for onboarding and offboarding to avoid overlapping add/remove behavior.

Related topics

Configuration Templates (Core Feature Guide)

Configuration templates for MS groups

VOSS provides reference configuration templates that control Microsoft group membership during onboarding, offboarding, and flow through provisioning. These templates can be cloned to a hierarchy, renamed, and modified to customize the group membership changes applied by an operation.

The templates are available on the Configuration Templates page. The menu and model associated with the configuration templates is view/MsGraphManageGroup.

The following reference templates are provided:

Group names must be entered manually. Available groups can be inspected via the Groups page. If Microsoft licenses are associated with a group, they are applied or removed according to the configuration template Operation setting.

For cloned templates, the User and Operation values do not need to be modified if the original template behavior is to be preserved.

Important

Do not select both Add and Remove configuration templates containing the same group list when creating a Quick Add Group. Doing so results in the same group being added and removed in a single operation.

Best practice is to define separate Quick Add Groups for onboarding and offboarding, each containing only the required configuration templates.

In scenarios where a fixed set of groups must be enforced for both onboarding and offboarding, templates can be combined deliberately to achieve the desired outcome.

These configuration templates can be applied to Quick Add Groups for use in on-boarding, off-boarding, and flow-through provisioning workflows.

Related topics

Configuration Templates (Core Feature Guide)

View a user's Microsoft licenses

To view a user's licensing details:

  1. Go to the Manage Users list.
  2. Select a user.
  3. View the user's currently enabled licenses in the Microsoft 03658 panel.

Related topics

Model Details: device/msgraph/MsolUser

Title Description Details
User Details Group Assigned by FDP
  • Field Name: User Details
  • Type: Object
User Principal Name
  • Field Name: User Details.UserPrincipalName
  • Type: String
  • MaxLength: 1024
Title
  • Field Name: User Details.Title
  • Type: String
  • MaxLength: 1024
First Name
  • Field Name: User Details.FirstName
  • Type: String
  • MaxLength: 1024
Last Name
  • Field Name: User Details.LastName
  • Type: String
  • MaxLength: 1024
Display Name
  • Field Name: User Details.DisplayName
  • Type: String
  • MaxLength: 1024
Company Name
  • Field Name: User Details.CompanyName
  • Type: String
  • MaxLength: 1024
Classification
  • Field Name: User Details.Classification
  • Type: String
  • MaxLength: 1024
User Type
  • Field Name: User Details.UserType
  • Type: String
  • MaxLength: 1024
Account Enabled Default: True
  • Field Name: User Details.AccountEnabled
  • Type: Boolean
  • Default: True
Department
  • Field Name: User Details.Department
  • Type: String
  • MaxLength: 1024
Employee Id
  • Field Name: User Details.EmployeeId
  • Type: String
  • MaxLength: 1024
Employee Type
  • Field Name: User Details.EmployeeType
  • Type: String
  • MaxLength: 1024
Proxy Addresses
  • Field Name: ProxyAddresses.[n]
  • Type: Array
Primary Smtp Address
  • Field Name: User Details.PrimarySmtpAddress
  • Type: String
  • MaxLength: 1024
Phone Number
  • Field Name: User Details.PhoneNumber
  • Type: String
  • MaxLength: 1024
Mobile Phone
  • Field Name: User Details.MobilePhone
  • Type: String
  • MaxLength: 1024
Office
  • Field Name: User Details.Office
  • Type: String
  • MaxLength: 1024
Street Address
  • Field Name: User Details.StreetAddress
  • Type: String
  • MaxLength: 1024
City
  • Field Name: User Details.City
  • Type: String
  • MaxLength: 1024
State
  • Field Name: User Details.State
  • Type: String
  • MaxLength: 1024
Postal Code
  • Field Name: User Details.PostalCode
  • Type: String
  • MaxLength: 1024
Country
  • Field Name: User Details.Country
  • Type: String
  • MaxLength: 1024
Usage Location Country code, eg. US
  • Field Name: User Details.UsageLocation
  • Type: String
  • MaxLength: 1024
  • Choices: ["Afghanistan", "Åland Islands", "Albania", "Algeria", "American Samoa", "Andorra", "Angola", "Anguilla", "Antarctica", "Antigua and Barbuda", "Argentina", "Armenia", "Aruba", "Australia", "Austria", "Azerbaijan", "Bahamas, The", "Bahrain", "Bangladesh", "Barbados", "Belarus", "Belgium", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bonaire, Saint Eustatius and Saba", "Bosnia and Herzegovina", "Botswana", "Bouvet Island", "Brazil", "British Indian Ocean Territory", "Brunei", "Bulgaria", "Burkina Faso", "Burundi", "Cabo Verde", "Cambodia", "Cameroon", "Canada", "Cayman Islands", "Central African Republic", "Chad", "Chile", "China", "Christmas Island", "Cocos (Keeling) Islands", "Colombia", "Comoros", "Congo", "Congo (DRC)", "Cook Islands", "Costa Rica", "Côte d’Ivoire", "Croatia", "Curaçao", "Cyprus", "Czech Republic", "Denmark", "Djibouti", "Dominica", "Dominican Republic", "Ecuador", "Egypt", "El Salvador", "Equatorial Guinea", "Eritrea", "Estonia", "Ethiopia", "Falkland Islands (Islas Malvinas)", "Faroe Islands", "Fiji Islands", "Finland", "France", "French Guiana", "French Polynesia", "French Southern and Antarctic Lands", "Gabon", "Gambia, The", "Georgia", "Germany", "Ghana", "Gibraltar", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guernsey", "Guinea", "Guinea-Bissau", "Guyana", "Haiti", "Heard Island and McDonald Islands", "Holy See (Vatican City State)", "Honduras", "Hong Kong SAR", "Hungary", "Iceland", "India", "Indonesia", "Iraq", "Ireland", "Isle of Man", "Israel", "Italy", "Jamaica", "Japan", "Jersey", "Jordan", "Kazakhstan", "Kenya", "Kiribati", "Korea, Republic of", "Kuwait", "Kyrgyzstan", "Laos", "Latvia", "Lebanon", "Lesotho", "Liberia", "Libya", "Liechtenstein", "Lithuania", "Luxembourg", "Macao SAR", "Macedonia, Former Yugoslav Republic of", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Marshall Islands", "Martinique", "Mauritania", "Mauritius", "Mayotte", "Mexico", "Micronesia", "Moldova", "Monaco", "Mongolia", "Montenegro", "Montserrat", "Morocco", "Mozambique", "Myanmar", "Namibia", "Nauru", "Nepal", "Netherlands", "Netherlands Antilles (Former)", "New Caledonia", "New Zealand", "Nicaragua", "Niger", "Nigeria", "Niue", "Norfolk Island", "Northern Mariana Islands", "Norway", "Oman", "Pakistan", "Palau", "Palestinian Authority", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Pitcairn Islands", "Poland", "Portugal", "Puerto Rico", "Qatar", "Reunion", "Romania", "Russia", "Rwanda", "Saint Barthélemy", "Saint Helena, Ascension and Tristan da Cunha", "Saint Kitts and Nevis", "Saint Lucia", "Saint Martin", "Saint Pierre and Miquelon", "Saint Vincent and the Grenadines", "Samoa", "San Marino", "São Tomé and Príncipe", "Saudi Arabia", "Senegal", "Serbia", "Seychelles", "Sierra Leone", "Singapore", "Sint Maarten", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "South Georgia and the South Sandwich Islands", "South Sudan", "Spain", "Sri Lanka", "Suriname", "Svalbard and Jan Mayen Island", "Swaziland", "Sweden", "Switzerland", "Taiwan", "Tajikistan", "Tanzania", "Thailand", "Timor-Leste", "Togo", "Tokelau", "Tonga", "Trinidad and Tobago", "Tunisia", "Turkey", "Turkmenistan", "Turks and Caicos Islands", "Tuvalu", "U.S. Minor Outlying Islands", "Uganda", "Ukraine", "United Arab Emirates", "United Kingdom", "United States", "Uruguay", "Uzbekistan", "Vanuatu", "Venezuela", "Vietnam", "Virgin Islands, British", "Virgin Islands, U.S.", "Wallis and Futuna", "Western Sahara", "Yemen", "Zambia", "Zimbabwe"]
Licenses Summary
  • Field Name: User Details.DisplayLicenses
  • Type: String
  • MaxLength: 1024
On Premises Extension Attributes Group Assigned by FDP
  • Field Name: On Premises Extension Attributes
  • Type: Object
Extension Attribute 1 Extension Attribute 1
  • Field Name: On Premises Extension Attributes.extensionAttribute1
  • Type: String
  • MaxLength: 1024
Extension Attribute 2 Extension Attribute 2
  • Field Name: On Premises Extension Attributes.extensionAttribute2
  • Type: String
  • MaxLength: 1024
Extension Attribute 3 Extension Attribute 3
  • Field Name: On Premises Extension Attributes.extensionAttribute3
  • Type: String
  • MaxLength: 1024
Extension Attribute 4 Extension Attribute 4
  • Field Name: On Premises Extension Attributes.extensionAttribute4
  • Type: String
  • MaxLength: 1024
Extension Attribute 5 Extension Attribute 5
  • Field Name: On Premises Extension Attributes.extensionAttribute5
  • Type: String
  • MaxLength: 1024
Extension Attribute 6 Extension Attribute 6
  • Field Name: On Premises Extension Attributes.extensionAttribute6
  • Type: String
  • MaxLength: 1024
Extension Attribute 7 Extension Attribute 7
  • Field Name: On Premises Extension Attributes.extensionAttribute7
  • Type: String
  • MaxLength: 1024
Extension Attribute 8 Extension Attribute 8
  • Field Name: On Premises Extension Attributes.extensionAttribute8
  • Type: String
  • MaxLength: 1024
Extension Attribute 9 Extension Attribute 9
  • Field Name: On Premises Extension Attributes.extensionAttribute9
  • Type: String
  • MaxLength: 1024
Extension Attribute 10 Extension Attribute 10
  • Field Name: On Premises Extension Attributes.extensionAttribute10
  • Type: String
  • MaxLength: 1024
Extension Attribute 11 Extension Attribute 11
  • Field Name: On Premises Extension Attributes.extensionAttribute11
  • Type: String
  • MaxLength: 1024
Extension Attribute 12 Extension Attribute 12
  • Field Name: On Premises Extension Attributes.extensionAttribute12
  • Type: String
  • MaxLength: 1024
Extension Attribute 13 Extension Attribute 13
  • Field Name: On Premises Extension Attributes.extensionAttribute13
  • Type: String
  • MaxLength: 1024
Extension Attribute 14 Extension Attribute 14
  • Field Name: On Premises Extension Attributes.extensionAttribute14
  • Type: String
  • MaxLength: 1024
Extension Attribute 15 Extension Attribute 15
  • Field Name: On Premises Extension Attributes.extensionAttribute15
  • Type: String
  • MaxLength: 1024
Licenses Group Assigned by FDP
  • Field Name: Licenses
  • Type: Object
Is Licensed
  • Field Name: Licenses.IsLicensed
  • Type: String
  • MaxLength: 1024
  • Choices: ["True", "False"]
Licenses
  • Field Name: Licenses.[n]
  • Type: Array
License License Name (SKU Part Name)
  • Field Name: Licenses.Licenses.[n].SkuFriendlyName
  • Type: String
  • Target: device/msgraph/MsolAccountSku
  • Target attr: SkuFriendlyName
  • MaxLength: 1024
  • Format: uri
SKU Part Number
  • Field Name: Licenses.Licenses.[n].AccountSkuId
  • Type: String
  • Target: device/msgraph/MsolAccountSku
  • Target attr: SkuPartNumber
  • MaxLength: 1024
  • Format: uri
Service Plans
  • Field Name: ServicePlans.[n]
  • Type: Array
Service Plan Service Plan Name
  • Field Name: Licenses.Licenses.[n].ServicePlans.[n].ServiceFriendlyName
  • Type: String
  • MaxLength: 1024
Service Name
  • Field Name: Licenses.Licenses.[n].ServicePlans.[n].ServiceName
  • Type: String
  • MaxLength: 1024
Enabled
  • Field Name: Licenses.Licenses.[n].ServicePlans.[n].Enabled
  • Type: Boolean