Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ps365.clidsys.com/llms.txt

Use this file to discover all available pages before exploring further.

​
SYNOPSIS

Reports on Purview RBAC roles and their effective membership, including groups expanded recursively.

​
SYNTAX

Get-PurviewRoleReport [-ShowGraph] [-ProgressAction <ActionPreference>] [<CommonParameters>]

​
DESCRIPTION

Produces a report of the membership of Purview RBAC role groups. By default, the report contains only the roles that have at least one member. When a role member is itself a group (distribution group, mail-enabled security group, dynamic distribution group, or a nested role group), its members are resolved recursively and included in the report with DirectMember set to $false and MemberViaGroup set to the name of the group that is a direct member of the role. Circular group references are detected and skipped automatically.

​
EXAMPLES

​
EXAMPLE 1

Get-PurviewRoleReport
Retrieves the Purview RBAC role report, including recursive group expansion.

​
EXAMPLE 2

Get-PurviewRoleReport | Where-Object { $_.DirectMember -eq $false } | Format-Table Role, MemberName, MemberViaGroup
Lists all users/objects resolved through group membership, showing which group is a direct member of the role.

​
EXAMPLE 3

Get-PurviewRoleReport | Export-Csv -NoTypeInformation "$(Get-Date -Format yyyyMMdd)_purviewRoles.csv" -Encoding UTF8
Exports the full report (including group-expanded members) to a CSV file.

​
PARAMETERS

​
-ShowGraph

Reserved for future use. When specified, displays a graphical representation of the role membership. 
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

​
CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

​
INPUTS

​
OUTPUTS

​
[System.Collections.Generic.List[Object]] containing PSCustomObject rows with the following properties:

​
Role, MemberName, MemberDisplayName, MemberPrimarySMTPAddres, MemberIsDirSynced,

​
MemberObjectID, MemberRecipientTypeDetails, RoleDescription, DirectMember, MemberViaGroup.

​
NOTES

Requires ExchangeOnlineManagement module and an active Connect-IPPSSession session. https://ps365.clidsys.com/docs/commands/Get-PurviewRoleReport