Table of Contents

Get-PnPUserProfileProperty

SYNOPSIS

Required Permissions

  • SharePoint: Access to the SharePoint Tenant Administration site

You must connect to the tenant admin website (https://<tenant>-admin.sharepoint.com) with Connect-PnPOnline in order to use this cmdlet.

SYNTAX

Get-PnPUserProfileProperty -Account <String[]> [-Properties <String[]>] [-Verbose] [-Connection <PnPConnection>]

DESCRIPTION

Requires a connection to a SharePoint Tenant Admin site.

EXAMPLES

EXAMPLE 1

Get-PnPUserProfileProperty -Account 'user@domain.com'

Returns the profile properties for the specified user

EXAMPLE 2

Get-PnPUserProfileProperty -Account 'user@domain.com','user2@domain.com'

Returns the profile properties for the specified users

EXAMPLE 3

Get-PnPUserProfileProperty -Account 'user@domain.com' -Properties 'FirstName','LastName'

Returns the FirstName and LastName profile properties for the specified user

PARAMETERS

-Account

The account of the user, formatted either as a login name, or as a claims identity, e.g. i:0#.f|membership|user@domain.com

Type: String[]
Parameter Sets: (All)

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Properties

The user profile properties that are requested for the user e.g. FirstName, LastName etc.

Type: String[]
Parameter Sets: (All)

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

-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type: PnPConnection
Parameter Sets: (All)

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

-Verbose

When provided, additional debug statements will be shown while executing the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)

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

Microsoft 365 Patterns and Practices