[Index]

Model: device/msgraph/MsolUser

Microsoft users

Full HTML Help

Tip

Use the Action search to navigate Automate

Overview

You will need to onboard Microsoft users in Automate.

Onboarding a Microsoft user involves importing users and related data to the customer level from the Microsoft Cloud service, and then moving users to the correct sites as fully provisioned users.

Automated workflows configure imported objects once changes are synced in, and apply the required configuration, policies, and licenses. This means administrators won't need to continually monitor the sync, or to perform additional steps to complete the process.

Once synced in (at the customer or site level), administrators can manage Microsoft users via a single interface and login, from within the Automate Admin Portal. To maintain data integrity, to manage licenses, and to automate number auditing for synced in users, regular, targeted backend syncs poll for changes made at the device model layer.

Note

If Enable Microsoft User License Enforcement is set to Yes in the Global Settings, a user can only be added if the license allocation limit for the user's hierarchy is not exceeded. For details, see: Microsoft license management and alerting.

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

Automate 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 summary list of Microsoft users.

  1. Log in to the Automate 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 for Microsoft users provides details for the following, for each user in the list:

    • User principal name, first name, and last name
    • Licenses
    • Department
    • City, country, phone number, location
    • Associated device

View and update a Microsoft user

This procedure displays and edits the details of a single Microsoft user.

Note

This workflow is intended for Microsoft-only users. When choosing a hybrid user with Cisco-Microsoft services, you'll need to work with this user via the Hybrid multi vendor actions. The Hybrid Status Message field displays the user's hybrid status. See Cisco-Microsoft Hybrid Users

  1. Log in to the Automate 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.

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

  6. Select a tab (or scroll to the relevant panel) to view and update settings:

    Note

    Automate allows you to toggle between a panel or tab layout via a toolbar button. The tabs/panels that display depend on enabled functionality.

    Tab/Panel Description
    MS 365 Microsoft user details, such as their display name, first and last name, User Principal Name (UPN), title, contact details, usage location, department, employee ID, employee type, and groups.
    Exchange Custom Attributes

    Read-only. Displays on the user's form only when Microsoft Exchange is installed and enabled for the user (the user has a Microsoft Exchange license), and provided values are filled out for these fields on the user's Microsoft Exchange settings in Automate.

    These are fifteen additional fields that can be used for filtering from Microsoft Entra ID using model filter criteria, and to have the values available for flow through provisioning. The same fields are also available in the Microsoft Exchange settings (when installed) in Automate.

    The fields allow more flexibility when filtering users to be imported and then moved and, optionally, processed with flow through provisioning in Automate.
    MS Licenses

    View and update the user's Microsoft license details, including their type (Group or Direct), and their licenses.

    Note

    When the license type is "Group", all license details (SKU and service plans) read-only.
    MS Teams

    The Microsoft user's MS Teams details. The fields below are read-only:

    • User status
    • Interpreted User Type
    • Country or Region
    • Feature Types
    • Line URI
    • Line Type

    On this tab you can also enable or disable Enterprise Voice for this user.

    • You can only enable Enterprise Voice for a user that has a PhoneSystem license.
    • You can only assign a number to a user that has a PhoneSystem license.
    Local User The user corresponding with this user.
  1. Save your changes.

Related Topics

Manage a user's MS Teams policies

This procedure displays and updates the policies of individual users via the user edit functionality:

Note

Some policies support full CRUD (create, update, delete) operations within Automate.

Note

This workflow is intended for Microsoft-only users. When choosing a hybrid user with Cisco-Microsoft services, you'll need to work with this user via the Hybrid multi vendor actions. The Hybrid Status Message field displays the user's hybrid status. See Cisco-Microsoft Hybrid Users

  1. Go to the Microsoft User Details page.
  2. Click on a user to open their settings.
  3. Select the MS Teams tab.
  4. View currently applied policies for the user.
  5. To choose different policies, click the down-arrow at the relevant policy, and select an alternative from the drop-down.
  6. Save your changes. Policy changes are synced back to the Microsoft cloud when performing an overbuild or a sync.

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
Title
  • Field Name: User Details.Title
  • Type: String
First Name
  • Field Name: User Details.FirstName
  • Type: String
Last Name
  • Field Name: User Details.LastName
  • Type: String
Display Name
  • Field Name: User Details.DisplayName
  • Type: String
Company Name
  • Field Name: User Details.CompanyName
  • Type: String
User Type
  • Field Name: User Details.UserType
  • Type: String
Department
  • Field Name: User Details.Department
  • Type: String
Employee Id
  • Field Name: User Details.EmployeeId
  • Type: String
Employee Type
  • Field Name: User Details.EmployeeType
  • Type: String
Proxy Addresses
  • Field Name: ProxyAddresses.[n]
  • Type: Array
Primary Smtp Address
  • Field Name: User Details.PrimarySmtpAddress
  • Type: String
Phone Number
  • Field Name: User Details.PhoneNumber
  • Type: String
Mobile Phone
  • Field Name: User Details.MobilePhone
  • Type: String
Office
  • Field Name: User Details.Office
  • Type: String
Street Address
  • Field Name: User Details.StreetAddress
  • Type: String
City
  • Field Name: User Details.City
  • Type: String
State
  • Field Name: User Details.State
  • Type: String
Postal Code
  • Field Name: User Details.PostalCode
  • Type: String
Country
  • Field Name: User Details.Country
  • Type: String
Usage Location Country code, eg. US
  • Field Name: User Details.UsageLocation
  • Type: String
  • 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
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
Extension Attribute 2 Extension Attribute 2
  • Field Name: On Premises Extension Attributes.extensionAttribute2
  • Type: String
Extension Attribute 3 Extension Attribute 3
  • Field Name: On Premises Extension Attributes.extensionAttribute3
  • Type: String
Extension Attribute 4 Extension Attribute 4
  • Field Name: On Premises Extension Attributes.extensionAttribute4
  • Type: String
Extension Attribute 5 Extension Attribute 5
  • Field Name: On Premises Extension Attributes.extensionAttribute5
  • Type: String
Extension Attribute 6 Extension Attribute 6
  • Field Name: On Premises Extension Attributes.extensionAttribute6
  • Type: String
Extension Attribute 7 Extension Attribute 7
  • Field Name: On Premises Extension Attributes.extensionAttribute7
  • Type: String
Extension Attribute 8 Extension Attribute 8
  • Field Name: On Premises Extension Attributes.extensionAttribute8
  • Type: String
Extension Attribute 9 Extension Attribute 9
  • Field Name: On Premises Extension Attributes.extensionAttribute9
  • Type: String
Extension Attribute 10 Extension Attribute 10
  • Field Name: On Premises Extension Attributes.extensionAttribute10
  • Type: String
Extension Attribute 11 Extension Attribute 11
  • Field Name: On Premises Extension Attributes.extensionAttribute11
  • Type: String
Extension Attribute 12 Extension Attribute 12
  • Field Name: On Premises Extension Attributes.extensionAttribute12
  • Type: String
Extension Attribute 13 Extension Attribute 13
  • Field Name: On Premises Extension Attributes.extensionAttribute13
  • Type: String
Extension Attribute 14 Extension Attribute 14
  • Field Name: On Premises Extension Attributes.extensionAttribute14
  • Type: String
Extension Attribute 15 Extension Attribute 15
  • Field Name: On Premises Extension Attributes.extensionAttribute15
  • Type: String
Licenses Group Assigned by FDP
  • Field Name: Licenses
  • Type: Object
Is Licensed
  • Field Name: Licenses.IsLicensed
  • Type: String
  • 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
  • Format: uri
SKU Part Number
  • Field Name: Licenses.Licenses.[n].AccountSkuId
  • Type: String
  • Target: device/msgraph/MsolAccountSku
  • Target attr: SkuPartNumber
  • 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
Service Name
  • Field Name: Licenses.Licenses.[n].ServicePlans.[n].ServiceName
  • Type: String
Enabled
  • Field Name: Licenses.Licenses.[n].ServicePlans.[n].Enabled
  • Type: Boolean