Skip to main content

AAD Group - Read member summary using CSharp

 Is there a way to read Azure Active directory Group (Service or Microsoft 365) programmatically 

There are different ways to do it one of them is using AAD App 

let's see with the following example: 


Pre-requisite:

  • Create an AAD App 
    • Get the AAD Group Member Reader & User Read All permission through Microsoft Graph (application permission) 
    • Create a client secret (we'll use this to access your AAD Group information in the context of AAD App)
  • Create a CSharp project (detail mentioned below)



Create and AAD App with AAD GroupMember read & user read all permission

 Step-1: Create an aad app: Login to azure porta => Azure Active Directory => App registration => create new app 

 Step-2. Once AAD App is created (e.g.: AADGroupReader) 

      Open it. 

  Go to it's API Permissions



  Click on Add Permission

  From right-hand side select "Microsoft Graph"



  Now you've to search with Keywork "User"  and select "User.Read.All"



And also search for keyword "Group" and select "GroupMember.ReadWrite.All"


 

      Once you've selected both, click "Add permission" 

  Now on the API permission, you can see both "User.Read.All" & "GroupMember.Read.All" got added.



    But you will notice that status is "Not granted for default...."

If you're AAD Admin you can Grant admin consent.

If you're not AAD Admin you may have to contact your admin to grant admin consent. 

     if you are the AAD admin, you can grant the consent like this. 

Click on "Grant admin consent for default directory"  And click "Yes" from the pop-up like this.   

Once admin consent granted, you can see a status bar with Green check-mark. 



Now let's create the client secret and save the created client secrete in a safe place (e.g.: Key vault).  

Click on "Certificates & secretes" 



New client secret


Copy the client secret and save it at a safe place.



  

With this, we're good with accessing our AAD Group and it's user detail using AAD App context (SPN context). 



Now use CSharp and get the AAD group member detail with the help of created AAD App

Step-1: Open visual studio 
Step-2: Create a console app 
Step-3: Install these libraries through Nuget package 
 Install these 3 libraries using NuGet package manager
    • Microsoft.Graph;
    • Microsoft.Graph.Auth;  // at this time it's in Preview mode.
    • Microsoft.Identity.Client;

Step-4: Write a AADGroupReader class like this. 
 In this code snipped   replace your ClientId, TenantId & clientSecret of your own app & group. 
Step-5. Assume that we've an AAD Group with the name "testaddgroup" having one user with the name "Test User"

Code snipped to read the AAD Group & fetch the user summary

Utility method:
public List GetGroupMembers(string groupName)
        {
            var userList = new List();
            try
            {
                var clientId = "your-aad-app-client-id";
                var tenantId = "your-tenant-id";
                var secret = "your-aad-app-client-secret";
                IConfidentialClientApplication confidentialClientApplication = ConfidentialClientApplicationBuilder
                                                                                   .Create(clientId)
                                                                                   .WithTenantId(tenantId)
                                                                                   .WithClientSecret(secret)
                                                                                   .Build();

                IAuthenticationProvider authProvider = new ClientCredentialProvider(confidentialClientApplication);
                GraphServiceClient graphClient = new GraphServiceClient(authProvider);

                var groupsDetails = graphClient.Groups.Request()
                    .Filter($"startswith(displayName,'{groupName}')")
                    .GetAsync()
                     .ConfigureAwait(false)
                       .GetAwaiter()
                       .GetResult()
                       .ToList()
                       .Where(x => string.Equals(x.DisplayName, groupName, StringComparison.InvariantCultureIgnoreCase))
                       .FirstOrDefault();


                var groupObjectId = groupsDetails.Id;
                var groupMembers = graphClient.Groups[groupObjectId]
                       .TransitiveMembers
                       //.Members  // just to get the direct memb er
                       .Request()
                       .GetAsync()
                       .ConfigureAwait(false)
                       .GetAwaiter()
                       .GetResult();


                foreach (var mem in groupMembers.ToList())
                {
                    //var memType = mem.GetType();
                    if (mem.GetType() == typeof(User))
                    {
                        var myUser = graphClient.Users[mem.Id].Request().GetAsync()
                       .ConfigureAwait(false)
                       .GetAwaiter()
                       .GetResult();

                        User forUser = (User)mem;

                        userList.Add(new AadGroupMember
                        {
                            ObjectId = forUser.Id,
                            UserPrincipalName = forUser.UserPrincipalName,
                            Name = forUser.DisplayName,
                            Email = forUser.Mail,

                        });
                    }
                }

                return userList;
            }
            catch (Exception ex)
            {
                throw;
            }
        }
  

Heping entity:
    public class AadGroupMember
    {
        public string ObjectId { get; set; }
        public string Name { get; set; }
        public string UserPrincipalName { get; set; }
        public string Email { get; set; } //UserPrincipalName
    }
  

Working code can be found on GitHub "AzureActiveDirectory" repo. 

Comments

Popular posts from this blog

EFCore - Collate function

Search in SQL server query is generally case insensitive (by default or based on database level collation). Suppose we have an employees table with a row having first-name column value as "My-First-Name", so if we want to do the case-sensitive search we have to explicitly use the related collate: In EF 5 (currently in Release Candidate version [RC.2.20475.6]) Collate function got introduced which helps us to use our specific collation based search.  C# with EF5 code sample: var employeeCaseSensitiveSearch = _dbContext.Employees .Where(x => EF.Functions.Collate(x.FirstName, "Latin1_General_CS_AS") == "my-first-name") .FirstOrDefault(); A related database query will be something like this: T-SQL: Case sensitive search (use specific collation e.g.: Latin1_General_CS_AS) SELECT * FROM dbo.Employees AS e WHERE e.FirstName Collate Latin1_General_CS_AS = 'my-first-name' Some of the useful CSharp function which g...

Azure SQL - User management with Active Directory Group

To manage the user's roles we use Service Account on OnPrem/IaaS servers. We can use this service account on our SQL Server and accordingly manage users' permissions for the users who are part of this service account. Suppose we have an Azure SQL and we want to manage set-of-users permission shall we create each-and-every users' user profile in Azure SQL and set the permissions accordingly. Obviously, we will not .  If we've anything like Service Account (or Group) on Azure we could create the user of this GROUP on Azure SQL and set its permission/role. Here comes the Azure Active Directory Group to help us.  In case if our organization has some scheduled tasks to sync Active Directory (service account) to Azure Active Directory (AAD group), already in place, there will be some delay when we add a user to the Service account and get reflected in the AAD Group. If we have a requirement that as soon as we add a user to our group we wan...

Azure VM - Failed to update virtual machine disks (Solved)

Sometimes while trying to add/remove a disk from Azure VM through the Azure portal we are getting error like " Failed to update virtual machine disks " as below Here though we are only trying to add/remove the disk, we're not doing anything with Azure Disk Encryption (ADE), still, we're getting the error message related to ADE.  Not while adding or updating the disk, if we try to add extensions or performing any activity required to do save operation to update the VM template, it show a similar failure message which is related to ADE.  Now to resolve this if we disable the disk encryption through the Azure portal through it will disable the disk encryption and on portal, we can see there is no disk encryption and also the related Key vault field is coming up empty but still, when we try to add/remove the disk & do the save operation we are getting the similar message. This is because in the VM JSON template we can se...