SharePoint でサーバーオブジェクトモデルを使用して、ユーザープロファイルと組織プロファイルを操作する

[アーティクル]
03/21/2023

SharePointのユーザープロファイルやユーザープロファイルプロパティを SharePointのサーバーオブジェクトモデルを使用してプログラムによって作成、取得、変更する方法を説明します。

SharePointのユーザープロファイルとは

SharePoint では、ユーザープロファイルは SharePoint ユーザーを表します。ユーザープロファイルのプロパティは、ユーザーとプロパティそのものについての情報を表します。プロパティの例としては、ユーザーのアカウント名や電子メールアドレス、プロパティのデータ型などがあります。サーバーオブジェクトモデルを使用すると、ユーザープロファイル、プロファイルのサブタイプ、プロファイルのプロパティをプログラムによって作成、取得、変更できます。

注:

ユーザープロファイルを操作するための一般的なプログラミングタスクと、タスクの実行に使用する API の詳細については、「 SharePoint でのユーザープロファイルの操作」を参照してください。

SharePoint サーバーオブジェクトモデルを使用してユーザープロファイルを処理するための開発環境を設定するための前提条件。

ユーザープロファイルとユーザープロファイルプロパティを処理するためにサーバーオブジェクトモデルを使用するコンソールアプリケーションを作成するには、以下のものが必要になります。

現在のユーザー用にプロファイルが作成された SharePoint Server 2013。
Visual Studio 2012.
ユーザープロファイルオブジェクトを作成、取得、変更するためのアクセス許可。 (プロファイルの作成と変更には、 ユーザープロファイルの変更 アクセス許可が必要です)。

SharePointのサーバーオブジェクトモデルを使用してユーザープロファイルを操作するコンソールアプリケーションを作成する

Visual Studio を開き、[ ファイル]、[ [新規]、[ プロジェクト] を選択します。
[ 新しいプロジェクト] ダイアログボックスで、上部のドロップダウンリストから [ .NET Framework 4.5] を選択します。
[ テンプレート] リストで [ Windows] を選択し、さらに [ コンソールアプリケーション] を選択します。
UserProfilesSSOM プロジェクトを指名し、OK ボタンをクリックします。

注: プロジェクトの ビルド プロパティにおいて 32 ビット優先 設定が選択されていないことを確認してください。

以下のアセンブリに参照を追加します。

Microsoft.Office.Server
Microsoft.Office.Server.UserProfiles
Microsoft.SharePoint
system.web

Program クラスの内容を、以下のシナリオのいずれかのコード例に置き換えます。

コンソールアプリケーションをテストするには、メニューバーの [ デバッグ] を選択し、[ デバッグ開始] をクリックします。変更は、サーバーの全体管理のユーザー プロファイルサービス アプリケーションの [プロファイルサービスの管理] ページで確認できます。

コード例: SharePointのサーバーオブジェクトモデルを使用してユーザープロファイルを作成する

SharePointにおいて、ユーザープロファイルは SharePoint ユーザーを表します。プロファイルのタイプおよびサブタイプは、プロファイルを従業員や顧客のようなグループに分類する際に役立ちます。プロファイルのタイプとサブタイプは、共通のプロファイルプロパティを設定したり、属性をサブタイプのレベルで設定したりするために使用されます。 SharePoint Server には、既定のユーザープロファイルサブタイプが用意されています。

次のコード例では、既定のユーザープロファイルサブタイプに関連付けられている UserProfile オブジェクトを作成します。ユーザープロファイルプロパティの一部は、Active Directory ドメインサービスなど、ユーザーアカウントを含むディレクトリからインポートされた情報に基づいて自動的に設定されます。カスタムサブタイプを作成するコード例については、 ProfileSubtype を参照してください。

注:

コードを実行する前に、domain\username とservername プレースホルダーの値を変更します。


using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Microsoft.Office.Server;
using Microsoft.Office.Server.UserProfiles;
using Microsoft.SharePoint;
using System.Web;
namespace UserProfilesSSOM
{
    class Program
    {
        static void Main(string[] args)
        {

            // Replace "domain\\username" and "servername" with actual values.
            string newAccountName = "domain\\username";
            using (SPSite site = new SPSite("http://servername"))
            {
                SPServiceContext serviceContext = SPServiceContext.GetContext(site);
                try
                {

                    // Create a user profile that uses the default user profile
                    // subtype.
                    UserProfileManager userProfileMgr = new UserProfileManager(serviceContext);
                    UserProfile userProfile = userProfileMgr.CreateUserProfile(newAccountName);

                    Console.WriteLine("A profile was created for " + userProfile.DisplayName);
                    Console.Read();
                }

                catch (System.Exception e)
                {
                    Console.WriteLine(e.GetType().ToString() + ": " + e.Message);
                    Console.Read();
                }
            }
        }
    }
}

コード例: SharePoint サーバーオブジェクトモデルを使用してユーザープロファイルプロパティを作成する

ユーザープロファイルプロパティは、ユーザーに関する個人または組織の情報を記述します。カスタムプロファイルプロパティを作成して、SharePoint プロファイルプロパティの既定のセットに追加することができます。

プロファイルプロパティとその属性は、リンクされたオブジェクトのセット ( CoreProperty オブジェクト、 ProfileTypeProperty オブジェクト、 ProfileSubtypeProperty オブジェクト) で表されます。

次のコード例では、URL データ型 (または必要に応じて、複数値文字列データ型を持つ CoreProperty) を持つ CoreProperty を作成します。さらに、状態、プライバシー、およびプロパティのその他の設定を定義する ProfileTypeProperty および ProfileTypeProperty を作成しています。 ProfileSubtypeProperty.DefaultPrivacy プロパティは、プロパティおよびその他の個人用サイトのコンテンツの表示/非表示を制御します。プロファイルプロパティ値として可能なデータ型の完全な一覧については、 PropertyDataType を参照してください。

注:

コードを実行する前に、サーバー名のプレースホルダー値を変更してください。


using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Microsoft.Office.Server;
using Microsoft.Office.Server.Administration;
using Microsoft.Office.Server.UserProfiles;
using Microsoft.SharePoint;
using System.Web;
namespace UserProfilesSSOM
{
    class Program
    {
        static void Main(string[] args)
        {

            // Replace "servername" with an actual value.
            using (SPSite site = new SPSite("http://servername"))
            {
                SPServiceContext serviceContext = SPServiceContext.GetContext(site);
                try
                {
                    ProfilePropertyManager profilePropMgr = new UserProfileConfigManager(serviceContext).ProfilePropertyManager;
                    CorePropertyManager corePropMgr = profilePropMgr.GetCoreProperties();

                    // Create a URL property.
                    CoreProperty coreProp = corePropMgr.Create(false);
                    coreProp.Name = "AppsWebsite";
                    coreProp.DisplayName = "Apps site";
                    coreProp.Type = PropertyDataType.URL;
                    coreProp.Length = 100;
                    corePropMgr.Add(coreProp);

                    //// Create a multivalue property.
                    //// To create this property, comment out the previous
                    //// block of code and uncomment this block of code.
                    //CoreProperty coreProp = corePropMgr.Create(false);
                    //coreProp.Name = "PublishedAppsList";
                    //coreProp.DisplayName = "Published apps";
                    //coreProp.Type = PropertyDataType.StringMultiValue;
                    //coreProp.IsMultivalued = true;
                    //coreProp.Length = 100;
                    //corePropMgr.Add(coreProp);

                    // Create a profile type property and make the core property 
                    // visible in the Details section page.
                    ProfileTypePropertyManager typePropMgr = profilePropMgr.GetProfileTypeProperties(ProfileType.User);
                    ProfileTypeProperty typeProp = typePropMgr.Create(coreProp);
                    typeProp.IsVisibleOnViewer = true;
                    typePropMgr.Add(typeProp);

                    // Create a profile subtype property.
                    ProfileSubtypeManager subtypeMgr = ProfileSubtypeManager.Get(serviceContext);
                    ProfileSubtype subtype = subtypeMgr.GetProfileSubtype(ProfileSubtypeManager.GetDefaultProfileName(ProfileType.User));
                    ProfileSubtypePropertyManager subtypePropMgr = profilePropMgr.GetProfileSubtypeProperties(subtype.Name);
                    ProfileSubtypeProperty subtypeProp = subtypePropMgr.Create(typeProp);
                    subtypeProp.IsUserEditable = true;
                    subtypeProp.DefaultPrivacy = Privacy.Public;
                    subtypeProp.UserOverridePrivacy = true;
                    subtypePropMgr.Add(subtypeProp);

                    Console.WriteLine("The properties were created.");
                    Console.Read();
                }

                catch (System.Exception e)
                {
                    Console.WriteLine(e.GetType().ToString() + ": " + e.Message);
                    Console.Read();
                }
            }
        }
    }
}

コード例: SharePoint サーバーオブジェクトモデルを使用してユーザープロファイルを取得、変更する

次のコード例では、コンテキスト内のすべてのユーザープロファイルを取得し、ユーザーの DisplayName プロパティの値を変更します。ほとんどのプロファイルプロパティには UserProfile.Item アクセサーを使用してアクセスします。

注:

コードを実行する前に、domain\username とservername プレースホルダーの値を変更します。


using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Microsoft.Office.Server;
using Microsoft.Office.Server.UserProfiles;
using Microsoft.SharePoint;
using System.Web;
namespace UserProfilesSSOM
{
    class Program
    {
        static void Main(string[] args)
        {

            // Replace "domain\\username" and "servername" with actual values.
            string targetAccountName = "domain\\username";
            using (SPSite site = new SPSite("http://servername"))
            {
                SPServiceContext serviceContext = SPServiceContext.GetContext(site);
                try
                {

                    // Retrieve and iterate through all of the user profiles in this context.
                    Console.WriteLine("Retrieving user profiles:");
                    UserProfileManager userProfileMgr = new UserProfileManager(serviceContext);
                    IEnumerator userProfiles = userProfileMgr.GetEnumerator();
                    while (userProfiles.MoveNext())
                    {
                        UserProfile userProfile = (UserProfile)userProfiles.Current;
                        Console.WriteLine(userProfile.AccountName);
                    }

                    // Retrieve a specific user profile. Change the value of a user profile property
                    // and save (commit) the change on the server.
                    UserProfile user = userProfileMgr.GetUserProfile(targetAccountName);
                    Console.WriteLine("\\nRetrieving user profile for " + user.DisplayName + ".");
                    user.DisplayName = "Pat";
                    user.Commit();
                    Console.WriteLine("\\nThe user\\'s display name has been changed.");
                    Console.Read();
                }

                catch (System.Exception e)
                {
                    Console.WriteLine(e.GetType().ToString() + ": " + e.Message);
                    Console.Read();
                }
            }
        }
    }
}

コード例: SharePoint サーバーオブジェクトモデルを使用してユーザープロファイルプロパティの属性を取得、変更する

次のコード例では、特定のユーザープロパティとその属性を表すプロパティのセットを取得し、 CoreProperty.DisplayName 属性、 ProfileTypeProperty.IsVisibleOnViewer 属性、 ProfileSubtypeProperty.PrivacyPolicy 属性を変更します。これらの変更はプロパティのセットにグローバルに適用されます。 ProfileSubtypeProperty.PrivacyPolicy はユーザーがそのプロパティの値を入力する必要があるかどうかを指定しています。 PrivacyPolicy はユーザープロファイルプロパティにのみ適用されます。

注:

コードを実行する前に、サーバー名のプレースホルダー値を変更してください。


using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Microsoft.Office.Server;
using Microsoft.Office.Server.UserProfiles;
using Microsoft.SharePoint;
using System.Web;
namespace UserProfilesSSOM
{
    class Program
    {
        static void Main(string[] args)
        {

            // Replace "servername" with an actual value.
            using (SPSite site = new SPSite("http://servername"))
            {
                SPServiceContext serviceContext = SPServiceContext.GetContext(site);
                try
                {
                    ProfilePropertyManager profilePropMgr = new UserProfileConfigManager(serviceContext).ProfilePropertyManager;
                    ProfileSubtypePropertyManager subtypePropMgr = profilePropMgr.GetProfileSubtypeProperties("UserProfile");

                    // Retrieve a specific property set (a profile subtype property and
                    // its associated core and profile type properties).
                    // Changing these properties affects all instances of this property set.
                    ProfileSubtypeProperty subtypeProp = subtypePropMgr.GetPropertyByName(PropertyConstants.Title);
                    CoreProperty coreProp = subtypeProp.CoreProperty;
                    ProfileTypeProperty typeProp = subtypeProp.TypeProperty;

                    Console.WriteLine("Property name: " + coreProp.DisplayName);
                    Console.WriteLine("IsVisibleOnViewer = " + typeProp.IsVisibleOnViewer);
                    Console.WriteLine("PrivacyPolicy = " + subtypeProp.PrivacyPolicy);
                    Console.WriteLine("Press Enter to change the values.");
                    Console.Read();

                    // Change attributes on the properties and save (commit) the changes
                    // on the server.
                    coreProp.DisplayName = "Position";
                    coreProp.Commit();
                    typeProp.IsVisibleOnViewer = true;
                    typeProp.Commit();
                    subtypeProp.PrivacyPolicy = PrivacyPolicy.OptOut;
                    subtypeProp.Commit();
                    Console.WriteLine("The property attributes have been changed.");
                    Console.Read();
                }

                catch (System.Exception e)
                {
                    Console.WriteLine(e.GetType().ToString() + ": " + e.Message);
                    Console.Read();
                }
            }
        }
    }
}

コード例: SharePoint サーバーオブジェクトモデルを使用してユーザープロファイルの値を取得、変更する

以下のコード例は、すべての UserProfile 型プロパティを取得し、特定のユーザーのプロパティ値を取得しています。その後、単一値の PictureUrl プロパティ、および複数値の PastProjects プロパティを変更しています。プロファイルプロパティ名定数の完全な一覧については、 PropertyConstants を参照してください。

注:

コードを実行する前に、domain\username、、 http://servername/docLib/pic.jpg、および servername プレースホルダーの値を変更します。


using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Microsoft.Office.Server;
using Microsoft.Office.Server.UserProfiles;
using Microsoft.SharePoint;
using System.Web;
namespace UserProfilesSSOM
{
    class Program
    {
        static void Main(string[] args)
        {

            // Replace "domain\\username," "http://servername/docLib/pic.jpg," and "servername" with actual values.
            string accountName = "domain\\username";
            string newPictureUrl = "http://servername/docLib/pic.jpg";
            using (SPSite site = new SPSite("http://servername"))
            {
                SPServiceContext serviceContext = SPServiceContext.GetContext(site);

                try
                {
                    UserProfileManager userProfileMgr = new UserProfileManager(serviceContext);
                    ProfilePropertyManager profilePropMgr = new UserProfileConfigManager(serviceContext).ProfilePropertyManager;
                   
                    // Retrieve all properties for the "UserProfile" profile subtype,
                    // and retrieve the property values for a specific user.
                    ProfileSubtypePropertyManager subtypePropMgr = profilePropMgr.GetProfileSubtypeProperties("UserProfile");
                    UserProfile userProfile = userProfileMgr.GetUserProfile(accountName);
                    IEnumerator<ProfileSubtypeProperty> userProfileSubtypeProperties = subtypePropMgr.GetEnumerator();
                    while (userProfileSubtypeProperties.MoveNext())
                    {
                        string propName = userProfileSubtypeProperties.Current.Name;
                        ProfileValueCollectionBase values = userProfile.GetProfileValueCollection(propName);
                        if (values.Count > 0)
                        {

                            // Handle multivalue properties.
                            foreach (var value in values)
                            {
                                Console.WriteLine(propName + ": " + value.ToString());
                            }
                        }
                        else
                        {
                            Console.WriteLine(propName + ": ");
                        }
                    }
                    Console.WriteLine("Press Enter to change the values.");
                    Console.Read();

                    // Change the value of a single-value user property.
                    userProfile[PropertyConstants.PictureUrl].Value = newPictureUrl;

                    // Add a value to a multivalue user property.
                    userProfile[PropertyConstants.PastProjects].Add((object)"Team Feed App");
                    userProfile[PropertyConstants.PastProjects].Add((object)"Social Ratings View web part");

                    // Save the changes to the server.
                    userProfile.Commit();
                    Console.WriteLine("The property values for the user have been changed.");
                    Console.Read();
                }

                catch (System.Exception e)
                {
                    Console.WriteLine(e.GetType().ToString() + ": " + e.Message);
                    Console.Read();
                }
            }
        }
    }
}

SharePoint でサーバーオブジェクトモデルを使用して、ユーザープロファイルと組織プロファイルを操作する

SharePointのユーザープロファイルとは

SharePoint サーバーオブジェクトモデルを使用してユーザープロファイルを処理するための開発環境を設定するための前提条件。

SharePointのサーバーオブジェクトモデルを使用してユーザープロファイルを操作するコンソールアプリケーションを作成する

コード例: SharePointのサーバーオブジェクトモデルを使用してユーザープロファイルを作成する

コード例: SharePoint サーバーオブジェクトモデルを使用してユーザープロファイルプロパティを作成する

コード例: SharePoint サーバーオブジェクトモデルを使用してユーザープロファイルを取得、変更する

コード例: SharePoint サーバーオブジェクトモデルを使用してユーザープロファイルプロパティの属性を取得、変更する

コード例: SharePoint サーバーオブジェクトモデルを使用してユーザープロファイルの値を取得、変更する

関連項目

その他のリソース

SharePoint でサーバー オブジェクト モデルを使用して、ユーザー プロファイルと組織プロファイルを操作する

SharePointのユーザー プロファイルとは

SharePoint サーバー オブジェクト モデルを使用してユーザー プロファイルを処理するための開発環境を設定するための前提条件。

SharePointのサーバー オブジェクト モデルを使用してユーザー プロファイルを操作するコンソール アプリケーションを作成する

コード例: SharePointのサーバー オブジェクト モデルを使用してユーザー プロファイルを作成する

コード例: SharePoint サーバー オブジェクト モデルを使用してユーザー プロファイル プロパティを作成する

コード例: SharePoint サーバー オブジェクト モデルを使用してユーザー プロファイルを取得、変更する

コード例: SharePoint サーバー オブジェクト モデルを使用してユーザー プロファイル プロパティの属性を取得、変更する

コード例: SharePoint サーバー オブジェクト モデルを使用してユーザー プロファイルの値を取得、変更する

関連項目

その他のリソース

SharePoint でサーバーオブジェクトモデルを使用して、ユーザープロファイルと組織プロファイルを操作する

SharePointのユーザープロファイルとは

SharePoint サーバーオブジェクトモデルを使用してユーザープロファイルを処理するための開発環境を設定するための前提条件。

SharePointのサーバーオブジェクトモデルを使用してユーザープロファイルを操作するコンソールアプリケーションを作成する

コード例: SharePointのサーバーオブジェクトモデルを使用してユーザープロファイルを作成する

コード例: SharePoint サーバーオブジェクトモデルを使用してユーザープロファイルプロパティを作成する

コード例: SharePoint サーバーオブジェクトモデルを使用してユーザープロファイルを取得、変更する

コード例: SharePoint サーバーオブジェクトモデルを使用してユーザープロファイルプロパティの属性を取得、変更する

コード例: SharePoint サーバーオブジェクトモデルを使用してユーザープロファイルの値を取得、変更する