Edit

Share via

Get-EntraUserAdministrativeUnit

  • Reference
Module:
Microsoft.Entra

Retrieves the list of administrative units a user belongs to.

Syntax

Get-EntraUserAdministrativeUnit
   -UserId <String>
   [-All]
   [-Top <Int32>]
   [-Property <String[]>]
   [<CommonParameters>]
Get-EntraUserAdministrativeUnit
   -UserId <String>
   -AdministrativeUnitId <String>
   [-Property <String[]>]
   [<CommonParameters>]

Description

The Get-EntraUserAdministrativeUnit cmdlet retrieves a list of administrative units to which a user belongs.

Examples

Example 1: Get a list of administrative units to which a specific user belongs

Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
Get-EntraUserAdministrativeUnit -UserId '[email protected]'

DeletedDateTime Id                                   Description                            DisplayName             Visibility
--------------- --                                   -----------                            -----------             ----------
                dddddddd-3333-4444-5555-eeeeeeeeeeee Pacific Administrative Unit            Pacific Admin Unit
                aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Engineering Administrative Unit        Engineering Admin Unit

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

Example 2: Get a list of administrative units to which a specific user belongs using the All parameter

Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
Get-EntraUserAdministrativeUnit -UserId '[email protected]' -All

DeletedDateTime Id                                   Description                            DisplayName             Visibility
--------------- --                                   -----------                            -----------             ----------
                dddddddd-3333-4444-5555-eeeeeeeeeeee Pacific Administrative Unit            Pacific Admin Unit
                aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Engineering Administrative Unit        Engineering Admin Unit

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

Example 3: Get an administrative unit to which a specific user belongs

Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
Get-EntraUserAdministrativeUnit -UserId '[email protected]' -Top 1

DeletedDateTime Id                                   Description                            DisplayName             Visibility
--------------- --                                   -----------                            -----------             ----------
                dddddddd-3333-4444-5555-eeeeeeeeeeee Pacific Administrative Unit            Pacific Admin Unit
                aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Engineering Administrative Unit        Engineering Admin Unit

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

Example 4: Get a list of administrative units to which a specific user belongs using the Administrative Unit ID parameter

Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
$administrativeUnit = Get-EntraAdministrativeUnit -Filter "DisplayName eq 'Pacific Admin Unit'"
Get-EntraUserAdministrativeUnit -UserId '[email protected]' -AdministrativeUnitId $administrativeUnit.Id

DeletedDateTime Id                                   Description                            DisplayName             Visibility
--------------- --                                   -----------                            -----------             ----------
                dddddddd-3333-4444-5555-eeeeeeeeeeee Pacific Administrative Unit            Pacific Admin Unit

This cmdlet retrieves a list of administrative units to which a specific user belongs using the Administrative Unit ID parameter.

  • -AdministrativeUnitId parameter specifies the administrative unit ID.

Parameters

-AdministrativeUnitId

The unique ID of the administrative unit.

Type:System.String
Aliases:DirectoryObjectId
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-All

List all pages.

Type:System.Management.Automation.SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Property

Specifies properties to be returned

Type:System.String[]
Aliases:Select
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Top

The maximum number of administrative units a user belongs to.

Type:System.Int32
Aliases:Limit
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-UserId

Specifies the ID of a user (as a UserPrincipalName or ObjectId) in Microsoft Entra ID.

Type:System.String
Aliases:ObjectId, UPN, Identity, UserPrincipalName
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Outputs

System.Object