Merge pull request #1474 from gautamdsheth/feature/995

Feature #995 - ability to fetch guest users from the team

CHANGELOG.md

@@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
 ### Added
 
+- Added additional properties to the users returned by `Get-PnPMicrosoft365GroupMember` such as `userType` [#1474](https://github.com/pnp/powershell/pull/1474)
 - Added `Update-PnPTeamsUser` cmdlet to change the role of a user in an existing Teams team [#1499](https://github.com/pnp/powershell/pull/1499)
 - Added `Get\New\Remove\Set-PnPMicrosoft365GroupSettings` cmdlets to interact with Microsoft 365 Group settings.
 - Added `Get-PnPMicrosoft365GroupSettingTemplates` cmdlet to retrieve system wide Microsoft 365 Group setting templates.

documentation/Get-PnPMicrosoft365GroupMember.md

@@ -16,15 +16,16 @@ title: Get-PnPMicrosoft365GroupMember
   * Microsoft Graph API : at least Group.Read.All
   * Microsoft Graph API : Directory.Read.All
 
-Gets members of a particular Microsoft 365 Group (aka Unified Group).
+Returns the members of a particular Microsoft 365 Group
 
 ## SYNTAX
 
 ```powershell
-Get-PnPMicrosoft365GroupMember -Identity <Microsoft365GroupPipeBind> [<CommonParameters>]
+Get-PnPMicrosoft365GroupMember -Identity <Microsoft365GroupPipeBind> [-UserType <String>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
+Returns the members of a particular Microsoft 365 Group
 
 ## EXAMPLES
 
@@ -42,6 +43,13 @@ Get-PnPMicrosoft365GroupMember -Identity $group
 
 Retrieves all the members of a specific Microsoft 365 Group based on the group's object instance
 
+### EXAMPLE 3
+```powershell
+Get-PnPMicrosoft365GroupMember -Identity "Sales" | Where-Object UserType -eq Guest
+```
+
+Returns all the guest users of the Microsoft 365 Group named "Sales"
+
 ## PARAMETERS
 
 ### -Identity
@@ -60,6 +68,4 @@ Accept wildcard characters: False
 
 ## RELATED LINKS
 
-[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)
-
-
+[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)

src/Commands/Enums/UserType.cs

@@ -0,0 +1,18 @@
+namespace PnP.PowerShell.Commands.Enums
+{
+    /// <summary>
+    /// Enum that defines the possible types of users
+    /// </summary>
+    public enum UserType
+    {
+        /// <summary>
+        /// User is an employee account
+        /// </summary>
+        Member = 0,
+
+        /// <summary>
+        /// User is a guest account
+        /// </summary>
+        Guest = 1
+    }
+}

src/Commands/Model/Microsoft365Group.cs

@@ -1,10 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Management.Automation;
-using System.Text.Json;
 using System.Text.Json.Serialization;
-using PnP.PowerShell.Commands.Model.Graph;
 
 namespace PnP.PowerShell.Commands.Model
 {

src/Commands/Model/Microsoft365User.cs

@@ -2,46 +2,88 @@
 
 namespace PnP.PowerShell.Commands.Model
 {
+    /// <summary>
+    /// Contains the information of an Azure Active Directory user object
+    /// </summary>
     public class Microsoft365User
     {
+        /// <summary>
+        /// Unique identifier of this user object in Azure Active Directory
+        /// </summary>
+        [JsonPropertyName("id")]
         public string Id { get; set; }
+
         /// <summary>
-        /// Group user's user principal name
+        /// User's user principal name
         /// </summary>
+        [JsonPropertyName("userPrincipalName")]
         public string UserPrincipalName { get; set; }
+
         /// <summary>
-        /// Group user's display name
+        /// User's display name
         /// </summary>
+        [JsonPropertyName("displayName")]
         public string DisplayName { get; set; }
+
         /// <summary>
-        /// Group user's given name
+        /// User's given name
         /// </summary>
+        [JsonPropertyName("givenName")]
         public string GivenName { get; set; }
+
         /// <summary>
-        /// Group user's surname
+        /// User's surname
         /// </summary>
+        [JsonPropertyName("surname")]
         public string Surname { get; set; }
+
         /// <summary>
-        /// Group user's e-mail address
+        /// User's e-mail address
         /// </summary>
 
         [JsonPropertyName("mail")]
         public string Email { get; set; }
+
         /// <summary>
-        /// Group user's mobile phone number
+        /// User's mobile phone number
         /// </summary>
+        [JsonPropertyName("mobilePhone")]
         public string MobilePhone { get; set; }
+
         /// <summary>
-        /// Group user's preferred language in ISO 639-1 standard notation
+        /// User's preferred language in ISO 639-1 standard notation
         /// </summary>
+        [JsonPropertyName("preferredLanguage")]
         public string PreferredLanguage { get; set; }
+
         /// <summary>
-        /// Group user's job title
+        /// User's job title
         /// </summary>
+        [JsonPropertyName("jobTitle")]
         public string JobTitle { get; set; }
+
         /// <summary>
-        /// Group user's business phone numbers
+        /// User's business phone numbers
         /// </summary>
+        [JsonPropertyName("businessPhones")]
         public string[] BusinessPhones { get; set; }
+
+        /// <summary>
+        /// User's job title
+        /// </summary>
+        [JsonPropertyName("userType")]
+        public Enums.UserType? UserType { get; set; }
+
+        /// <summary>
+        /// Location from which Microsoft 365 will mainly be used
+        /// </summary>
+        [JsonPropertyName("usageLocation")]
+        public string UsageLocation { get; set; }
+
+        /// <summary>
+        /// Aliases set on the mailbox of this user
+        /// </summary>
+        [JsonPropertyName("proxyAddresses")]
+        public string[] ProxyAddresses { get; set; }       
     }
 }

src/Commands/Utilities/Microsoft365GroupsUtility.cs

@@ -230,9 +230,9 @@ internal static async Task<IEnumerable<Microsoft365User>> GetMembersAsync(HttpCl
             return await GetGroupMembersAsync("members", httpClient, groupId, accessToken);
         }
 
-        private static async Task<IEnumerable<Microsoft365User>> GetGroupMembersAsync(string groupName, HttpClient httpClient, Guid groupId, string accessToken)
+        private static async Task<IEnumerable<Microsoft365User>> GetGroupMembersAsync(string userType, HttpClient httpClient, Guid groupId, string accessToken)
         {
-            var results = await GraphHelper.GetResultCollectionAsync<Microsoft365User>(httpClient, $"v1.0/groups/{groupId}/{groupName}", accessToken);
+            var results = await GraphHelper.GetResultCollectionAsync<Microsoft365User>(httpClient, $"v1.0/groups/{groupId}/{userType}?$select=*", accessToken);
             return results;
         }
 

src/Commands/Utilities/REST/GraphHelper.cs

@@ -7,6 +7,7 @@
 using System.Net;
 using System.Net.Http;
 using System.Text.Json;
+using System.Text.Json.Serialization;
 using System.Threading;
 using System.Threading.Tasks;
 
@@ -124,7 +125,8 @@ public static async Task<T> GetAsync<T>(HttpClient httpClient, string url, strin
             var stringContent = await GetAsync(httpClient, url, accessToken);
             if (stringContent != null)
             {
-                var options = new JsonSerializerOptions() { IgnoreNullValues = true };
+                var options = new JsonSerializerOptions { IgnoreNullValues = true };
+                options.Converters.Add(new JsonStringEnumConverter());
                 if (camlCasePolicy)
                 {
                     options.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
@@ -138,7 +140,7 @@ public static async Task<T> GetAsync<T>(HttpClient httpClient, string url, strin
                     var entity = JsonSerializer.Deserialize<T>(stringContent, options);
                     return entity;
                 }
-                catch (Exception)
+                catch (Exception e)
                 {
                     return default(T);
                 }