Get-EntraUserGroup

Module:

Microsoft.Entra.Users Module v1.3

Retrieves the list of groups a user belongs to.

Get-EntraUserGroup

 -UserId <String>
 [-All]
 [-Filter <String>]
 [-Top <Int32>]
 [-Property <String[]>]
 [<CommonParameters>]

Get-EntraUserGroup

 -UserId <String>
 -GroupId <String>
 [<CommonParameters>]

Get-EntraUserGroup

 -UserId <String>
 -Property <String[]>
 -AppendSelected
 [-All]
 [-Filter <String>]
 [-Top <Int32>]
 [<CommonParameters>]

The Get-EntraUserGroup cmdlet retrieves a list of groups to which a user belongs.

Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
Get-EntraUserGroup -UserId 'SawyerM@contoso.com'

DisplayName Id MailNickname Description GroupTypes
----------- -- ------------ ----------- ----------
Contoso Marketing hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq ContosoMarketing Contoso Marketing {Unified}
Mark 8 Project Team pppppppp-4444-0000-8888-yyyyyyyyyyyy Mark8ProjectTeam Mark 8 Project Team {Unified}
Leadership tttttttt-0000-3333-9999-mmmmmmmmmmmm Leadership Leadership {Unified}
Sales and Marketing qqqqqqqq-5555-0000-1111-hhhhhhhhhhhh SalesAndMarketing Sales and Marketing {Unified}
Retail aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Retail Retail {Unified}

This cmdlet retrieves a list of groups to which a specific user belongs.

Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
Get-EntraUserGroup -UserId 'SawyerM@contoso.com' -All

DisplayName Id MailNickname Description GroupTypes
----------- -- ------------ ----------- ----------
Contoso Marketing hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq ContosoMarketing Contoso Marketing {Unified}
Mark 8 Project Team pppppppp-4444-0000-8888-yyyyyyyyyyyy Mark8ProjectTeam Mark 8 Project Team {Unified}
Leadership tttttttt-0000-3333-9999-mmmmmmmmmmmm Leadership Leadership {Unified}
Sales and Marketing qqqqqqqq-5555-0000-1111-hhhhhhhhhhhh SalesAndMarketing Sales and Marketing {Unified}
Retail aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Retail Retail {Unified}

This cmdlet retrieves a list of groups to which a specific user belongs using the All parameter.

Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
Get-EntraUserGroup -UserId 'SawyerM@contoso.com' -Top 1

DisplayName Id MailNickname Description GroupTypes
----------- -- ------------ ----------- ----------
Contoso Marketing hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq ContosoMarketing Contoso Marketing {Unified}

This cmdlet retrieves a group to which a specific user belongs. You can use -Limit as an alias for -Top.

Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
$group = Get-EntraGroup -Filter "DisplayName eq 'Contoso Marketing'"
Get-EntraUserGroup -UserId 'SawyerM@contoso.com' -GroupId $group.Id

DisplayName Id MailNickname Description GroupTypes
----------- -- ------------ ----------- ----------
Contoso Marketing hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq ContosoMarketing Contoso Marketing {Unified}

This cmdlet retrieves a list of groups to which a specific user belongs using the group ID parameter.

• -GroupId parameter specifies the group ID.

Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
Get-EntraUserGroup -UserId 'SawyerM@contoso.com' -Property id,displayName,mailNickName -Debug | Select-Object displayName,id,mailNickName

DisplayName Id MailNickname
----------- -- ------------
Contoso Marketing hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq ContosoMarketing
Contoso Sales qqqqqqqq-5555-0000-1111-hhhhhhhhhhhh ContosoSales
Contoso Digital aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb ContosoDigital

This cmdlet returns specific properties in the list of groups to which a specific user belongs to.

Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
Get-EntraUserGroup -UserId 'SawyerM@contoso.com' -Property AssignedLabels -AppendSelected | Select-Object id,displayName,createdDateTime,deletedDateTime,groupTypes,mailEnabled,mailNickname,securityEnabled,visibility,description,AssignedLabels

Id : hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq
DisplayName : Contoso Marketing
CreatedDateTime : 22/08/2024 03:02:41
DeletedDateTime :
GroupTypes : {Unified}
MailEnabled : True
MailNickname : ContosoMarketing
SecurityEnabled : False
Visibility : Public
Description :
AssignedLabels : {TagA,TagB}

Id : qqqqqqqq-5555-0000-1111-hhhhhhhhhhhh
DisplayName : Contoso Sales
CreatedDateTime : 22/08/2024 06:18:23
DeletedDateTime :
GroupTypes : {Unified}
MailEnabled : True
MailNickname : ContosoSales
SecurityEnabled : False
Visibility : Public
Description : Description of Contoso Sales
AssignedLabels : {TagA,TagB}

Id : aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb
DisplayName : Contoso Digital
CreatedDateTime : 22/08/2024 06:20:00
DeletedDateTime :
GroupTypes : {Unified}
MailEnabled : True
MailNickname : ContosoDigital
SecurityEnabled : False
Visibility : Public
Description : Description of Contoso Digital
AssignedLabels : {TagA,TagB}

We only selected one property using the Property parameter, but the response has more properties since AppendSelected parameter appended default properties to the selected properties.

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