profiles¶

The profile services allows you to work with the SharePoint User Profile Store.

Profiles¶

Profiles is accessed directly from the root sp object.

import { spfi } from "@pnp/sp";
import "@pnp/sp/profiles";

Get edit profile link for the current user¶

getEditProfileLink(): Promise<string>

const sp = spfi(...);
const editProfileLink = await sp.profiles.getEditProfileLink();

Is My People List Public¶

Provides a boolean that indicates if the current users "People I'm Following" list is public or not

getIsMyPeopleListPublic(): Promise<boolean>

const sp = spfi(...);
const isPublic = await sp.profiles.getIsMyPeopleListPublic();

Find out if the current user is followed by another user¶

Provides a boolean that indicates if the current users is followed by a specific user.

amIFollowedBy(loginName: string): Promise<boolean>

const sp = spfi(...);
const loginName = "i:0#.f|membership|testuser@mytenant.onmicrosoft.com";
const isFollowedBy = await sp.profiles.amIFollowedBy(loginName);

Find out if I am following a specific user¶

Provides a boolean that indicates if the current users is followed by a specific user.

amIFollowing(loginName: string): Promise<boolean>

const sp = spfi(...);
const loginName = "i:0#.f|membership|testuser@mytenant.onmicrosoft.com";
const following = await sp.profiles.amIFollowing(loginName);

Get the tags I follow¶

Gets the tags the current user is following. Accepts max count, default is 20.

getFollowedTags(maxCount = 20): Promise<string[]>

const sp = spfi(...);
const tags = await sp.profiles.getFollowedTags();

Get followers for a specific user¶

Gets the people who are following the specified user.

getFollowersFor(loginName: string): Promise<any[]>

const sp = spfi(...);
const loginName = "i:0#.f|membership|testuser@mytenant.onmicrosoft.com";
const followers = await sp.profiles.getFollowersFor(loginName);
followers.forEach((value) => {
  ...
});

Get followers for the current¶

Gets the people who are following the current user.

myFollowers(): ISPCollection

const sp = spfi(...);
const folowers = await sp.profiles.myFollowers();

Get the properties for the current user¶

Gets user properties for the current user.

myProperties(): ISPInstance

const sp = spfi(...);
const profile = await sp.profiles.myProperties();
console.log(profile.DisplayName);
console.log(profile.Email);
console.log(profile.Title);
console.log(profile.UserProfileProperties.length);

// Properties are stored in Key/Value pairs,
// so parse into an object called userProperties
var props = {};
profile.UserProfileProperties.forEach((prop) => {
  props[prop.Key] = prop.Value;
});
profile.userProperties = props;
console.log("Account Name: " + profile.userProperties.AccountName);

// you can also select properties to return before
const sp = spfi(...);
const profile = await sp.profiles.myProperties.select("Title", "Email")();
console.log(profile.Email);
console.log(profile.Title);

Gets people specified user is following¶

getPeopleFollowedBy(loginName: string): Promise<any[]>

const sp = spfi(...);
const loginName = "i:0#.f|membership|testuser@mytenant.onmicrosoft.com";
const folowers = await sp.profiles.getFollowersFor(loginName);
followers.forEach((value) => {
  ...
});

Gets properties for a specified user¶

getPropertiesFor(loginName: string): Promise<any>

const sp = spfi(...);
const loginName = "i:0#.f|membership|testuser@mytenant.onmicrosoft.com";
const profile = await sp.profiles.getPropertiesFor(loginName);
console.log(profile.DisplayName);
console.log(profile.Email);
console.log(profile.Title);
console.log(profile.UserProfileProperties.length);

// Properties are stored in inconvenient Key/Value pairs,
// so parse into an object called userProperties
var props = {};
profile.UserProfileProperties.forEach((prop) => {
  props[prop.Key] = prop.Value;
});

profile.userProperties = props;
console.log("Account Name: " + profile.userProperties.AccountName);

Gets most popular tags¶

Gets the 20 most popular hash tags over the past week, sorted so that the most popular tag appears first

trendingTags(): Promise<IHashTagCollection>

const sp = spfi(...);
const tags = await sp.profiles.trendingTags();
tags.Items.forEach((tag) => {
  ...
});

Gets specified user profile property for the specified user¶

getUserProfilePropertyFor(loginName: string, propertyName: string): Promise<string>

const sp = spfi(...);
const loginName = "i:0#.f|membership|testuser@mytenant.onmicrosoft.com";
const propertyName = "AccountName";
const property = await sp.profiles.getUserProfilePropertyFor(loginName, propertyName);

Hide specific user from list of suggested people¶

Removes the specified user from the user's list of suggested people to follow.

hideSuggestion(loginName: string): Promise<void>

const sp = spfi(...);
const loginName = "i:0#.f|membership|testuser@mytenant.onmicrosoft.com";
await sp.profiles.hideSuggestion(loginName);

Is one user following another¶

Indicates whether the first user is following the second user. First parameter is the account name of the user who might be following the followee. Second parameter is the account name of the user who might be followed by the follower.

isFollowing(follower: string, followee: string): Promise<boolean>

const sp = spfi(...);
const follower = "i:0#.f|membership|testuser@mytenant.onmicrosoft.com";
const followee = "i:0#.f|membership|testuser2@mytenant.onmicrosoft.com";
const isFollowing = await sp.profiles.isFollowing(follower, followee);

Set User Profile Picture¶

Uploads and sets the user profile picture (Users can upload a picture to their own profile only). Not supported for batching. Accepts the profilePicSource Blob data representing the user's picture in BMP, JPEG, or PNG format of up to 4.76MB.

setMyProfilePic(profilePicSource: Blob): Promise<void>

import { spfi } from "@pnp/sp";
import "@pnp/sp/webs";
import "@pnp/sp/lists/web";
import "@pnp/sp/profiles";
import "@pnp/sp/folders";
import "@pnp/sp/files";

const sp = spfi(...);

// get the blob object through a request or from a file input
const blob = await sp.web.lists.getByTitle("Documents").rootFolder.files.getByName("profile.jpg").getBlob();

await sp.profiles.setMyProfilePic(blob);

Sets single value User Profile property¶

accountName The account name of the user propertyName Property name propertyValue Property value

setSingleValueProfileProperty(accountName: string, propertyName: string, propertyValue: string): Promise<void>

const sp = spfi(...);
const loginName = "i:0#.f|membership|testuser@mytenant.onmicrosoft.com";
await sp.profiles.setSingleValueProfileProperty(loginName, "CellPhone", "(123) 555-1212");

Sets a mult-value User Profile property¶

accountName The account name of the user propertyName Property name propertyValues Property values

setMultiValuedProfileProperty(accountName: string, propertyName: string, propertyValues: string[]): Promise<void>

const sp = spfi(...);
const loginName = "i:0#.f|membership|testuser@mytenant.onmicrosoft.com";
const propertyName = "SPS-Skills";
const propertyValues = ["SharePoint", "Office 365", "Architecture", "Azure"];
await sp.profiles.setMultiValuedProfileProperty(loginName, propertyName, propertyValues);
const profile = await sp.profiles.getPropertiesFor(loginName);
var props = {};
profile.UserProfileProperties.forEach((prop) => {
  props[prop.Key] = prop.Value;
});
profile.userProperties = props;
console.log(profile.userProperties[propertyName]);

Create Personal Site for specified users¶

Provisions one or more users' personal sites. (My Site administrator on SharePoint Online only) Emails The email addresses of the users to provision sites for

createPersonalSiteEnqueueBulk(...emails: string[]): Promise<void>

const sp = spfi(...);
let userEmails: string[] = ["testuser1@mytenant.onmicrosoft.com", "testuser2@mytenant.onmicrosoft.com"];
await sp.profiles.createPersonalSiteEnqueueBulk(userEmails);

Get the user profile of the owner for the current site¶

ownerUserProfile(): Promise<IUserProfile>

const sp = spfi(...);
const profile = await sp.profiles.ownerUserProfile();

Get the user profile of the current user¶

userProfile(): Promise<any>

const sp = spfi(...);
const profile = await sp.profiles.userProfile();

Create personal site for current user¶

createPersonalSite(interactiveRequest = false): Promise<void>

const sp = spfi(...);
await sp.profiles.createPersonalSite();

Make all profile data public or private¶

Set the privacy settings for all social data.

shareAllSocialData(share: boolean): Promise<void>

const sp = spfi(...);
await sp.profiles.shareAllSocialData(true);

Resolve a user or group¶

Resolves user or group using specified query parameters

clientPeoplePickerResolveUser(queryParams: IClientPeoplePickerQueryParameters): Promise<IPeoplePickerEntity>

const sp = spfi(...);
const result = await sp.profiles.clientPeoplePickerResolveUser({
  AllowEmailAddresses: true,
  AllowMultipleEntities: false,
  MaximumEntitySuggestions: 25,
  QueryString: 'mbowen@contoso.com'
});

Search a user or group¶

Searches for users or groups using specified query parameters

clientPeoplePickerSearchUser(queryParams: IClientPeoplePickerQueryParameters): Promise<IPeoplePickerEntity[]>

const sp = spfi(...);
const result = await sp.profiles.clientPeoplePickerSearchUser({
  AllowEmailAddresses: true,
  AllowMultipleEntities: false,
  MaximumEntitySuggestions: 25,
  QueryString: 'John'
});