Get-EntraUserExtension

Module:: Microsoft.Entra

Gets a user's extension.

Syntax

Get-EntraUserExtension
   -UserId <String>
   [-Property <String[]>]
   [-IsSyncedFromOnPremises <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Get-EntraUserExtension cmdlet retrieves extensions for a user in Microsoft Entra ID.

Examples

Example 1: Retrieve extension attributes for a user

Connect-Entra -Scopes 'User.Read.All'
Get-EntraUserExtension -UserId 'SawyerM@contoso.com'

id                          : aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb
userPrincipalName           : sawyerm@contoso.com
employeeId                  :
identities                  : {@{signInType=userPrincipalName; issuer=contoso.com; issuerAssignedId=sawyerm@contoso.com}}
onPremisesDistinguishedName :
createdDateTime             : 3/7/2024 12:34:59 AM
userIdentities              : {@{signInType=userPrincipalName; issuer=contoso.com; issuerAssignedId=sawyerm@contoso.com}}

This example shows how to retrieve the extension attributes for a specified user.

-UserId parameter specifies the user object ID.

Example 2: Retrieve extension attributes for a user synced from on-premises

Connect-Entra -Scopes 'User.Read.All'
Get-EntraUserExtension -UserId 'SawyerM@contoso.com' -IsSyncedFromOnPremises $true

id                          : aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb
userPrincipalName           : sawyerm@contoso.com
employeeId                  :
identities                  : {@{signInType=userPrincipalName; issuer=contoso.com; issuerAssignedId=sawyerm@contoso.com}}
onPremisesDistinguishedName :
createdDateTime             : 3/7/2024 12:34:59 AM
userIdentities              : {@{signInType=userPrincipalName; issuer=contoso.com; issuerAssignedId=sawyerm@contoso.com}}

This example shows how to retrieve the extension attributes for a specified user whose extensions are synced from on-premises.

-UserId parameter specifies the user object ID.

Parameters

-IsSyncedFromOnPremises

Filter to only show user's extensions synced from on-premises.

Type:	System.String
Aliases:	Select
Position:	Named
Default value:	None
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

-UserId

Specifies the ID of an object.

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

Share via