-
Notifications
You must be signed in to change notification settings - Fork 164
Cut 5073 migrate jumpcloud power shell modules to use specific endpoints #724
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: 3.1.0_pwshModule
Are you sure you want to change the base?
Changes from all commits
b144097
065349d
0cb42de
4cebb5a
12eeff0
dbc318f
3700efa
42c557f
572a405
242f575
d49ae8d
26fa983
7d7cb51
376f62a
5b4ad5c
fd197c3
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,7 @@ | |
| # | ||
| # Generated by: JumpCloud Solutions Architect Team | ||
| # | ||
| # Generated on: 1/22/2026 | ||
| # Generated on: 3/12/2026 | ||
| # | ||
|
|
||
| @{ | ||
|
|
@@ -12,7 +12,7 @@ | |
| RootModule = 'JumpCloud.psm1' | ||
|
|
||
| # Version number of this module. | ||
| ModuleVersion = '3.0.2' | ||
| ModuleVersion = '3.1.0' | ||
|
|
||
| # Supported PSEditions | ||
| # CompatiblePSEditions = @() | ||
|
|
@@ -51,8 +51,8 @@ PowerShellVersion = '4.0' | |
| # ProcessorArchitecture = '' | ||
|
|
||
| # Modules that must be imported into the global environment prior to importing this module | ||
| RequiredModules = @('JumpCloud.SDK.DirectoryInsights', | ||
| 'JumpCloud.SDK.V1', | ||
| RequiredModules = @('JumpCloud.SDK.DirectoryInsights', | ||
| 'JumpCloud.SDK.V1', | ||
| 'JumpCloud.SDK.V2') | ||
|
|
||
| # Assemblies that must be loaded prior to importing this module | ||
|
|
@@ -71,42 +71,43 @@ RequiredModules = @('JumpCloud.SDK.DirectoryInsights', | |
| # NestedModules = @() | ||
|
|
||
| # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. | ||
| FunctionsToExport = 'Add-JCAssociation', 'Add-JCCommandTarget', 'Add-JCGsuiteMember', | ||
| 'Add-JCOffice365Member', 'Add-JCRadiusReplyAttribute', | ||
| 'Add-JCSystemGroupMember', 'Add-JCSystemUser', | ||
| 'Add-JCUserGroupMember', 'Backup-JCOrganization', 'Connect-JCOnline', | ||
| 'Copy-JCAssociation', 'Get-JCAdmin', 'Get-JCAssociation', | ||
| 'Get-JCBackup', 'Get-JCCloudDirectory', 'Get-JCCommand', | ||
| 'Get-JCCommandResult', 'Get-JCCommandTarget', | ||
| 'Get-JCConfiguredTemplatePolicy', 'Get-JCEvent', 'Get-JCEventCount', | ||
| 'Get-JCGroup', 'Get-JCOrganization', 'Get-JCPolicy', | ||
| 'Get-JCPolicyGroup', 'Get-JCPolicyGroupMember', | ||
| 'Get-JCPolicyGroupTemplate', 'Get-JCPolicyGroupTemplateMember', | ||
| 'Get-JCPolicyResult', 'Get-JCPolicyTargetGroup', | ||
| 'Get-JCPolicyTargetSystem', 'Get-JCRadiusReplyAttribute', | ||
| 'Get-JCRadiusServer', 'Get-JCReport', 'Get-JCScheduledUserstate', | ||
| 'Get-JCSystem', 'Get-JCSystemApp', 'Get-JCSystemGroupMember', | ||
| 'Get-JCSystemInsights', 'Get-JCSystemKB', 'Get-JCSystemUser', | ||
| 'Get-JCUser', 'Get-JCUserGroupMember', 'Import-JCCommand', | ||
| 'Import-JCMSPFromCSV', 'Import-JCUsersFromCSV', 'Invoke-JCCommand', | ||
| 'Invoke-JCDeployment', 'New-JCCommand', 'New-JCDeploymentTemplate', | ||
| 'New-JCDeviceUpdateTemplate', 'New-JCImportTemplate', | ||
| 'New-JCMSPImportTemplate', 'New-JCPolicy', 'New-JCPolicyGroup', | ||
| 'New-JCRadiusServer', 'New-JCReport', 'New-JCSystemGroup', 'New-JCUser', | ||
| 'New-JCUserGroup', 'Remove-JCAssociation', 'Remove-JCCommand', | ||
| 'Remove-JCCommandResult', 'Remove-JCCommandTarget', | ||
| 'Remove-JCGsuiteMember', 'Remove-JCOffice365Member', | ||
| 'Remove-JCPolicy', 'Remove-JCPolicyGroup', | ||
| 'Remove-JCPolicyGroupTemplate', 'Remove-JCRadiusReplyAttribute', | ||
| 'Remove-JCRadiusServer', 'Remove-JCSystem', 'Remove-JCSystemGroup', | ||
| 'Remove-JCSystemGroupMember', 'Remove-JCSystemUser', 'Remove-JCUser', | ||
| 'Remove-JCUserGroup', 'Remove-JCUserGroupMember', | ||
| 'Send-JCPasswordReset', 'Set-JCCloudDirectory', 'Set-JCCommand', | ||
| 'Set-JCOrganization', 'Set-JCPolicy', 'Set-JCPolicyGroup', | ||
| 'Set-JCRadiusReplyAttribute', 'Set-JCRadiusServer', | ||
| 'Set-JCSettingsFile', 'Set-JCSystem', 'Set-JCSystemUser', 'Set-JCUser', | ||
| 'Set-JCUserGroupLDAP', 'Update-JCDeviceFromCSV', 'Update-JCModule', | ||
| 'Update-JCMSPFromCSV', 'Update-JCUsersFromCSV' | ||
| FunctionsToExport = 'Add-JCAssociation', 'Add-JCCommandTarget', 'Add-JCGsuiteMember', | ||
| 'Add-JCOffice365Member', 'Add-JCRadiusReplyAttribute', | ||
| 'Add-JCSystemGroupMember', 'Add-JCSystemUser', | ||
| 'Add-JCUserGroupMember', 'Backup-JCOrganization', 'Connect-JCOnline', | ||
| 'Copy-JCAssociation', 'Get-JCAdmin', 'Get-JCAssociation', | ||
| 'Get-JCBackup', 'Get-JCCloudDirectory', 'Get-JCCommand', | ||
| 'Get-JCCommandResult', 'Get-JCCommandTarget', | ||
| 'Get-JCConfiguredTemplatePolicy', 'Get-JCEvent', 'Get-JCEventCount', | ||
| 'Get-JCGroup', 'Get-JCOrganization', 'Get-JCPolicy', | ||
| 'Get-JCPolicyGroup', 'Get-JCPolicyGroupMember', | ||
| 'Get-JCPolicyGroupTemplate', 'Get-JCPolicyGroupTemplateMember', | ||
| 'Get-JCPolicyResult', 'Get-JCPolicyTargetGroup', | ||
| 'Get-JCPolicyTargetSystem', 'Get-JCRadiusReplyAttribute', | ||
| 'Get-JCRadiusServer', 'Get-JCReport', 'Get-JCScheduledUserstate', | ||
| 'Get-JCSystem', 'Get-JCSystemApp', 'Get-JCSystemGroupMember', | ||
| 'Get-JCSystemInsights', 'Get-JCSystemKB', 'Get-JCSystemUser', | ||
| 'Get-JCUser', 'Get-JCUserGroupMember', 'Import-JCCommand', | ||
| 'Import-JCMSPFromCSV', 'Import-JCUsersFromCSV', 'Invoke-JCCommand', | ||
| 'Invoke-JCDeployment', 'New-JCCommand', 'New-JCDeploymentTemplate', | ||
| 'New-JCDeviceUpdateTemplate', 'New-JCImportTemplate', | ||
| 'New-JCMSPImportTemplate', 'New-JCPolicy', 'New-JCPolicyGroup', | ||
| 'New-JCRadiusServer', 'New-JCReport', 'New-JCSystemGroup', 'New-JCUser', | ||
| 'New-JCUserGroup', 'Remove-JCAssociation', 'Remove-JCCommand', | ||
| 'Remove-JCCommandResult', 'Remove-JCCommandTarget', | ||
| 'Remove-JCGsuiteMember', 'Remove-JCOffice365Member', | ||
| 'Remove-JCPolicy', 'Remove-JCPolicyGroup', | ||
| 'Remove-JCPolicyGroupTemplate', 'Remove-JCRadiusReplyAttribute', | ||
| 'Remove-JCRadiusServer', 'Remove-JCSystem', 'Remove-JCSystemGroup', | ||
| 'Remove-JCSystemGroupMember', 'Remove-JCSystemUser', 'Remove-JCUser', | ||
| 'Remove-JCUserGroup', 'Remove-JCUserGroupMember', | ||
| 'Send-JCPasswordReset', 'Set-JCCloudDirectory', 'Set-JCCommand', | ||
| 'Set-JCOrganization', 'Set-JCPolicy', 'Set-JCPolicyGroup', | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| 'Set-JCRadiusReplyAttribute', 'Set-JCRadiusServer', | ||
| 'Set-JCSettingsFile', 'Set-JCSystem', 'Set-JCSystemUser', 'Set-JCUser', | ||
| 'Set-JCUserGroupLDAP', 'Update-JCDeviceFromCSV', 'Update-JCModule', | ||
| 'Update-JCMSPFromCSV', 'Update-JCUsersFromCSV', 'Get-JCSystemGroup', | ||
| 'Get-JCUserGroup', 'Set-JCPolicyGroupMember' | ||
|
|
||
| # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. | ||
| CmdletsToExport = @() | ||
|
|
@@ -132,7 +133,7 @@ PrivateData = @{ | |
| PSData = @{ | ||
|
|
||
| # Tags applied to this module. These help with module discovery in online galleries. | ||
| Tags = 'JumpCloud', 'DaaS', 'Jump', 'Cloud', 'Directory' | ||
| Tags = 'JumpCloud','DaaS','Jump','Cloud','Directory' | ||
|
|
||
| # A URL to the license for this module. | ||
| LicenseUri = 'https://github.com/TheJumpCloud/support/blob/master/PowerShell/LICENSE' | ||
|
|
@@ -157,7 +158,7 @@ PrivateData = @{ | |
|
|
||
| } # End of PSData hashtable | ||
|
|
||
| } # End of PrivateData hashtable | ||
| } # End of PrivateData hashtable | ||
|
|
||
| # HelpInfo URI of this module | ||
| HelpInfoURI = 'https://github.com/TheJumpCloud/support/wiki' | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,38 +11,10 @@ Query the API for Directory Insights events | |
| ``` | ||
| curl -X POST 'https://api.jumpcloud.com/insights/directory/v1/events' -H 'Content-Type: application/json' -H 'x-api-key: REPLACE_KEY_VALUE' --data '{\"service\": [\"all\"], \"start_time\": \"2021-07-14T23:00:00Z\", \"end_time\": \"2021-07-28T14:00:00Z\", \"sort\": \"DESC\", \"fields\": [\"timestamp\", \"event_type\", \"initiated_by\", \"success\", \"client_ip\", \"provider\", \"organization\"]}' | ||
| ``` | ||
| .Example | ||
| PS C:\> Get-JCEvent -Service:('all') -StartTime:((Get-date).AddDays(-30)) | ||
|
|
||
| Pull all event records from the last thirty days | ||
| .Example | ||
| PS C:\> Get-JCEvent -Service:('directory') -StartTime:((Get-date).AddHours(-1)) -Limit:('10') | ||
|
|
||
| Get directory results from the last hour limit to the last 10 results in the time range | ||
| .Example | ||
| PS C:\> Get-JCEvent -Service:('directory') -StartTime:((Get-date).AddDays(-30)) -Sort:("DESC") -EndTime:((Get-date).AddDays(-5)) | ||
|
|
||
| Get directory results between 30 and 5 days ago, sort timestamp by descending value | ||
| .Example | ||
| PS C:\> Get-JCEvent -Service:('directory') -StartTime:((Get-date).AddDays(-30)) -Limit:('10') -searchTermAnd:@{"event_type" = "group_create"} | ||
|
|
||
| Get only group_create from the last thirty days | ||
| .Example | ||
| PS C:\> Get-JCEvent -Service:('all') -StartTime:('2020-04-14T00:00:00Z') -EndTime:('2020-04-20T23:00:00Z') -SearchTermOr @{"initiated_by.username" = @("user.1", "user.2")} | ||
|
|
||
| Get login events initiated by either "user.1" or "user.2" between a universal time zone range | ||
| .Example | ||
| PS C:\> Get-JCEvent -Service:('all') -StartTime:('2020-04-14T00:00:00Z') -EndTime:('2020-04-20T23:00:00Z') -SearchTermAnd @{"event_type" = "admin_login_attempt"; "resource.email" = "admin.user@adminbizorg.com"} | ||
|
|
||
| Get all events between a date range and match event_type = admin_login_attempt and resource.email = admin.user@adminbizorg.com | ||
| .Example | ||
| PS C:\> Get-JCEvent -Service:('sso') -StartTime:('2020-04-14T00:00:00Z') -EndTime:('2020-04-20T23:00:00Z') -SearchTermAnd @{"initiated_by.username" = "user.1"} | ||
|
|
||
| Get sso events with the search term initiated_by: username with value "user.1" | ||
| .Example | ||
| PS C:\> Get-JCEvent -Service:('all') -StartTime:('2020-04-14T00:00:00Z') -EndTime:('2020-04-20T23:00:00Z') -SearchTermAnd @{"event_type" = "organization_update"} | ||
|
|
||
| Get all events filtered by organization_update term between a date range | ||
| .Example | ||
| Get-JCEvent -Service:(<string[]>) -StartTime:(<datetime>) -EndTime:(<datetime>) -ExactMatch:(<string>) -Fields:(<string[]>) -Limit:(<long>) -Q:(<string>) -SearchAfter:(<string[]>) -SearchTermAnd:(<hashtable>) -SearchTermNot:(<hashtable>) -SearchTermOr:(<hashtable>) -Skip:(<long>) -Sort:(<string>) | ||
| .Example | ||
| Get-JCEvent -Body:(<JumpCloud.SDK.DirectoryInsights.Models.EventQuery>) | ||
|
|
||
| .Inputs | ||
| JumpCloud.SDK.DirectoryInsights.Models.IEventQuery | ||
|
|
@@ -69,7 +41,7 @@ BODY <IEventQuery>: EventQuery is the users' command to search our auth logs | |
| [Skip <Int64?>]: optional offset into the result set to start with when returning | ||
| [Sort <String>]: ASC or DESC order for timestamp | ||
| .Link | ||
| https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEvent.md | ||
| https://github.com/TheJumpCloud/jcapi-powershell/tree/CUT-4981_v2EUSupport/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEvent.md | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Documentation links point to feature branch not masterLow Severity The Additional Locations (1)
|
||
| #> | ||
| Function Get-JCEvent { | ||
| [OutputType([JumpCloud.SDK.DirectoryInsights.Models.IPost200ApplicationJsonItemsItem])] | ||
|
|
||


Uh oh!
There was an error while loading. Please reload this page.