Set-PnPUserProfileProperty

Module:
PnP.Powershell
Applies to:
SharePoint Online

Tip

We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Set-PnPUserProfileProperty.md to change this file.

Required Permissions

  • SharePoint: Access to the SharePoint Tenant Administration site

Office365 only: Uses the tenant API to retrieve site information. You must connect to the tenant admin website (https://:-admin.sharepoint.com) with Connect-PnPOnline in order to use this command.

Syntax

Set-PnPUserProfileProperty
   -Account <String>
   -PropertyName <String>
   -Value <String>
   [-Connection <PnPConnection>]
   [<CommonParameters>]
Set-PnPUserProfileProperty
   -Account <String>
   -PropertyName <String>
   -Values <String[]>
   [-Connection <PnPConnection>]
   [<CommonParameters>]

Description

Requires a connection to a SharePoint Tenant Admin site.

Examples

EXAMPLE 1

Set-PnPUserProfileProperty -Account 'user@domain.com' -Property 'SPS-Location' -Value 'Stockholm'

Sets the SPS-Location property for the user as specified by the Account parameter

EXAMPLE 2

Set-PnPUserProfileProperty -Account 'user@domain.com' -Property 'MyProperty' -Values 'Value 1','Value 2'

Sets the MyProperty multi value property for the user as specified by the Account parameter

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
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
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PropertyName

The property to set, for instance SPS-Skills or SPS-Location

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Value

The value to set in the case of a single value property

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Values

The values set in the case of a multi value property, e.g. "Value 1","Value 2"

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False