JIM.psm1
|
#Requires -Version 7.0 # Copyright (c) Tetron Limited. All rights reserved. # Licensed under the Tetron Commercial License. See LICENSE file in the project root. <# .SYNOPSIS JIM PowerShell Module - Administration module for Junctional Identity Manager .DESCRIPTION This module provides cmdlets for administering JIM (Junctional Identity Manager) from the command line. It enables automation, scripting, and integration testing of JIM configurations. Features: - Connection management with API key authentication - Connected Systems management - Synchronisation Rules configuration - Run Profile execution - Metaverse object queries - Activity monitoring - Certificate management - And more... .NOTES Author: Tetron Project: https://github.com/TetronIO/JIM #> # Module-level variables for connection state $script:JIMConnection = $null # Pagination safety limits for -All auto-pagination (see issue #487). # JIMMaxAllPages caps how many pages -All will fetch before stopping (unless -Force is supplied), # bounding a runaway sequential fetch. At the maximum page size of 100 this is ~100,000 objects. This is a # client-side courtesy limit against a surprise long-running command, and -Force overrides it. # JIMMaxRetrievalDepth mirrors the server's hard ceiling (PaginationLimits.MaxSkip): the API rejects any # request that would skip more than this many rows, with a 400. -Force cannot override this one, so the # fetch loop stops cleanly on reaching it rather than failing mid-fetch on an HTTP error. Keep in step with # PaginationLimits.MaxSkip in src/JIM.Web/Models/Api/PaginationLimits.cs. # JIMAllWarningThreshold is the total-object count above which -All emits an up-front warning that a # large sequential fetch is under way, so a caller is not surprised by a long-running command. $script:JIMMaxAllPages = 1000 $script:JIMMaxRetrievalDepth = 1000000 $script:JIMAllWarningThreshold = 10000 # What replaces a credential-shaped value before a request body reaches the debug stream. A fixed # marker rather than anything derived from the value, so not even its length survives redaction. # See Private/Get-JIMRedactedBody.ps1. $script:JIMRedactionMarker = '<redacted>' # Get public and private function definition files $Public = @(Get-ChildItem -Path "$PSScriptRoot/Public" -Recurse -Filter '*.ps1' -ErrorAction SilentlyContinue) $Private = @(Get-ChildItem -Path "$PSScriptRoot/Private" -Recurse -Filter '*.ps1' -ErrorAction SilentlyContinue) # Dot source the files foreach ($import in @($Public + $Private)) { try { Write-Verbose "Importing $($import.FullName)" . $import.FullName } catch { Write-Error "Failed to import function $($import.FullName): $_" } } # Cmdlet-level aliases (distinct from parameter aliases; see src/JIM.PowerShell/CLAUDE.md for those). Declared # centrally so every alias is visible in one place, alongside the AliasesToExport list in JIM.psd1. Set-Alias -Name Get-JIMConnectedSystemDomainController -Value Get-JIMConnectedSystemDirectoryServer # Export public functions Export-ModuleMember -Function $Public.BaseName -Alias Get-JIMConnectedSystemDomainController |