Edit

Share via

Audit Viva Engage users in networks connected to Microsoft 365

  • Article

Your company's Viva Engage network might have users who no longer work for your company. Or, some Viva Engage users might be signing in with their email and password because they don't have a corresponding Microsoft 365 account. In order to analyze such situations and take action, you can audit your Viva Engage users. This involves exporting the list of Viva Engage users, finding the status of these Viva Engage users in Microsoft 365 by using Azure Active Directory module for Windows PowerShell, and analyzing the results and taking action.

In addition to auditing Viva Engage users, you may want to understand more about how the Viva Engage service can be seamlessly managed from Microsoft 365. For details, see Enforce Microsoft 365 identity for Viva Engage users.

Export the Viva Engage users list

Before you can run the audit script, you create an input file that contains the list of user accounts for the script to use. You create the input file by using the Export Users function in Viva Engage.

  1. In Viva Engage, select the Viva Engage settings icon , and then select Network Admin.

  2. Select Export Users.

  3. On the Export Users page, choose Export all users, and then select Export.

  4. Save the exported file. The file is saved as a compressed file with a .zip file name extension.

  5. Go to the location where you saved the compressed file and expand it.

Note

There are several files that are contained within the compressed file. You only need the file that is named users.csv.

Find status of Viva Engage users in Microsoft 365

  1. Install and configure the Azure Active Directory module for Windows PowerShell. For instructions on this, read the following document: Microsoft Entra ID Help.

  2. Copy the following sample code, paste it into a text editor like Notepad, and then save the file as UserMatchToAzureAD.ps1.

    Feel free to modify it to suit your organization's needs.

     <#Copyright 2016  Microsoft Licensed under the Apache License, Version 2.0 (the "License");  you may not use this file except in compliance with the License.  You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0  Unless required by applicable law or agreed to in writing, software  distributed under the License is distributed on an "AS IS" BASIS,  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions  and limitations under the License.  Viva Engage auditing tool for Office 365 looks for active Viva Engage accounts  that  are missing from Office 365 / Azure AD.  Takes User.csv file from Viva Engage Data Export as the input file.   Compares all Active Viva Engage accounts in the input file to user   lookup in Azure AD. User is searched by both email and proxyAddresses.   The output csv file is exactly matching the source file, but it includes  three new columns: exists_in_azure_ad, object_id and azure_licenses:  exists_in_azure_ad: Will be TRUE or FALSE, and signals that the user can be, or cannot be found in Office 365 / Azure AD  object_id: For users that can be found, lists the ObjectId in Azure AD  azure_licenses: For users that can be found, lists the plans assigned to the user in Azure AD. 

 azurepowershell

 This information can be used to double check licenses are assigned correctly for each user.  

 azurepowershell

 Params -  UseExistingConnection: Defines if the script should try to use an existing Azure AD connection. Will prompt for credentials and will start a new connection if $FALSE. Default is $FALSE  InputFile: Source CSV file of users, coming from the Viva Engage User Export tool  OutputFile: Output location to save the final CSV to  Example -  UserMatchToAzureAD.ps1 -InputFile .\Users.csv -OutputFile .\Results.csv  #> 

 azurepowershell

 Param(
 	 [bool]$UseExistingConnection = $FALSE,
 	 [string]$InputFile = ".\Users.csv",
 	 [string]$Outputfile = ".\Results.csv"
 	) 
   if(!$UseExistingConnection){
 	   Write-Host "Creating a new connection. Login with your Microsoft 365 Global Admin Credentials..."
 	   $msolcred = get-credential
 	   connect-msolservice -credential $msolcred
    }
    Write-Host "Loading all Microsoft 365 users from Azure AD. This can take a while depending on the number of users..."
    $o365usershash = @{}
    get-msoluser -All | Select userprincipalname,proxyaddresses,objectid,@{Name="licenses";Expression={$_.Licenses.AccountplanId}} | ForEach-Object {
 	   $o365usershash.Add($_.userprincipalname.ToUpperInvariant(), $_)
 	   $_.proxyaddresses | ForEach-Object {
 		   $email = ($_.ToUpperInvariant() -Replace "SMTP:(\\*)*", "").Trim()
 		   if(!$o365usershash.Contains($email))
 		   {
 			   $o365usershash.Add($email, $_)
 		   }
 	   }
    }
    Write-Host "Matching Viva Engage users to Microsoft 365 users"
    $yammerusers = Import-Csv -Path $InputFile | Where-Object {$_.state -eq "active"}
    $yammerusers | ForEach-Object {
 	   $o365user = $o365usershash[$_.email.ToUpperInvariant()]
 	   $exists_in_azure_ad = ($o365user -ne $Null)
 	   $objectid = if($exists_in_azure_ad) { $o365user.objectid } else { "" }
 	   $licenses = if($exists_in_azure_ad) { $o365user.licenses } else { "" }
 	   $_ | Add-Member -MemberType NoteProperty -Name "exists_in_azure_ad" -Value $exists_in_azure_ad
 	   $_ | Add-Member -MemberType NoteProperty -Name "azure_object_id" -Value $objectid
 	   $_ | Add-Member -MemberType NoteProperty -Name "azure_licenses" -Value $licenses
    } 
   Write-Host "Writing the output csv file..."
   $yammerusers | Export-Csv $Outputfile -NoTypeInformation 
   Write-Host "Done."

  3. From an Azure Active Directory module for Windows PowerShell command window, run the command as in the following example, passing the input file exported from Viva Engage and an output file location.

    Example usage:

     UserMatchToAzureAD.ps1 -InputFile .\Users.csv -OutputFile .\Results.csv

    For more information on how to run the script, look at the PS1 file above.

Analyze the results and take action

  1. Open the result CSV file, and filter out all the rows that show the exists_in_azure_ad column as FALSE.

    Each of them are accounts that exist in Viva Engage, but not in Microsoft 365 / Microsoft Entra ID. For each of them, decide if you need to:

    • Suspend the user account in Viva Engage if the user shouldn't have access.

    • Create the user in Microsoft 365 / Microsoft Entra ID.

  2. After you have completed these operations, we recommend that you run these steps again from the start to confirm all the users are now found in Microsoft Entra ID.

After a full audit, if you're enforcing Microsoft 365 identity, consider signing off all current users to ensure that everyone now signs in with their Microsoft 365 credentials, and not using cached credentials. If you choose to do this, make sure to communicate to your users first. More information in Enforce Microsoft 365 identity for Viva Engage users.