Get-ADXPrincipalGroupMembership

Namespace ADPlayground.PowerShell

Inputs

System.String[]

Outputs

ADPlayground.GroupParentEntry ADPlayground.GroupParentResult ADPlayground.Groups.GroupMembershipTreeNode

Gets group memberships (parent groups / memberOf) for the specified principal identities. Returns group parents (flattened by default) or the raw GroupParentResult.

Examples

Authored help example

Example 1: List parent groups for a user


Get-ADXPrincipalGroupMembership 'EVOTEC\\svc.veeam' | Select Name,DomainName,Nesting

Example 2: Return projected parent tree nodes


Get-ADXPrincipalGroupMembership 'EVOTEC\\svc.veeam' -AsTree -TreeDepth 4

Example 3: Return the raw parent result object


Get-ADXPrincipalGroupMembership 'EVOTEC\\svc.veeam' -Flatten:$false

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Get-ADXPrincipalGroupMembership -Identity <string[]> [-AsTree] [-Credential <PSCredential>] [-Domain <string[]>] [-First <int>] [-Flatten] [-HideProcessed] [-IncludeTrustedDomains] [-MaxCacheSize <int>] [-MaxDepth <int>] [-Scope <CurrentDomain|Forest|TrustedForests|ExplicitDomains>] [-Server <string>] [-ShowAll] [-Skip <int>] [-TimeoutSeconds <int>] [-TreeDepth <int>] [<CommonParameters>]

Parameters

Identity string[] requiredposition: 0pipeline: true (ByValue)aliases: DistinguishedName, DN, Name, PrincipalIdentity, SamAccountName, UPN, UserPrincipalName: Object identities (DN/SID/UPN/SAM).
AsTree SwitchParameter optionalposition: namedpipeline: false: Return projected parent-membership tree nodes instead of flattened parent entries.
Credential PSCredential optionalposition: namedpipeline: false: Optional credentials used for LDAP bind.
Domain string[] optionalposition: namedpipeline: falsealiases: DomainName: Optional domain DNS names used when scoped identity resolution is requested.
First int optionalposition: namedpipeline: falsealiases: Top: Returns at most the specified number of output records after -Skip.
Flatten SwitchParameter optionalposition: namedpipeline: false: Return flattened parents (default). When false, return GroupParentResult.
HideProcessed SwitchParameter optionalposition: namedpipeline: false: Hide repeated parent groups that were already expanded earlier in tree output.
IncludeTrustedDomains SwitchParameter optionalposition: namedpipeline: false: Includes trusted domains when using forest-based scopes for identity resolution.
MaxCacheSize int optionalposition: namedpipeline: false: Maximum cache size used by resolver.
MaxDepth int optionalposition: namedpipeline: false: Maximum recursion depth.
Scope DirectoryScenarioScope optionalposition: namedpipeline: falsevalues: 4: Default scope used for identity resolution when -Domain is not provided. Possible values: CurrentDomain, Forest, TrustedForests, ExplicitDomains; Possible values: CurrentDomain, Forest, TrustedForests, ExplicitDomains
Server string optionalposition: namedpipeline: falsealiases: DomainController: Optional domain controller (server) to target.
ShowAll SwitchParameter optionalposition: namedpipeline: false: Expand repeated non-circular parent groups again in tree output.
Skip int optionalposition: namedpipeline: false: Skips the specified number of output records after ordering.
TimeoutSeconds int optionalposition: namedpipeline: false: LDAP timeout in seconds.
TreeDepth int optionalposition: namedpipeline: false: Maximum displayed tree depth when using -AsTree. Use 0 for root only.

Outputs

ADPlayground.GroupParentEntry, ADPlayground.GroupParentResult, ADPlayground.Groups.GroupMembershipTreeNode