[C#] DirectoryEntryでユーザーをグループに追加する方法

2025-01-18更新日: 2025-01-18

C#でDirectoryEntryを使用してユーザーをグループに追加するには、まずActive DirectoryのグループとユーザーのDirectoryEntryオブジェクトを取得します。

次に、グループのMembersプロパティを使用してユーザーを追加します。

具体的には、グループのDirectoryEntryオブジェクトのProperties["member"]にユーザーのDistinguishedNameを追加し、CommitChangesメソッドを呼び出して変更を保存します。

これにより、指定したユーザーがグループに追加されます。

エラーハンドリングや適切な権限の確認も重要です。

目次から探す

ユーザーをグループに追加する手順
エラーハンドリングと権限管理
応用例
まとめ

ユーザーをグループに追加する手順

グループのMembersプロパティの操作

C#でActive Directoryのグループにユーザーを追加するには、まず対象のグループを取得し、そのMembersプロパティを操作します。

以下のサンプルコードでは、グループを取得し、ユーザーを追加する準備を行います。

using System.DirectoryServices;
partial class MyForm
{
    private void AddUserToGroup(string groupName, string userDistinguishedName)
    {
        // グループのエントリを取得
        DirectoryEntry groupEntry = new DirectoryEntry("LDAP://CN=" + groupName + ",OU=Groups,DC=example,DC=com");
        
        // Membersプロパティを操作
        groupEntry.Properties["member"].Add(userDistinguishedName);
    }
}

このコードでは、指定したグループ名に基づいてグループのDirectoryEntryを取得し、ユーザーのDistinguishedNameをMembersプロパティに追加します。

ユーザーのDistinguishedNameの取得

ユーザーをグループに追加するためには、ユーザーのDistinguishedNameを取得する必要があります。

以下のサンプルコードでは、ユーザーのDistinguishedNameを取得する方法を示します。

using System.DirectoryServices;
partial class MyForm
{
    private string GetUserDistinguishedName(string username)
    {
        // ユーザーのエントリを取得
        DirectoryEntry userEntry = new DirectoryEntry("LDAP://CN=" + username + ",OU=Users,DC=example,DC=com");
        
        // DistinguishedNameを返す
        return userEntry.Properties["distinguishedName"].Value.ToString();
    }
}

このコードでは、指定したユーザー名に基づいてユーザーのDirectoryEntryを取得し、そのDistinguishedNameを返します。

CommitChangesメソッドで変更を保存

ユーザーをグループに追加した後は、変更を保存するためにCommitChangesメソッドを呼び出す必要があります。

以下のサンプルコードでは、変更を保存する方法を示します。

using System.DirectoryServices;
partial class MyForm
{
    private void SaveChanges(DirectoryEntry groupEntry)
    {
        // 変更を保存
        groupEntry.CommitChanges();
    }
}

このコードでは、グループのDirectoryEntryに対してCommitChangesメソッドを呼び出し、行った変更を保存します。

これにより、ユーザーがグループに追加されます。

エラーハンドリングと権限管理

エラーハンドリングの基本

C#でActive Directoryを操作する際には、エラーハンドリングが重要です。

特に、ユーザーをグループに追加する処理では、さまざまなエラーが発生する可能性があります。

以下のサンプルコードでは、基本的なエラーハンドリングの方法を示します。

using System;
using System.DirectoryServices;
partial class MyForm
{
    private void AddUserToGroupWithErrorHandling(string groupName, string userDistinguishedName)
    {
        try
        {
            DirectoryEntry groupEntry = new DirectoryEntry("LDAP://CN=" + groupName + ",OU=Groups,DC=example,DC=com");
            groupEntry.Properties["member"].Add(userDistinguishedName);
            groupEntry.CommitChanges();
        }
        catch (DirectoryServicesCOMException ex)
        {
            // エラーの詳細を表示
            Console.WriteLine("エラーが発生しました: " + ex.Message);
        }
        catch (Exception ex)
        {
            // その他のエラーを処理
            Console.WriteLine("予期しないエラーが発生しました: " + ex.Message);
        }
    }
}

このコードでは、try-catchブロックを使用して、DirectoryServicesCOMExceptionやその他の例外をキャッチし、エラーメッセージを表示します。

権限が不足している場合の対処法

Active Directoryに対する操作には、適切な権限が必要です。

権限が不足している場合、エラーが発生します。

以下の方法で対処できます。

権限の確認: 操作を行うユーザーが必要な権限を持っているか確認します。
管理者権限の使用: 必要に応じて、管理者権限でアプリケーションを実行します。
エラーメッセージの確認: 権限不足のエラーが発生した場合、エラーメッセージを確認し、適切な対策を講じます。

ログの記録とデバッグ

エラーハンドリングの一環として、ログの記録は非常に重要です。

エラーが発生した際に、詳細な情報を記録することで、後から問題を特定しやすくなります。

以下のサンプルコードでは、エラーをログファイルに記録する方法を示します。

using System;
using System.IO;
using System.DirectoryServices;
partial class MyForm
{
    private void LogError(string message)
    {
        // エラーメッセージをログファイルに記録
        File.AppendAllText("error_log.txt", DateTime.Now + ": " + message + Environment.NewLine);
    }
    private void AddUserToGroupWithLogging(string groupName, string userDistinguishedName)
    {
        try
        {
            DirectoryEntry groupEntry = new DirectoryEntry("LDAP://CN=" + groupName + ",OU=Groups,DC=example,DC=com");
            groupEntry.Properties["member"].Add(userDistinguishedName);
            groupEntry.CommitChanges();
        }
        catch (Exception ex)
        {
            // エラーをログに記録
            LogError("エラーが発生しました: " + ex.Message);
        }
    }
}

このコードでは、エラーが発生した際に、エラーメッセージをerror_log.txtというファイルに記録します。

これにより、後からエラーの詳細を確認することができます。

応用例

複数ユーザーを一度にグループに追加する

複数のユーザーを一度にグループに追加するには、ループを使用して各ユーザーのDistinguishedNameをMembersプロパティに追加します。

以下のサンプルコードでは、ユーザーのリストを受け取り、指定したグループに追加する方法を示します。

using System;
using System.Collections.Generic;
using System.DirectoryServices;
partial class MyForm
{
    private void AddMultipleUsersToGroup(string groupName, List<string> userDistinguishedNames)
    {
        try
        {
            DirectoryEntry groupEntry = new DirectoryEntry("LDAP://CN=" + groupName + ",OU=Groups,DC=example,DC=com");
            
            foreach (var userDN in userDistinguishedNames)
            {
                groupEntry.Properties["member"].Add(userDN);
            }
            
            groupEntry.CommitChanges();
        }
        catch (Exception ex)
        {
            Console.WriteLine("エラーが発生しました: " + ex.Message);
        }
    }
}

このコードでは、ユーザーのDistinguishedNameのリストをループ処理し、各ユーザーを指定したグループに追加します。

グループからユーザーを削除する方法

グループから特定のユーザーを削除するには、Membersプロパティから該当ユーザーを削除します。

以下のサンプルコードでは、指定したユーザーをグループから削除する方法を示します。

using System;
using System.DirectoryServices;
partial class MyForm
{
    private void RemoveUserFromGroup(string groupName, string userDistinguishedName)
    {
        try
        {
            DirectoryEntry groupEntry = new DirectoryEntry("LDAP://CN=" + groupName + ",OU=Groups,DC=example,DC=com");
            groupEntry.Properties["member"].Remove(userDistinguishedName);
            groupEntry.CommitChanges();
        }
        catch (Exception ex)
        {
            Console.WriteLine("エラーが発生しました: " + ex.Message);
        }
    }
}

このコードでは、指定したグループからユーザーを削除し、変更を保存します。

グループのメンバー一覧を取得する

グループのメンバー一覧を取得するには、Membersプロパティを参照します。

以下のサンプルコードでは、指定したグループのメンバーを取得し、表示する方法を示します。

using System;
using System.DirectoryServices;
partial class MyForm
{
    private void ListGroupMembers(string groupName)
    {
        try
        {
            DirectoryEntry groupEntry = new DirectoryEntry("LDAP://CN=" + groupName + ",OU=Groups,DC=example,DC=com");
            
            foreach (var member in groupEntry.Properties["member"])
            {
                Console.WriteLine("メンバー: " + member.ToString());
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine("エラーが発生しました: " + ex.Message);
        }
    }
}