Merge pull request #164 from TheJumpCloud/JumpCloudModule_1.15.0

Jump cloud module 1.15.0
TheJumpCloud · Oct 8, 2019 · 7ab243b · 7ab243b
2 parents eee7088 + 8b661da
commit 7ab243b
Show file tree

Hide file tree

Showing 48 changed files with 3,506 additions and 2,873 deletions.
diff --git a/PowerShell/JumpCloud Module/Docs/Connect-JCOnline.md b/PowerShell/JumpCloud Module/Docs/Connect-JCOnline.md
@@ -41,7 +41,7 @@ Using the "-Force" parameter the module update check is skipped. The '-Force' pa
 Connect-JCOnline -JumpCloudAPIKey lu8792c9d4y2398is1tb6h0b83ebf0e92s97t382 -JumpCloudOrgID 5b5o13o06tsand0c29a0t3s6 -force
 ```
 
-Providing the JumpCloudAPIKey key and the intended JumpCloudOrg ID to connect to multi tenant admins can skip the OrgID connection screen and directly connect to an Org.
+Providing the JumpCloudAPIKey key and the intended JumpCloudOrg ID to connect to multi tenant admins can skip the JumpCloudOrgID connection screen and directly connect to an Org.
 
 Using the "-Force" parameter the module update check is skipped. The '-Force' parameter should be used when using the JumpCloud module in scripts or other automation environments.
 

diff --git a/PowerShell/JumpCloud Module/Docs/Copy-JCAssociation.md b/PowerShell/JumpCloud Module/Docs/Copy-JCAssociation.md
@@ -0,0 +1,197 @@
+---
+external help file: JumpCloud-help.xml
+Module Name: JumpCloud
+online version: https://github.com/TheJumpCloud/support/wiki/Copy-JCAssociation
+schema: 2.0.0
+---
+
+# Copy-JCAssociation
+
+## SYNOPSIS
+Copy the associations from one object to another.
+
+## SYNTAX
+
+### ById (Default)
+```
+Copy-JCAssociation [-Type] <String> [-Force] [-Id] <String[]> [[-TargetId] <String>] [[-TargetName] <String>]
+ [-RemoveExisting] [-IncludeType <String[]>] [-ExcludeType <String[]>] [<CommonParameters>]
+```
+
+### ByName
+```
+Copy-JCAssociation [-Type] <String> [-Force] [-Name] <String[]> [[-TargetId] <String>] [[-TargetName] <String>]
+ [-RemoveExisting] [-IncludeType <String[]>] [-ExcludeType <String[]>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+This cmdlet will get the associations of an existing object and will copy those same associations over to a new object.
+
+## EXAMPLES
+
+### Example 1
+```powershell
+PS C:\> Copy-JCAssociation -Type:('user') -Id:('5cdaef60452f26365ca1fbd0') -TargetId:('5cdaef62de6bf35ce44ad777')
+```
+
+The command will remove all of 5cdaef62de6bf35ce44ad777 associations and will copy all of 5cdaef60452f26365ca1fbd0 associations to 5cdaef62de6bf35ce44ad777.
+
+### Example 2
+```powershell
+PS C:\> Copy-JCAssociation -Type:('user') -Name:('John') -TargetName:('Jim')
+```
+
+The command will remove all of Jim's associations and will copy all of John's associations to Jim.
+
+## PARAMETERS
+
+### -Force
+Bypass user prompts and dynamic ValidateSet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -Id
+The unique id of the object.
+
+```yaml
+Type: String[]
+Parameter Sets: ById
+Aliases: _id
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -Name
+The name of the object.
+
+```yaml
+Type: String[]
+Parameter Sets: ByName
+Aliases: displayName, username
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -TargetId
+The unique id of the target object.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 10
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -TargetName
+The name of the target object.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 11
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -Type
+The type of the object.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases: TypeNameSingular
+Accepted values: command, ldap_server, policy, application, radius_server, system_group, system, user_group, user, g_suite, office_365
+
+Required: True
+Position: 0
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -RemoveExisting
+Removes the existing associations while still adding the new associations.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -ExcludeType
+Specify the association types to exclude from the copy.
+
+```yaml
+Type: String[]
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -IncludeType
+Specify the association types to include in the copy.
+
+```yaml
+Type: String[]
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+### System.String
+### System.Management.Automation.SwitchParameter
+### System.String[]
+## OUTPUTS
+
+### System.Object
+## NOTES
+
+## RELATED LINKS
diff --git a/PowerShell/JumpCloud Module/Docs/Get-JCOrganization.md b/PowerShell/JumpCloud Module/Docs/Get-JCOrganization.md
@@ -17,7 +17,7 @@ Get-JCOrganization [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-The Get-JCOrganization command displays all JumpCloud organizations associated with the authenticated JumpCloud admins. JumpCloud admins configured for multi tenant administration can see the Organizations they have access to and the displayName and OrgID for these accounts.
+The Get-JCOrganization command displays all JumpCloud organizations associated with the authenticated JumpCloud admins. JumpCloud admins configured for multi tenant administration can see the Organizations they have access to and the displayName and JumpCloudOrgID for these accounts.
 
 ## EXAMPLES
 

diff --git a/PowerShell/JumpCloud Module/Docs/Get-JCUser.md b/PowerShell/JumpCloud Module/Docs/Get-JCUser.md
@@ -19,11 +19,12 @@ Get-JCUser [[-username] <String>] [-firstname <String>] [-lastname <String>] [-e
  [-activated <Boolean>] [-password_expired <Boolean>] [-account_locked <Boolean>]
  [-passwordless_sudo <Boolean>] [-externally_managed <Boolean>] [-ldap_binding_user <Boolean>]
  [-enable_user_portal_multifactor <Boolean>] [-totp_enabled <Boolean>] [-allow_public_key <Boolean>]
- [-samba_service_user <Boolean>] [-password_never_expires <Boolean>] [-filterDateProperty <String>]
- [-returnProperties <String[]>] [-middlename <String>] [-displayname <String>] [-jobTitle <String>]
- [-employeeIdentifier <String>] [-department <String>] [-costCenter <String>] [-company <String>]
- [-employeeType <String>] [-description <String>] [-location <String>] [-external_dn <String>]
- [-external_source_type <String>] -dateFilter <String> -date <String> [<CommonParameters>]
+ [-samba_service_user <Boolean>] [-password_never_expires <Boolean>] [-suspended <Boolean>]
+ [-filterDateProperty <String>] [-returnProperties <String[]>] [-middlename <String>] [-displayname <String>]
+ [-jobTitle <String>] [-employeeIdentifier <String>] [-department <String>] [-costCenter <String>]
+ [-company <String>] [-employeeType <String>] [-description <String>] [-location <String>]
+ [-external_dn <String>] [-external_source_type <String>] -dateFilter <String> -date <String>
+ [<CommonParameters>]
 ```
 
 ### ByID
@@ -500,7 +501,7 @@ 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.
-Valid properties that can be returned are: 'created', 'password_expiration_date', 'account_locked', 'activated', 'addresses', 'allow_public_key', 'attributes', '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'
+Valid properties that can be returned are: 'created', 'password_expiration_date', 'account_locked', 'activated', 'addresses', 'allow_public_key', 'attributes', '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','suspended'
 
 ```yaml
 Type: String[]
@@ -624,6 +625,21 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -suspended
+A search filter to show accounts that are enabled ($true) or disabled ($false) for password_never_expires
+
+```yaml
+Type: Boolean
+Parameter Sets: SearchFilter
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### CommonParameters
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
 

diff --git a/PowerShell/JumpCloud Module/Docs/New-JCUser.md b/PowerShell/JumpCloud Module/Docs/New-JCUser.md
@@ -24,8 +24,9 @@ New-JCUser -firstname <String> -lastname <String> -username <String> -email <Str
  [-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>] [-enrollmentDays <Int32>] -Attribute1_name <String>
- -Attribute1_value <String> -Attribute2_name <String> -Attribute2_value <String> [<CommonParameters>]
+ [-work_mobile_number <String>] [-work_fax_number <String>] [-suspended <Boolean>] [-enrollmentDays <Int32>]
+ -Attribute1_name <String> -Attribute1_value <String> -Attribute2_name <String> -Attribute2_value <String>
+ [<CommonParameters>]
 ```
 
 ### Attributes
@@ -40,9 +41,9 @@ New-JCUser -firstname <String> -lastname <String> -username <String> -email <Str
  [-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>] [-enrollmentDays <Int32>]
- -Attribute1_name <String> -Attribute1_value <String> -Attribute2_name <String> -Attribute2_value <String>
- [<CommonParameters>]
+ [-work_number <String>] [-work_mobile_number <String>] [-work_fax_number <String>] [-suspended <Boolean>]
+ [-enrollmentDays <Int32>] -Attribute1_name <String> -Attribute1_value <String> -Attribute2_name <String>
+ -Attribute2_value <String> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -819,6 +820,21 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -suspended
+A boolean $true/$false value for putting the account into a suspended state
+
+```yaml
+Type: Boolean
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### CommonParameters
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
 

diff --git a/PowerShell/JumpCloud Module/Docs/Remove-JCAssociation.md b/PowerShell/JumpCloud Module/Docs/Remove-JCAssociation.md
@@ -20,7 +20,7 @@ Remove-JCAssociation [-Type] <String> [-Force] [-Id] <String[]> [[-TargetType] <
 
 ### ByName
 ```
-Remove-JCAssociation [-Type] <String> [-Force] -Name <String[]> [[-TargetType] <String[]>]
+Remove-JCAssociation [-Type] <String> [-Force] [-Name] <String[]> [[-TargetType] <String[]>]
  [[-TargetId] <String>] [[-TargetName] <String>] [<CommonParameters>]
 ```
 
@@ -75,6 +75,21 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -Name
+The name of the object.
+
+```yaml
+Type: String[]
+Parameter Sets: ByName
+Aliases: displayName, username
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -TargetId
 The unique id of the target object.
 
@@ -137,21 +152,6 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -Name
-The name of the object.
-
-```yaml
-Type: String[]
-Parameter Sets: ByName
-Aliases: displayName, username
-
-Required: True
-Position: Named
-Default value: None
-Accept pipeline input: True (ByPropertyName)
-Accept wildcard characters: False
-```
-
 ### CommonParameters
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).