mirror of
https://github.com/admindroid-community/powershell-scripts.git
synced 2025-12-17 16:35:19 +00:00
Office 365 Users' group membership report
Office 365 Users' group membership report
This commit is contained in:
AdminDroid
parent
d3e95aa72c
commit
da2995779e
@ -2,64 +2,111 @@
|
||||
=============================================================================================
|
||||
Name: Office365 User Membership Report Using PowerShell
|
||||
Description: This script exports Office 365 user's group details to CSV
|
||||
Version: 1.0
|
||||
Version: 3.0
|
||||
Website: o365reports.com
|
||||
Script by: O365Reports Team
|
||||
For detailed script execution:https://o365reports.com/2021/04/15/export-office-365-groups-a-user-is-member-of-using-powershell/
|
||||
For detailed script execution:https://o365reports.com/2021/04/15/export-office-365-groups-a-user-is-member-of-using-powershell
|
||||
============================================================================================
|
||||
#>
|
||||
|
||||
param
|
||||
(
|
||||
[string] $UserName = $null,
|
||||
[string] $Password = $null,
|
||||
[String] $UsersIdentityFile,
|
||||
[Switch] $GuestUsersOnly,
|
||||
[Switch] $DisabledUsersOnly,
|
||||
[Switch] $UsersNotinAnyGroup
|
||||
[Switch] $UsersNotinAnyGroup,
|
||||
[string] $TenantId,
|
||||
[string] $ClientId,
|
||||
[string] $CertificateThumbprint
|
||||
)
|
||||
|
||||
$MsGraphModule = Get-Module Microsoft.Graph -ListAvailable
|
||||
if($MsGraphModule -eq $null)
|
||||
{
|
||||
Write-host "Important: Microsoft graph module is unavailable. It is mandatory to have this module installed in the system to run the script successfully."
|
||||
$confirm = Read-Host Are you sure you want to install Microsoft graph module? [Y] Yes [N] No
|
||||
if($confirm -match "[yY]")
|
||||
{
|
||||
Write-host "Installing Microsoft graph module..."
|
||||
Install-Module Microsoft.Graph -Scope CurrentUser
|
||||
Write-host "Microsoft graph module is installed in the machine successfully" -ForegroundColor Magenta
|
||||
}
|
||||
else
|
||||
{
|
||||
Write-host "Exiting. `nNote: Microsoft graph module must be available in your system to run the script" -ForegroundColor Red
|
||||
Exit
|
||||
}
|
||||
}
|
||||
if(($TenantId -ne "") -and ($ClientId -ne "") -and ($CertificateThumbprint -ne ""))
|
||||
{
|
||||
Connect-MgGraph -TenantId $TenantId -AppId $ClientId -CertificateThumbprint $CertificateThumbprint -ErrorAction SilentlyContinue -ErrorVariable ConnectionError|Out-Null
|
||||
if($ConnectionError -ne $null)
|
||||
{
|
||||
Write-Host $ConnectionError -Foregroundcolor Red
|
||||
Exit
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
Connect-MgGraph -Scopes "Directory.Read.All" -ErrorAction SilentlyContinue -Errorvariable ConnectionError |Out-Null
|
||||
if($ConnectionError -ne $null)
|
||||
{
|
||||
Write-Host "$ConnectionError" -Foregroundcolor Red
|
||||
Exit
|
||||
}
|
||||
}
|
||||
Write-Host "Microsoft Graph Powershell module is connected successfully" -ForegroundColor Green
|
||||
Select-MgProfile beta
|
||||
Function UserDetails {
|
||||
if ([string]$UsersIdentityFile -ne "") {
|
||||
|
||||
if ([string]$UsersIdentityFile -ne "")
|
||||
{
|
||||
$IdentityList = Import-Csv -Header "UserIdentityValue" $UsersIdentityFile
|
||||
foreach ($IdentityValue in $IdentityList) {
|
||||
foreach ($IdentityValue in $IdentityList)
|
||||
{
|
||||
$CurIdentity = $IdentityValue.UserIdentityValue
|
||||
try {
|
||||
$LiveUser = Get-AzureADUser -ObjectId "$CurIdentity" -ErrorAction SilentlyContinue
|
||||
if ($GuestUsersOnly.IsPresent -and $LiveUser.UserType -ne "Guest") {
|
||||
try
|
||||
{
|
||||
$LiveUser = Get-MgUser -UserId "$CurIdentity" -ExpandProperty MemberOf -ErrorAction SilentlyContinue
|
||||
if($GuestUsersOnly.IsPresent -and $LiveUser.UserType -ne "Guest")
|
||||
{
|
||||
continue
|
||||
}
|
||||
if ($DisabledUsersOnly.IsPresent -and $LiveUser.AccountEnabled -eq $true) {
|
||||
if($DisabledUsersOnly.IsPresent -and $LiveUser.AccountEnabled -eq $true)
|
||||
{
|
||||
continue
|
||||
}
|
||||
ProcessUser
|
||||
}
|
||||
catch {
|
||||
catch
|
||||
{
|
||||
Write-Host Given UserIdentity: $CurIdentity is not valid/found.
|
||||
}
|
||||
}
|
||||
}
|
||||
else {
|
||||
if ($GuestUsersOnly.Ispresent -and $DisabledUsersOnly.Ispresent) {
|
||||
Get-AzureADUser -Filter "UserType eq 'Guest'" | Where-Object { $_.AccountEnabled -eq $false } | ForEach-Object {
|
||||
else
|
||||
{
|
||||
if ($GuestUsersOnly.Ispresent -and $DisabledUsersOnly.Ispresent)
|
||||
{
|
||||
Get-MgUser -Filter "UserType eq 'Guest'" -ExpandProperty MemberOf -All| Where-Object { $_.AccountEnabled -eq $false } | ForEach-Object {
|
||||
$LiveUser = $_
|
||||
ProcessUser
|
||||
}
|
||||
}
|
||||
elseif ($DisabledUsersOnly.Ispresent) {
|
||||
Get-AzureADUser | Where-Object { $_.AccountEnabled -eq $false } | ForEach-Object {
|
||||
elseif ($DisabledUsersOnly.Ispresent)
|
||||
{
|
||||
Get-MgUser -ExpandProperty MemberOf -All| Where-Object { $_.AccountEnabled -eq $false } | ForEach-Object {
|
||||
$LiveUser = $_
|
||||
ProcessUser
|
||||
}
|
||||
}
|
||||
elseif ($GuestUsersOnly.Ispresent) {
|
||||
Get-AzureADUser -Filter "UserType eq 'Guest'" | ForEach-Object {
|
||||
elseif ($GuestUsersOnly.Ispresent)
|
||||
{
|
||||
Get-MgUser -Filter "UserType eq 'Guest'" -ExpandProperty MemberOf -All| ForEach-Object {
|
||||
$LiveUser = $_
|
||||
ProcessUser
|
||||
}
|
||||
}
|
||||
else {
|
||||
Get-AzureADUser -All:$true | ForEach-Object {
|
||||
else
|
||||
{
|
||||
Get-MgUser -ExpandProperty MemberOf -All | ForEach-Object {
|
||||
$LiveUser = $_
|
||||
ProcessUser
|
||||
}
|
||||
@ -68,108 +115,81 @@ Function UserDetails {
|
||||
}
|
||||
Function ProcessUser {
|
||||
$GroupList = @()
|
||||
$Roles = @()
|
||||
$global:ProcessedUsers = $global:ProcessedUsers + 1
|
||||
$UPN = $LiveUser.UserPrincipalName
|
||||
$ObjectId = $LiveUser.ObjectId.ToString()
|
||||
$RolesList = @()
|
||||
$Script:ProcessedUsers += 1
|
||||
$Name = $LiveUser.DisplayName
|
||||
Write-Progress -Activity "Processing $Name" -Status "Processed Users Count: $global:ProcessedUsers"
|
||||
$UserMembership = Get-AzureADUserMembership -ObjectId $ObjectId
|
||||
|
||||
$AllGroupData = $UserMembership | Where-object { $_.ObjectType -eq "Group" }
|
||||
if ($null -eq $AllGroupData) {
|
||||
Write-Progress -Activity "Processing $Name" -Status "Processed Users Count: $Script:ProcessedUsers"
|
||||
$UserMembership = Get-MgUserMemberOf -UserId $LiveUser.UserPrincipalName |Select-Object -ExpandProperty AdditionalProperties
|
||||
$AllGroupData = $UserMembership | Where-object { $_.'@odata.type' -eq "#microsoft.graph.group" }
|
||||
if ($AllGroupData -eq $null)
|
||||
{
|
||||
$GroupName = " - "
|
||||
}
|
||||
else {
|
||||
if ($UsersNotinAnyGroup.IsPresent) {
|
||||
else
|
||||
{
|
||||
if ($UsersNotinAnyGroup.IsPresent)
|
||||
{
|
||||
return
|
||||
}
|
||||
$AllGroupData | Select-Object DisplayName | ForEach-Object {
|
||||
$GroupList += $_.DisplayName -join ","
|
||||
$GroupName = ($GroupList -join ",")
|
||||
}
|
||||
$GroupName = (@($AllGroupData.displayName) -join ',')
|
||||
}
|
||||
$AllRoles = $UserMembership | Where-object { $_.ObjectType -eq "Role" } | Select-Object DisplayName
|
||||
if ($null -eq $AllRoles) {
|
||||
$AllRoles = $UserMembership | Where-object { $_.'@odata.type' -eq "#microsoft.graph.directoryRole" }
|
||||
if ($AllRoles -eq $null) {
|
||||
$RolesList = " - "
|
||||
}
|
||||
else {
|
||||
$AllRoles | ForEach-Object {
|
||||
$Roles += $_.DisplayName -join ","
|
||||
$RolesList = ($Roles -join ",")
|
||||
}
|
||||
else
|
||||
{
|
||||
$RolesList = @($AllRoles.displayName) -join ','
|
||||
}
|
||||
if ($LiveUser.AccountEnabled -eq $True) {
|
||||
if ($LiveUser.AccountEnabled -eq $True)
|
||||
{
|
||||
$AccountStatus = "Enabled"
|
||||
}
|
||||
else {
|
||||
else
|
||||
{
|
||||
$AccountStatus = "Disabled"
|
||||
}
|
||||
if ($null -eq $LiveUser.Department) {
|
||||
if ($LiveUser.Department -eq $null)
|
||||
{
|
||||
$Department = " - "
|
||||
}
|
||||
else {
|
||||
else
|
||||
{
|
||||
$Department = $LiveUser.Department
|
||||
}
|
||||
if ($LiveUser.AssignedLicenses -ne "") {
|
||||
if ($LiveUser.AssignedLicenses -ne "")
|
||||
{
|
||||
$LicenseStatus = "Licensed"
|
||||
}
|
||||
else {
|
||||
else
|
||||
{
|
||||
$LicenseStatus = "Unlicensed"
|
||||
}
|
||||
ExportResults
|
||||
}
|
||||
Function ExportResults {
|
||||
$global:ExportedUsers = $global:ExportedUsers + 1
|
||||
$ExportResult = @{'Display Name' = $Name; 'Email Address' = $UPN; 'Group Name(s)' = $GroupName; 'License Status' = $LicenseStatus; 'Account Status' = $AccountStatus;'Department' = $Department;'Admin Roles' = $RolesList }
|
||||
$ExportResults = New-Object PSObject -Property $ExportResult
|
||||
$ExportResults | Select-Object 'Display Name', 'Email Address', 'Group Name(s)', 'License Status', 'Account Status', 'Department', 'Admin Roles' | Export-csv -path $ExportCSVFileName -NoType -Append
|
||||
$Script:ExportedUsers += 1
|
||||
$ExportResult = [PSCustomObject] @{'Display Name' = $Name; 'Email Address' = $LiveUser.UserPrincipalName; 'Group Name(s)' = $GroupName; 'License Status' = $LicenseStatus; 'Account Status' = $AccountStatus;'Department' = $Department;'Admin Roles' = $RolesList }
|
||||
$ExportResult | Export-csv -path $ExportCSVFileName -NoType -Append
|
||||
}
|
||||
Function Connection {
|
||||
$AzureAd = (Get-Module AzureAD -ListAvailable).Name
|
||||
if ($Empty -eq $AzureAd) {
|
||||
Write-host "Mandatory module is unavailable: Install AzureAd module to run the script successfully. Please choose (Y or y) to say Yes"
|
||||
$confirm = Read-Host Are you sure you want to install module? [Y] Yes [N] No
|
||||
if ($confirm -match "[yY]") {
|
||||
Write-host "Installing AzureAD"
|
||||
Install-Module AzureAd -Allowclobber -Repository PSGallery -Force
|
||||
Write-host "Required Module is installed in the machine Successfully"
|
||||
}
|
||||
else {
|
||||
Write-host "Exiting. `nNote:The Module AzureAD must be available in your system to run the script"
|
||||
Exit
|
||||
}
|
||||
}
|
||||
#Importing Module by default will avoid the cmdlet unrecognized error
|
||||
Import-Module AzureAd -ErrorAction SilentlyContinue -Force
|
||||
Write-Host "Connecting to AzureAD..."
|
||||
#Storing credential in script for scheduling purpose/Passing credential as parameter
|
||||
if (($UserName -ne "") -and ($Password -ne "")) {
|
||||
$SecuredPassword = ConvertTo-SecureString -AsPlainText $Password -Force
|
||||
$Credential = New-Object System.Management.Automation.PSCredential $UserName, $SecuredPassword
|
||||
Connect-AzureAD -Credential $Credential | Out-Null
|
||||
}
|
||||
else {
|
||||
Connect-AzureAD | Out-Null
|
||||
}
|
||||
}
|
||||
|
||||
Connection
|
||||
$global:ProcessedUsers = 0
|
||||
$global:ExportedUsers = 0
|
||||
$ProcessedUsers = 0
|
||||
$ExportedUsers = 0
|
||||
$ExportCSVFileName = ".\UserMembershipReport_$((Get-Date -format MMM-dd` hh-mm-ss` tt).ToString()).csv"
|
||||
UserDetails
|
||||
#Open output file after execution
|
||||
if ((Test-Path -Path $ExportCSVFileName) -eq "True") {
|
||||
Write-Progress -Activity "--" -Completed
|
||||
Write-Host "The Output result has $global:ExportedUsers users details"
|
||||
Write-Host "`nThe Output result has " -NoNewline
|
||||
Write-Host $Script:ExportedUsers Users -ForegroundColor Magenta -NoNewline
|
||||
Write-Host " details"
|
||||
Write-Host `nThe Output file available in $ExportCSVFileName -ForegroundColor Green
|
||||
$prompt = New-Object -ComObject wscript.shell
|
||||
$userInput = $prompt.popup("Do you want to open output file?", 0, "Open Output File", 4)
|
||||
If ($userInput -eq 6) {
|
||||
if ($userInput -eq 6) {
|
||||
Invoke-Item "$ExportCSVFileName"
|
||||
}
|
||||
}
|
||||
else {
|
||||
Write-Host `nNo data/user found with the specified criteria
|
||||
else
|
||||
{
|
||||
Write-Host `nNo data/user found with the specified criteria -ForegroundColor Red
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user