Merge pull request #596 from TheJumpCloud/CUT-4251-RemoveAttribute-Pa…

…rameter-Not-Working

Cut 4251 remove attribute parameter not working

PowerShell/JumpCloud Module/Docs/Connect-JCOnline.md

@@ -13,7 +13,7 @@ The Connect-JCOnline function sets the global variable $JCAPIKEY
 ## SYNTAX
 
 ```
-Connect-JCOnline [-force] [-JumpCloudApiKey] <String>
+Connect-JCOnline [-force] [[-JumpCloudApiKey] <String>]
  [[-JumpCloudOrgId] <String>] [[-JCEnvironment] <String>] [<CommonParameters>]
 ```
 
@@ -88,7 +88,7 @@ Type: System.String
 Parameter Sets: (All)
 Aliases:
 
-Required: True
+Required: False
 Position: 1
 Default value: None
 Accept pipeline input: True (ByPropertyName)

PowerShell/JumpCloud Module/Docs/JumpCloud.md

@@ -2,7 +2,7 @@
 Module Name: JumpCloud
 Module Guid: 31c023d1-a901-48c4-90a3-082f91b31646
 Download Help Link: https://github.com/TheJumpCloud/support/wiki
-Help Version: 2.13.0
+Help Version: 2.13.1
 Locale: en-Us
 ---
 

PowerShell/JumpCloud Module/Docs/Set-JCSettingsFile.md

@@ -14,8 +14,8 @@ Updates the JumpCloud Module Settings File
 ## SYNTAX
 
 ```
-Set-JCSettingsFile [-moduleBannerMessageCount <PSObject>]
- [-parallelOverride <PSObject>] [<CommonParameters>]
+Set-JCSettingsFile [-parallelOverride <PSObject>]
+ [-moduleBannerMessageCount <PSObject>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION

PowerShell/JumpCloud Module/Docs/Set-JCUser.md

@@ -32,24 +32,24 @@ Set-JCUser [-Username] <String> [-email <String>] [-firstname <String>] [-lastna
  -Attribute2_value <String> [<CommonParameters>]
 ```
 
-### RemoveAttribute
+### RemoveCustomAttribute
 ```
 Set-JCUser [-Username] <String> [-email <String>] [-firstname <String>] [-lastname <String>]
  [-password <String>] [-password_never_expires <Boolean>] [-allow_public_key <Boolean>] [-sudo <Boolean>]
  [-enable_managed_uid <Boolean>] [-unix_uid <Int32>] [-unix_guid <Int32>] [-account_locked <Boolean>]
  [-passwordless_sudo <Boolean>] [-externally_managed <Boolean>] [-ldap_binding_user <Boolean>]
- [-enable_user_portal_multifactor <Boolean>] [-NumberOfCustomAttributes <Int32>] [-RemoveAttribute <String[]>]
- [-middlename <String>] [-displayname <String>] [-jobTitle <String>] [-employeeIdentifier <String>]
- [-department <String>] [-costCenter <String>] [-company <String>] [-employeeType <String>]
- [-description <String>] [-location <String>] [-work_streetAddress <String>] [-work_poBox <String>]
- [-work_locality <String>] [-work_region <String>] [-work_postalCode <String>] [-work_country <String>]
- [-home_streetAddress <String>] [-home_poBox <String>] [-home_locality <String>] [-home_region <String>]
- [-home_postalCode <String>] [-home_country <String>] [-mobile_number <String>] [-home_number <String>]
- [-work_number <String>] [-work_mobile_number <String>] [-work_fax_number <String>] [-external_dn <String>]
- [-external_source_type <String>] [-state <String>] [-manager <String>] [-managedAppleId <String>]
- [-alternateEmail <String>] [-recoveryEmail <String>]
- [-EnrollmentDays <Int32>] -Attribute1_name <String> -Attribute1_value <String> -Attribute2_name <String>
- -Attribute2_value <String> [<CommonParameters>]
+ [-enable_user_portal_multifactor <Boolean>] [-NumberOfCustomAttributes <Int32>]
+ [-RemoveCustomAttribute <String[]>] [-middlename <String>] [-displayname <String>] [-jobTitle <String>]
+ [-employeeIdentifier <String>] [-department <String>] [-costCenter <String>] [-company <String>]
+ [-employeeType <String>] [-description <String>] [-location <String>] [-work_streetAddress <String>]
+ [-work_poBox <String>] [-work_locality <String>] [-work_region <String>] [-work_postalCode <String>]
+ [-work_country <String>] [-home_streetAddress <String>] [-home_poBox <String>] [-home_locality <String>]
+ [-home_region <String>] [-home_postalCode <String>] [-home_country <String>] [-mobile_number <String>]
+ [-home_number <String>] [-work_number <String>] [-work_mobile_number <String>] [-work_fax_number <String>]
+ [-external_dn <String>] [-external_source_type <String>] [-state <String>] [-manager <String>]
+ [-managedAppleId <String>] [-alternateEmail <String>] [-recoveryEmail <String>]
+ [-EnrollmentDays <Int32>] -Attribute1_name <String>
+ -Attribute1_value <String> -Attribute2_name <String> -Attribute2_value <String> [<CommonParameters>]
 ```
 
 ### ByID
@@ -107,10 +107,10 @@ This example either updates or adds the Custom Attribute 'name = Department, val
 
 ### Example 5
 ```powershell
-PS C:\> Get-JCUserGroupMember -GroupName 'Sales' | Set-JCUser -RemoveAttribute Department
+PS C:\> Get-JCUserGroupMember -GroupName 'Sales' | Set-JCUser -RemoveCustomAttribute ATTRIBUTENAME
 ```
 
-This example removes the Custom Attribute with the name 'Department' from all JumpCloud Users in the JumpCloud User Group 'Sales'
+This example removes the Custom Attribute with the name 'ATTRIBUTENAME' from all JumpCloud Users in the JumpCloud User Group 'Sales'
 
 ### Example 6
 ```powershell
@@ -229,7 +229,7 @@ Accept wildcard characters: False
 ### -ByID
 Use the -ByID parameter when the UserID is being passed over the pipeline to the Set-JCUser function.
 The -ByID SwitchParameter will set the ParameterSet to 'ByID' which will increase the function speed and performance.
-You cannot use this with the 'RemoveAttribute' Parameter
+You cannot use this with the 'RemoveCustomAttribute' Parameter
 
 ```yaml
 Type: System.Management.Automation.SwitchParameter
@@ -792,14 +792,14 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -RemoveAttribute
+### -RemoveCustomAttribute
 The name of the existing Custom Attributes you wish to remove.
-See an EXAMPLE for working with the -RemoveAttribute Parameter in EXAMPLE 5
+See an EXAMPLE for working with the -RemoveCustomAttribute Parameter in EXAMPLE 5
 
 ```yaml
 Type: System.String[]
-Parameter Sets: RemoveAttribute
-Aliases:
+Parameter Sets: RemoveCustomAttribute
+Aliases: RemoveAttribute
 
 Required: False
 Position: Named
@@ -901,7 +901,7 @@ The Username of the JumpCloud user you wish to modify
 
 ```yaml
 Type: System.String
-Parameter Sets: Username, RemoveAttribute
+Parameter Sets: Username, RemoveCustomAttribute
 Aliases:
 
 Required: True

PowerShell/JumpCloud Module/JumpCloud.psd1

@@ -3,7 +3,7 @@
 #
 # Generated by: JumpCloud Solutions Architect Team
 #
-# Generated on: 8/8/2024
+# Generated on: 8/20/2024
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'JumpCloud.psm1'
 
 # Version number of this module.
-ModuleVersion = '2.13.0'
+ModuleVersion = '2.13.1'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

PowerShell/JumpCloud Module/Public/Users/Set-JCUser.ps1

@@ -12,8 +12,7 @@ Function Set-JCUser () {
         [Parameter(Mandatory,
             ValueFromPipelineByPropertyName = $true,
             Position = 0,
-            ParameterSetName = 'RemoveAttribute', HelpMessage = 'The Username of the JumpCloud user you wish to modify')]
-
+            ParameterSetName = 'RemoveCustomAttribute', HelpMessage = 'The Custom Attribute of the JumpCloud user you wish to modify')]
         [string]$Username,
 
         [Parameter(Mandatory,
@@ -94,11 +93,12 @@ UserID has an Alias of _id. This means you can leverage the PowerShell pipeline
         [int]
         $NumberOfCustomAttributes,
 
-        [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'RemoveAttribute', HelpMessage = 'The name of the existing Custom Attributes you wish to remove. See an EXAMPLE for working with the -RemoveAttribute Parameter in EXAMPLE 5')]
+        [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'RemoveCustomAttribute', HelpMessage = 'The name of the existing Custom Attributes you wish to remove. See an EXAMPLE for working with the -RemoveCustomAttribute Parameter in EXAMPLE 5')]
         [string[]]
-        $RemoveAttribute,
+        [Alias('RemoveAttribute')]
+        $RemoveCustomAttribute,
 
-        [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'ByID', HelpMessage = 'Use the -ByID parameter when the UserID is being passed over the pipeline to the Set-JCUser function. The -ByID SwitchParameter will set the ParameterSet to ''ByID'' which will increase the function speed and performance. You cannot use this with the ''RemoveAttribute'' Parameter')]
+        [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'ByID', HelpMessage = 'Use the -ByID parameter when the UserID is being passed over the pipeline to the Set-JCUser function. The -ByID SwitchParameter will set the ParameterSet to ''ByID'' which will increase the function speed and performance. You cannot use this with the ''RemoveCustomAttribute'' Parameter')]
         [switch]
         $ByID,
 
@@ -935,7 +935,7 @@ UserID has an Alias of _id. This means you can leverage the PowerShell pipeline
 
         }
 
-        elseif ($PSCmdlet.ParameterSetName -eq 'RemoveAttribute') {
+        elseif ($PSCmdlet.ParameterSetName -eq 'RemoveCustomAttribute') {
             if ($UserHash.Values.username -contains ($Username)) {
                 $URL_ID = $UserHash.GetEnumerator().Where({ $_.Value.username -contains ($Username) }).Name
                 Write-Debug $URL_ID
@@ -955,7 +955,7 @@ UserID has an Alias of _id. This means you can leverage the PowerShell pipeline
                         continue
                     }
 
-                    if ($param.key -eq 'RemoveAttribute') {
+                    if ($param.key -eq 'RemoveCustomAttribute') {
                         continue
                     }
 
@@ -1070,15 +1070,13 @@ UserID has an Alias of _id. This means you can leverage the PowerShell pipeline
                     $CurrentAttributesHash.Add($CurrentA.name, $CurrentA.value)
                 }
 
-                foreach ($Remove in $RemoveAttribute) {
+                foreach ($Remove in $RemoveCustomAttribute) {
                     if ($CurrentAttributesHash.ContainsKey($Remove)) {
-                        Write-Debug "$Remove is here"
+                        Write-Debug "$Remove is getting removed from custom attributes"
                         $CurrentAttributesHash.Remove($Remove)
                     }
                 }
 
-
-
                 $UpdatedAttributeArrayList = New-Object System.Collections.ArrayList
 
 

PowerShell/JumpCloud Module/Tests/ModuleValidation/HelpFiles.Tests.ps1

@@ -35,7 +35,11 @@ Describe -Tag:('ModuleValidation') 'Help File Tests' {
 
             $ModuleRoot = (Get-Item -Path:($PSScriptRoot)).Parent.Parent
             $ModuleRootFullName = $ModuleRoot.FullName
-            $HelpFilePopulation = Get-ChildItem -Path:($ModuleRootFullName + '/Docs/*.md') -Recurse
+            $excludeFunctions = @(
+                'Set-JCSettingsFile.md'
+                'Connect-JCOnline.md'
+            )
+            $HelpFilePopulation = Get-ChildItem -Path:($ModuleRootFullName + '/Docs/*.md') -Recurse -Exclude $excludeFunctions
 
             $HelpFilePopulation | ForEach-Object {
                 # File should exist

PowerShell/JumpCloud Module/Tests/Public/Users/Set-JCUser.Tests.ps1

@@ -375,6 +375,20 @@ Describe -Tag:('JCUser') "Set-JCUser - CustomAttributes 1.0" {
         Remove-JCUser -UserID $NewUser._id -ByID -Force
     }
     It "Removes a custom attribute from a User" {
+        $NewUser = New-RandomUserCustom -Attributes -Domain "delSetUser.$(New-RandomString -NumberOfChars 5)" | New-JCUser -NumberOfCustomAttributes 3
+        $UpdatedUser = Set-JCUser $NewUser.username -RemoveCustomAttribute 'Department'
+        [int]$NewUserAttr = $NewUser.attributes.name.count
+        [int]$UpdatedUserAttr = $UpdatedUser.attributes.name.count
+        $UpdatedUserAttr++
+        $match = if ($NewUserAttr -eq $UpdatedUserAttr) {
+            $true
+        } else {
+            $false
+        }
+        $match | Should -Be $true
+        Remove-JCUser -UserID $NewUser._id -ByID -Force
+    }
+    It "Removes a custom attribute from a User using the Alias 'RemoveAttribute'" {
         $NewUser = New-RandomUserCustom -Attributes -Domain "delSetUser.$(New-RandomString -NumberOfChars 5)" | New-JCUser -NumberOfCustomAttributes 3
         $UpdatedUser = Set-JCUser $NewUser.username -RemoveAttribute 'Department'
         [int]$NewUserAttr = $NewUser.attributes.name.count
@@ -1235,7 +1249,7 @@ Describe -Tag:('JCUser') "Set-JCuser users phoneNumbers and attributes 1.8.0" {
         $NewUser.phoneNumbers | Where-Object type -EQ work_mobile | Select-Object -ExpandProperty number | Should -Be "work_mobile_number"
         $NewUser.phoneNumbers | Where-Object type -EQ work_fax | Select-Object -ExpandProperty number | Should -Be "work_fax_number"
         $UpdatedUser = Set-JCUser -Username $NewUser.username -NumberOfCustomAttributes 1 -Attribute1_name 'attr1' -Attribute1_value 'one'
-        $UpdatedUser = Set-JCUser -Username $NewUser.username -RemoveAttribute 'attr1' -work_fax_number "new_work_fax_number"
+        $UpdatedUser = Set-JCUser -Username $NewUser.username -RemoveCustomAttribute 'attr1' -work_fax_number "new_work_fax_number"
         $UpdatedUser.phoneNumbers | Where-Object type -EQ mobile | Select-Object -ExpandProperty number | Should -Be "mobile_number"
         $UpdatedUser.phoneNumbers | Where-Object type -EQ home | Select-Object -ExpandProperty number | Should -Be "home_number"
         $UpdatedUser.phoneNumbers | Where-Object type -EQ work | Select-Object -ExpandProperty number | Should -Be "work_number"
@@ -1301,13 +1315,13 @@ Describe -Tag:('JCUser') "Set-JCUser MFA Enrollment periods 1.10" {
         $Newuser.mfa.exclusion | Should -Be $true
         $Newuser | Remove-JCUser -ByID -force
     }
-    It "Updates an existing user with enable_user_portal_multifactor -eq True with removeAttributes" {
+    It "Updates an existing user with enable_user_portal_multifactor -eq True with RemoveCustomAttributes" {
         $CreateUser = New-RandomUser -Domain "delSetUser.$(New-RandomString -NumberOfChars 5)" -Attributes | New-JCUser -NumberOfCustomAttributes 2
-        $NewUser = $CreateUser | Set-JCUser -enable_user_portal_multifactor $true -RemoveAttribute 'Department', 'Lang'
+        $NewUser = $CreateUser | Set-JCUser -enable_user_portal_multifactor $true -RemoveCustomAttribute 'Department', 'Lang'
         $Newuser.mfa.exclusion | Should -Be $true
         $Newuser | Remove-JCUser -ByID -force
     }
-    It "Updates an existing user with enable_user_portal_multifactor -eq True and a 7 days specified for EnrollmentDays with removeAttributes" {
+    It "Updates an existing user with enable_user_portal_multifactor -eq True and a 7 days specified for EnrollmentDays with RemoveCustomAttributes" {
         $CreateUser = New-RandomUser -Domain "delSetUser.$(New-RandomString -NumberOfChars 5)" | New-JCUser -enable_user_portal_multifactor $true
         $EnrollmentDays = 7
         $NewUser = $CreateUser | Set-JCUser -enable_user_portal_multifactor $true -EnrollmentDays $EnrollmentDays