Merge pull request #376 from TheJumpCloud/JumpCloudModule_1.21.0

JumpCloud Module 1.21.0

.circleci/workflows.yml

@@ -32,7 +32,7 @@ parameters:
     description: 'Release Type. Accepted values [ Major, Minor, Patch ]'
     type: enum
     enum: ["Major", "Minor", "Patch"]
-    default: "Patch"
+    default: "Minor"
   RequiredModulesRepo:
     description: 'PowerShell Repository for JumpCloud SDKs'
     type: enum
@@ -45,7 +45,7 @@ parameters:
   PublishToPSGallery:
     description: 'When `true` and when run against Master branch, this workflow will publish the latest code to PSGallery'
     type: boolean
-    default: false
+    default: true
   ManualModuleVersion:
     description: 'When `true` the pipeline will use the Module Version specified in JumpCloud Module JumpCloud.psd1 file'
     type: boolean

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

@@ -24,7 +24,7 @@ Get-JCUser [[-username] <String>] [-firstname <String>] [-lastname <String>] [-e
  [-employeeIdentifier <String>] [-department <String>] [-costCenter <String>] [-company <String>]
  [-employeeType <String>] [-description <String>] [-location <String>] [-external_dn <String>]
  [-external_source_type <String>] [-managedAppleId <String>] [-manager <String>] [-state <String>]
- -dateFilter <String> -date <DateTime> [<CommonParameters>]
+ [-recoveryEmail <String>] -dateFilter <String> -date <DateTime> [<CommonParameters>]
 ```
 
 ### ByID
@@ -528,6 +528,21 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -recoveryEmail
+The recovery email of the JumpCloud user you wish to search for.
+
+```yaml
+Type: System.String
+Parameter Sets: SearchFilter
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -returnProperties
 Allows you to return select properties on JumpCloud user objects.
 Specifying what properties are returned can drastically increase the speed of the API call with a large data set.
@@ -537,7 +552,7 @@ Valid properties that can be returned are: 'created', 'password_expiration_date'
 Type: System.String[]
 Parameter Sets: SearchFilter
 Aliases:
-Accepted values: created, password_expiration_date, account_locked, activated, addresses, allow_public_key, attributes, alternateEmail, managedAppleId, manager, email, enable_managed_uid, enable_user_portal_multifactor, externally_managed, firstname, lastname, ldap_binding_user, passwordless_sudo, password_expired, password_never_expires, phoneNumbers, samba_service_user, ssh_keys, sudo, totp_enabled, unix_guid, unix_uid, username, middlename, displayname, jobTitle, employeeIdentifier, department, costCenter, company, employeeType, description, location, external_source_type, external_dn, suspended, mfa
+Accepted values: created, password_expiration_date, account_locked, activated, addresses, allow_public_key, attributes, alternateEmail, recoveryEmail, managedAppleId, manager, email, enable_managed_uid, enable_user_portal_multifactor, externally_managed, firstname, lastname, ldap_binding_user, passwordless_sudo, password_expired, password_never_expires, phoneNumbers, samba_service_user, ssh_keys, sudo, totp_enabled, unix_guid, unix_uid, username, middlename, displayname, jobTitle, employeeIdentifier, department, costCenter, company, employeeType, description, location, external_source_type, external_dn, suspended, mfa, recoveryEmail
 
 Required: False
 Position: Named

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: 1.20.1
+Help Version: 1.21.0
 Locale: en-US
 ---
 

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

@@ -25,8 +25,9 @@ New-JCUser -firstname <String> -lastname <String> -username <String> -email <Str
  [-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>] [-state <String>] [-manager <String>]
- [-managedAppleId <String>] [-alternateEmail <String>] [-enrollmentDays <Int32>] -Attribute1_name <String>
- -Attribute1_value <String> -Attribute2_name <String> -Attribute2_value <String> [<CommonParameters>]
+ [-managedAppleId <String>] [-alternateEmail <String>] [-recoveryEmail <String>] [-enrollmentDays <Int32>]
+ -Attribute1_name <String> -Attribute1_value <String> -Attribute2_name <String> -Attribute2_value <String>
+ [<CommonParameters>]
 ```
 
 ### Attributes
@@ -42,9 +43,9 @@ New-JCUser -firstname <String> -lastname <String> -username <String> -email <Str
  [-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>] [-state <String>]
- [-manager <String>] [-managedAppleId <String>] [-alternateEmail <String>] [-enrollmentDays <Int32>]
- -Attribute1_name <String> -Attribute1_value <String> -Attribute2_name <String> -Attribute2_value <String>
- [<CommonParameters>]
+ [-manager <String>] [-managedAppleId <String>] [-alternateEmail <String>] [-recoveryEmail <String>]
+ [-enrollmentDays <Int32>] -Attribute1_name <String> -Attribute1_value <String> -Attribute2_name <String>
+ -Attribute2_value <String> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -658,6 +659,21 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -recoveryEmail
+The recoveryEmail for the user
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -state
 A string value for putting the account into a staged, activated or suspended state
 

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

@@ -27,8 +27,8 @@ Set-JCUser [-Username] <String> [-email <String>] [-firstname <String>] [-lastna
  [-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>] [-EnrollmentDays <Int32>] -Attribute1_name <String> -Attribute1_value <String>
- -Attribute2_name <String> -Attribute2_value <String> [<CommonParameters>]
+ [-alternateEmail <String>] [-recoveryEmail <String>] [-EnrollmentDays <Int32>] -Attribute1_name <String>
+ -Attribute1_value <String> -Attribute2_name <String> -Attribute2_value <String> [<CommonParameters>]
 ```
 
 ### RemoveAttribute
@@ -46,8 +46,8 @@ Set-JCUser [-Username] <String> [-email <String>] [-firstname <String>] [-lastna
  [-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>] [-EnrollmentDays <Int32>] -Attribute1_name <String> -Attribute1_value <String>
- -Attribute2_name <String> -Attribute2_value <String> [<CommonParameters>]
+ [-alternateEmail <String>] [-recoveryEmail <String>] [-EnrollmentDays <Int32>] -Attribute1_name <String>
+ -Attribute1_value <String> -Attribute2_name <String> -Attribute2_value <String> [<CommonParameters>]
 ```
 
 ### ByID
@@ -65,8 +65,8 @@ Set-JCUser -UserID <String> [-email <String>] [-firstname <String>] [-lastname <
  [-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>] [-EnrollmentDays <Int32>] -Attribute1_name <String> -Attribute1_value <String>
- -Attribute2_name <String> -Attribute2_value <String> [<CommonParameters>]
+ [-alternateEmail <String>] [-recoveryEmail <String>] [-EnrollmentDays <Int32>] -Attribute1_name <String>
+ -Attribute1_value <String> -Attribute2_name <String> -Attribute2_value <String> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -774,6 +774,21 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -recoveryEmail
+The recoveryEmail for the user
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -RemoveAttribute
 The name of the existing Custom Attributes you wish to remove.
 See an EXAMPLE for working with the -RemoveAttribute Parameter in EXAMPLE 5

PowerShell/JumpCloud Module/JumpCloud.psd1

@@ -3,7 +3,7 @@
 #
 # Generated by: JumpCloud Solutions Architect Team
 #
-# Generated on: 4/28/2022
+# Generated on: 5/10/2022
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'JumpCloud.psm1'
 
 # Version number of this module.
-ModuleVersion = '1.20.1'
+ModuleVersion = '1.21.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()