From 08749cf279feed79945725e88c4ac7313fa86382 Mon Sep 17 00:00:00 2001 From: Joe Workman Date: Mon, 11 May 2026 08:55:48 -0600 Subject: [PATCH 01/11] skip-api-transform --- .github/workflows/jcapi-powershell-ci.yml | 25 ++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/.github/workflows/jcapi-powershell-ci.yml b/.github/workflows/jcapi-powershell-ci.yml index 4d07690d8..91c93008d 100644 --- a/.github/workflows/jcapi-powershell-ci.yml +++ b/.github/workflows/jcapi-powershell-ci.yml @@ -22,6 +22,8 @@ jobs: V1: ${{ steps.set_labels.outputs.V1 }} V2: ${{ steps.set_labels.outputs.V2 }} DIRECTORYINSIGHTS: ${{ steps.set_labels.outputs.DIRECTORYINSIGHTS }} + # When PR has label skip-api-transform, BuildAutoRest runs with -RunApiTransform:$false + SKIP_API_TRANSFORM: ${{ steps.set_labels.outputs.SKIP_API_TRANSFORM }} steps: - name: Set Environment Variables from PR Labels id: set_labels @@ -74,6 +76,14 @@ jobs: Write-Host "Module label 'DirectoryInsights' found" echo "directoryinsights=true" >> $env:GITHUB_OUTPUT } + + # Optional: skip ApiTransform.ps1 (remote spec fetch + JSON transforms) during CI builds + if ('skip-api-transform' -in $PR_LABEL_LIST) { + Write-Host "Label 'skip-api-transform' found: BuildAutoRest will use -RunApiTransform:`$false" + echo "SKIP_API_TRANSFORM=true" >> $env:GITHUB_OUTPUT + } else { + echo "SKIP_API_TRANSFORM=false" >> $env:GITHUB_OUTPUT + } env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -157,6 +167,8 @@ jobs: if: contains(github.event.pull_request.labels.*.name, 'DirectoryInsights') runs-on: ubuntu-latest timeout-minutes: 70 + env: + SKIP_API_TRANSFORM: ${{ needs.Check-PR-Labels.outputs.SKIP_API_TRANSFORM }} steps: - uses: actions/checkout@v4 - uses: actions/cache@v3 @@ -166,7 +178,8 @@ jobs: - name: Build JumpCloud.SDK.DirectoryInsights shell: pwsh run: | - ./BuildAutoRest -SDKName:("JumpCloud.SDK.DirectoryInsights") -ModuleVersionIncrementType "${{ needs.Check-PR-Labels.outputs.RELEASE_TYPE }}" + $runApiTransform = $env:SKIP_API_TRANSFORM -ne 'true' + ./BuildAutoRest -SDKName:("JumpCloud.SDK.DirectoryInsights") -ModuleVersionIncrementType "${{ needs.Check-PR-Labels.outputs.RELEASE_TYPE }}" -RunApiTransform:$runApiTransform - name: Pack JumpCloud.SDK.DirectoryInsights Module shell: pwsh run: | @@ -195,6 +208,8 @@ jobs: if: contains(github.event.pull_request.labels.*.name, 'v1') runs-on: ubuntu-latest timeout-minutes: 70 + env: + SKIP_API_TRANSFORM: ${{ needs.Check-PR-Labels.outputs.SKIP_API_TRANSFORM }} steps: - uses: actions/checkout@v4 - uses: actions/cache@v3 @@ -204,7 +219,8 @@ jobs: - name: Build JumpCloud.SDK.V1 shell: pwsh run: | - ./BuildAutoRest -SDKName:("JumpCloud.SDK.V1") -ModuleVersionIncrementType "${{ needs.Check-PR-Labels.outputs.RELEASE_TYPE }}" + $runApiTransform = $env:SKIP_API_TRANSFORM -ne 'true' + ./BuildAutoRest -SDKName:("JumpCloud.SDK.V1") -ModuleVersionIncrementType "${{ needs.Check-PR-Labels.outputs.RELEASE_TYPE }}" -RunApiTransform:$runApiTransform - name: Pack JumpCloud.SDK.V1 Module shell: pwsh run: | @@ -233,6 +249,8 @@ jobs: if: contains(github.event.pull_request.labels.*.name, 'v2') runs-on: ubuntu-latest timeout-minutes: 70 + env: + SKIP_API_TRANSFORM: ${{ needs.Check-PR-Labels.outputs.SKIP_API_TRANSFORM }} steps: - uses: actions/checkout@v4 - uses: actions/cache@v3 @@ -242,7 +260,8 @@ jobs: - name: Build JumpCloud.SDK.V2 shell: pwsh run: | - ./BuildAutoRest -SDKName:("JumpCloud.SDK.V2") -ModuleVersionIncrementType "${{ needs.Check-PR-Labels.outputs.RELEASE_TYPE }}" + $runApiTransform = $env:SKIP_API_TRANSFORM -ne 'true' + ./BuildAutoRest -SDKName:("JumpCloud.SDK.V2") -ModuleVersionIncrementType "${{ needs.Check-PR-Labels.outputs.RELEASE_TYPE }}" -RunApiTransform:$runApiTransform - name: Pack JumpCloud.SDK.V2 Module shell: pwsh run: | From 6c9ef0bb684d28f048dc4a6c6d8cf6a16eb73fc3 Mon Sep 17 00:00:00 2001 From: Joe Workman Date: Mon, 11 May 2026 08:56:14 -0600 Subject: [PATCH 02/11] Generate v1,2,di --- ApiTransform.ps1 | 8 +- Configs/JumpCloud.SDK.DirectoryInsights.yaml | 2 +- Configs/JumpCloud.SDK.V1.yaml | 2 +- Configs/JumpCloud.SDK.V2.yaml | 2 +- Custom/Module.cs | 17 +- .../JumpCloud.SDK.DirectoryInsights.csproj | 2 +- .../JumpCloud.SDK.DirectoryInsights.nuspec | 2 +- .../JumpCloud.SDK.DirectoryInsights.psd1 | 4 +- .../custom/Module.cs | 21 +- .../custom/ModuleIdentifier.cs | 2 +- .../docs/exports/Get-JcSdkEvent.md | 4 +- .../docs/exports/Get-JcSdkEventCount.md | 4 +- .../docs/exports/Get-JcSdkEventDistinct.md | 4 +- .../docs/exports/Get-JcSdkEventInterval.md | 6 +- .../exports/Get-JcSdkReportArtifactContent.md | 2 +- .../docs/exports/New-JcSdkReport.md | 2 +- .../JumpCloud.SDK.V1/JumpCloud.SDK.V1.csproj | 2 +- .../JumpCloud.SDK.V1/JumpCloud.SDK.V1.nuspec | 2 +- .../JumpCloud.SDK.V1/JumpCloud.SDK.V1.psd1 | 4 +- .../JumpCloud.SDK.V1/custom/Module.cs | 21 +- .../custom/ModuleIdentifier.cs | 2 +- .../docs/exports/Get-JcSdkApplication.md | 2 +- .../exports/Get-JcSdkApplicationTemplate.md | 2 +- .../docs/exports/Get-JcSdkCommand.md | 2 +- .../docs/exports/Get-JcSdkCommandResult.md | 2 +- .../docs/exports/Get-JcSdkOrganization.md | 2 +- .../docs/exports/Get-JcSdkRadiusServer.md | 2 +- .../docs/exports/Get-JcSdkSystem.md | 2 +- .../docs/exports/Get-JcSdkUser.md | 2 +- SDKs/PowerShell/JumpCloud.SDK.V2/.gitignore | 4 +- .../JumpCloud.SDK.V2/JumpCloud.SDK.V2.csproj | 2 +- .../JumpCloud.SDK.V2/JumpCloud.SDK.V2.nuspec | 8 +- .../JumpCloud.SDK.V2/JumpCloud.SDK.V2.psd1 | 323 +--------------- .../JumpCloud.SDK.V2/check-dependencies.ps1 | 3 +- .../JumpCloud.SDK.V2/custom/Module.cs | 21 +- .../custom/ModuleIdentifier.cs | 2 +- .../generated/Clear-JcSdkAppleMdmDevice.ps1 | 78 +--- ...lear-JcSdkAppleMdmDeviceActivationLock.ps1 | 73 +--- .../generated/Get-JcSdkAccessRequest.ps1 | 53 +-- .../Get-JcSdkAccessRequestProgress.ps1 | 49 +-- .../generated/Get-JcSdkActiveDirectory.ps1 | 89 +---- .../Get-JcSdkActiveDirectoryAgent.ps1 | 91 +---- .../Get-JcSdkActiveDirectoryAssociation.ps1 | 88 +---- .../Get-JcSdkActiveDirectoryTraverseUser.ps1 | 95 +---- ...-JcSdkActiveDirectoryTraverseUserGroup.ps1 | 95 +---- .../Get-JcSdkAdministratorOrganization.ps1 | 29 +- ...Get-JcSdkAdministratorOrganizationLink.ps1 | 29 +- .../custom/generated/Get-JcSdkAppleMdm.ps1 | 41 +- .../generated/Get-JcSdkAppleMdmDevice.ps1 | 129 +------ .../Get-JcSdkAppleMdmEnrollmentProfile.ps1 | 43 +-- .../Get-JcSdkApplicationAssociation.ps1 | 86 +---- .../Get-JcSdkApplicationTraverseUser.ps1 | 95 +---- .../Get-JcSdkApplicationTraverseUserGroup.ps1 | 95 +---- .../generated/Get-JcSdkApprovalFlow.ps1 | 53 +-- .../Get-JcSdkApprovalFlowSetting.ps1 | 17 +- .../Get-JcSdkAuthenticationPolicy.ps1 | 109 +----- .../generated/Get-JcSdkBulkUserState.ps1 | 45 +-- .../generated/Get-JcSdkBulkUsersResult.ps1 | 84 +---- .../generated/Get-JcSdkCommandAssociation.ps1 | 88 +---- .../Get-JcSdkCommandTraverseSystem.ps1 | 95 +---- .../Get-JcSdkCommandTraverseSystemGroup.ps1 | 95 +---- .../Get-JcSdkCustomEmailConfiguration.ps1 | 67 +--- .../Get-JcSdkCustomEmailTemplate.ps1 | 31 +- .../custom/generated/Get-JcSdkDirectory.ps1 | 49 +-- .../custom/generated/Get-JcSdkDuoAccount.ps1 | 83 +---- .../generated/Get-JcSdkDuoApplication.ps1 | 87 +---- .../custom/generated/Get-JcSdkGSuite.ps1 | 84 +---- .../generated/Get-JcSdkGSuiteAssociation.ps1 | 88 +---- .../Get-JcSdkGSuiteTranslationRule.ps1 | 89 +---- .../generated/Get-JcSdkGSuiteTraverseUser.ps1 | 95 +---- .../Get-JcSdkGSuiteTraverseUserGroup.ps1 | 95 +---- .../Get-JcSdkGSuiteUsersToImport.ps1 | 29 +- .../custom/generated/Get-JcSdkGroup.ps1 | 65 +--- .../Get-JcSdkGsuiteUsersToImportFormatted.ps1 | 29 +- .../custom/generated/Get-JcSdkIPList.ps1 | 87 +---- .../custom/generated/Get-JcSdkLdapServer.ps1 | 89 +---- .../Get-JcSdkLdapServerAssociation.ps1 | 88 +---- .../Get-JcSdkLdapServerSambaDomain.ps1 | 87 +---- .../Get-JcSdkLdapServerTraverseUser.ps1 | 95 +---- .../Get-JcSdkLdapServerTraverseUserGroup.ps1 | 95 +---- .../Get-JcSdkNextScheduledBulkUserState.ps1 | 49 +-- .../custom/generated/Get-JcSdkOffice365.ps1 | 90 +---- .../Get-JcSdkOffice365Association.ps1 | 90 +---- .../Get-JcSdkOffice365TranslationRule.ps1 | 89 +---- .../Get-JcSdkOffice365TraverseUser.ps1 | 95 +---- .../Get-JcSdkOffice365TraverseUserGroup.ps1 | 95 +---- .../Get-JcSdkOffice365UsersToImport.ps1 | 30 +- .../Get-JcSdkOrganizationPolicyResult.ps1 | 56 +-- .../custom/generated/Get-JcSdkPolicy.ps1 | 111 +----- .../generated/Get-JcSdkPolicyAssociation.ps1 | 86 +---- .../custom/generated/Get-JcSdkPolicyGroup.ps1 | 91 +---- .../Get-JcSdkPolicyGroupAssociation.ps1 | 56 +-- .../generated/Get-JcSdkPolicyGroupMember.ps1 | 97 +---- .../Get-JcSdkPolicyGroupMembership.ps1 | 79 +--- .../Get-JcSdkPolicyGroupTraverseSystem.ps1 | 95 +---- ...et-JcSdkPolicyGroupTraverseSystemGroup.ps1 | 95 +---- .../generated/Get-JcSdkPolicyResult.ps1 | 101 +---- .../generated/Get-JcSdkPolicyStatus.ps1 | 56 +-- .../generated/Get-JcSdkPolicyTemplate.ps1 | 105 +----- .../Get-JcSdkPolicyTraverseSystem.ps1 | 95 +---- .../Get-JcSdkPolicyTraverseSystemGroup.ps1 | 95 +---- .../Get-JcSdkProviderAdministrator.ps1 | 31 +- .../Get-JcSdkProviderOrganization.ps1 | 31 +- .../generated/Get-JcSdkProvidersInvoice.ps1 | 63 +--- .../Get-JcSdkRadiusServerAssociation.ps1 | 86 +---- .../Get-JcSdkRadiusServerTraverseUser.ps1 | 97 +---- ...Get-JcSdkRadiusServerTraverseUserGroup.ps1 | 95 +---- .../custom/generated/Get-JcSdkSoftwareApp.ps1 | 87 +---- .../Get-JcSdkSoftwareAppAssociation.ps1 | 86 +---- .../generated/Get-JcSdkSoftwareAppStatus.ps1 | 83 +---- .../Get-JcSdkSoftwareAppTraverseSystem.ps1 | 95 +---- ...et-JcSdkSoftwareAppTraverseSystemGroup.ps1 | 95 +---- .../generated/Get-JcSdkSubscription.ps1 | 51 +-- .../generated/Get-JcSdkSystemAssociation.ps1 | 90 +---- .../generated/Get-JcSdkSystemFdeKey.ps1 | 55 +-- .../custom/generated/Get-JcSdkSystemGroup.ps1 | 101 +---- .../Get-JcSdkSystemGroupAssociation.ps1 | 88 +---- .../generated/Get-JcSdkSystemGroupMember.ps1 | 84 +---- .../Get-JcSdkSystemGroupMembership.ps1 | 81 +--- .../Get-JcSdkSystemGroupTraverseCommand.ps1 | 104 +----- .../Get-JcSdkSystemGroupTraversePolicy.ps1 | 99 +---- ...et-JcSdkSystemGroupTraversePolicyGroup.ps1 | 97 +---- .../Get-JcSdkSystemGroupTraverseUser.ps1 | 95 +---- .../Get-JcSdkSystemGroupTraverseUserGroup.ps1 | 97 +---- .../generated/Get-JcSdkSystemInsightAlf.ps1 | 36 +- .../Get-JcSdkSystemInsightAlfException.ps1 | 31 +- .../Get-JcSdkSystemInsightAlfExplicitAuth.ps1 | 30 +- .../generated/Get-JcSdkSystemInsightApp.ps1 | 54 +-- .../Get-JcSdkSystemInsightAppCompatShim.ps1 | 35 +- .../Get-JcSdkSystemInsightAuthorizedKey.ps1 | 33 +- ...cSdkSystemInsightAzureInstanceMetadata.ps1 | 45 +-- ...Get-JcSdkSystemInsightAzureInstanceTag.ps1 | 32 +- .../Get-JcSdkSystemInsightBattery.ps1 | 47 +-- .../Get-JcSdkSystemInsightBitlockerInfo.ps1 | 35 +- .../Get-JcSdkSystemInsightBrowserPlugin.ps1 | 39 +- .../Get-JcSdkSystemInsightCertificate.ps1 | 49 +-- .../Get-JcSdkSystemInsightChassisInfo.ps1 | 42 +-- .../Get-JcSdkSystemInsightChromeExtension.ps1 | 40 +- .../Get-JcSdkSystemInsightConnectivity.ps1 | 38 +- .../generated/Get-JcSdkSystemInsightCrash.ps1 | 45 +-- .../Get-JcSdkSystemInsightCupDestination.ps1 | 31 +- .../Get-JcSdkSystemInsightDiskEncryption.ps1 | 36 +- .../Get-JcSdkSystemInsightDiskInfo.ps1 | 40 +- .../Get-JcSdkSystemInsightDnsResolver.ps1 | 34 +- .../Get-JcSdkSystemInsightEtcHost.ps1 | 31 +- .../Get-JcSdkSystemInsightFirefoxAddon.ps1 | 43 +-- .../generated/Get-JcSdkSystemInsightGroup.ps1 | 34 +- .../Get-JcSdkSystemInsightIeExtension.ps1 | 33 +- ...Get-JcSdkSystemInsightInterfaceAddress.ps1 | 36 +- .../Get-JcSdkSystemInsightInterfaceDetail.ps1 | 63 +--- .../Get-JcSdkSystemInsightKernelInfo.ps1 | 33 +- .../Get-JcSdkSystemInsightLaunchd.ps1 | 50 +-- .../Get-JcSdkSystemInsightLinuxPackage.ps1 | 47 +-- .../Get-JcSdkSystemInsightLoggedinUser.ps1 | 35 +- .../Get-JcSdkSystemInsightLogicalDrive.ps1 | 35 +- .../Get-JcSdkSystemInsightManagedPolicy.ps1 | 35 +- .../generated/Get-JcSdkSystemInsightMount.ps1 | 40 +- .../Get-JcSdkSystemInsightOSVersion.ps1 | 39 +- .../generated/Get-JcSdkSystemInsightPatch.ps1 | 37 +- .../Get-JcSdkSystemInsightProgram.ps1 | 44 +-- .../Get-JcSdkSystemInsightPythonPackage.ps1 | 35 +- .../Get-JcSdkSystemInsightSafariExtension.ps1 | 39 +- .../Get-JcSdkSystemInsightScheduledTask.ps1 | 38 +- .../Get-JcSdkSystemInsightSecureboot.ps1 | 31 +- .../Get-JcSdkSystemInsightService.ps1 | 40 +- .../Get-JcSdkSystemInsightShadow.ps1 | 39 +- .../Get-JcSdkSystemInsightSharedFolder.ps1 | 31 +- .../Get-JcSdkSystemInsightSharedResource.ps1 | 37 +- ...et-JcSdkSystemInsightSharingPreference.ps1 | 39 +- .../Get-JcSdkSystemInsightSipConfig.ps1 | 32 +- .../Get-JcSdkSystemInsightStartupItem.ps1 | 35 +- .../Get-JcSdkSystemInsightSystemControl.ps1 | 36 +- .../Get-JcSdkSystemInsightSystemInfo.ps1 | 44 +-- .../Get-JcSdkSystemInsightTpmInfo.ps1 | 38 +- .../Get-JcSdkSystemInsightUptime.ps1 | 34 +- .../Get-JcSdkSystemInsightUsbDevice.ps1 | 41 +- .../generated/Get-JcSdkSystemInsightUser.ps1 | 45 +-- .../Get-JcSdkSystemInsightUserAssist.ps1 | 33 +- .../Get-JcSdkSystemInsightUserGroup.ps1 | 31 +- .../Get-JcSdkSystemInsightUserSshKey.ps1 | 32 +- .../Get-JcSdkSystemInsightWifiNetwork.ps1 | 41 +- .../Get-JcSdkSystemInsightWifiStatus.ps1 | 42 +-- ...cSdkSystemInsightWindowsSecurityCenter.ps1 | 36 +- ...SdkSystemInsightWindowsSecurityProduct.ps1 | 35 +- .../generated/Get-JcSdkSystemMember.ps1 | 81 +--- .../generated/Get-JcSdkSystemPolicyStatus.ps1 | 58 +-- .../Get-JcSdkSystemTraverseCommand.ps1 | 106 +----- .../Get-JcSdkSystemTraversePolicy.ps1 | 103 +----- .../Get-JcSdkSystemTraversePolicyGroup.ps1 | 97 +---- .../generated/Get-JcSdkSystemTraverseUser.ps1 | 97 +---- .../Get-JcSdkSystemTraverseUserGroup.ps1 | 97 +---- .../generated/Get-JcSdkUserAssociation.ps1 | 90 +---- .../custom/generated/Get-JcSdkUserGroup.ps1 | 107 +----- .../Get-JcSdkUserGroupAssociation.ps1 | 88 +---- .../generated/Get-JcSdkUserGroupMember.ps1 | 82 +--- .../Get-JcSdkUserGroupMembership.ps1 | 79 +--- ...-JcSdkUserGroupTraverseActiveDirectory.ps1 | 91 +---- .../Get-JcSdkUserGroupTraverseApplication.ps1 | 95 +---- .../Get-JcSdkUserGroupTraverseDirectory.ps1 | 97 +---- .../Get-JcSdkUserGroupTraverseGSuite.ps1 | 97 +---- .../Get-JcSdkUserGroupTraverseLdapServer.ps1 | 95 +---- .../Get-JcSdkUserGroupTraverseOffice365.ps1 | 95 +---- ...Get-JcSdkUserGroupTraverseRadiusServer.ps1 | 97 +---- .../Get-JcSdkUserGroupTraverseSystem.ps1 | 95 +---- .../Get-JcSdkUserGroupTraverseSystemGroup.ps1 | 95 +---- .../custom/generated/Get-JcSdkUserMember.ps1 | 79 +--- .../generated/Get-JcSdkUserPushEndpoint.ps1 | 85 +---- .../Get-JcSdkUserTraverseActiveDirectory.ps1 | 95 +---- .../Get-JcSdkUserTraverseApplication.ps1 | 95 +---- .../Get-JcSdkUserTraverseDirectory.ps1 | 95 +---- .../generated/Get-JcSdkUserTraverseGSuite.ps1 | 95 +---- .../Get-JcSdkUserTraverseLdapServer.ps1 | 95 +---- .../Get-JcSdkUserTraverseOffice365.ps1 | 95 +---- .../Get-JcSdkUserTraverseRadiusServer.ps1 | 95 +---- .../generated/Get-JcSdkUserTraverseSystem.ps1 | 95 +---- .../Get-JcSdkUserTraverseSystemGroup.ps1 | 95 +---- .../custom/generated/Get-JcSdkWorkday.ps1 | 101 +---- .../generated/Get-JcSdkWorkdayWorker.ps1 | 86 +---- .../custom/generated/Grant-JcSdkWorkday.ps1 | 110 +----- .../custom/generated/Import-JcSdkScim.ps1 | 61 +-- .../custom/generated/Import-JcSdkWorkday.ps1 | 167 +-------- .../generated/Import-JcSdkWorkdayResult.ps1 | 82 +--- .../Invoke-JcSdkReclaimSoftwareAppLicense.ps1 | 79 +--- .../generated/Lock-JcSdkAppleMdmDevice.ps1 | 78 +--- .../generated/New-JcSdkActiveDirectory.ps1 | 76 +--- .../New-JcSdkActiveDirectoryAgent.ps1 | 102 +---- .../New-JcSdkAdministratorOrganization.ps1 | 72 +--- .../generated/New-JcSdkApprovalFlow.ps1 | 61 +-- .../New-JcSdkAuthenticationPolicy.ps1 | 168 +-------- .../custom/generated/New-JcSdkBulkUser.ps1 | 193 +--------- .../generated/New-JcSdkBulkUserState.ps1 | 76 +--- .../New-JcSdkCustomEmailConfiguration.ps1 | 66 +--- .../custom/generated/New-JcSdkDuoAccount.ps1 | 51 +-- .../generated/New-JcSdkDuoApplication.ps1 | 107 +----- .../New-JcSdkGSuiteTranslationRule.ps1 | 99 +---- .../custom/generated/New-JcSdkIPList.ps1 | 82 +--- .../New-JcSdkLdapServerSambaDomain.ps1 | 99 +---- .../New-JcSdkOffice365TranslationRule.ps1 | 99 +---- .../custom/generated/New-JcSdkPolicy.ps1 | 109 +----- .../custom/generated/New-JcSdkPolicyGroup.ps1 | 74 +--- .../New-JcSdkProviderAdministrator.ps1 | 106 +----- .../custom/generated/New-JcSdkSoftwareApp.ps1 | 236 +----------- .../custom/generated/New-JcSdkSystemGroup.ps1 | 109 +----- .../custom/generated/New-JcSdkUserGroup.ps1 | 125 +------ .../custom/generated/New-JcSdkWorkday.ps1 | 114 +----- .../generated/Remove-JcSdkActiveDirectory.ps1 | 79 +--- .../Remove-JcSdkActiveDirectoryAgent.ps1 | 71 +--- .../Remove-JcSdkAdministratorOrganization.ps1 | 55 +-- .../custom/generated/Remove-JcSdkAppleMdm.ps1 | 112 +----- .../generated/Remove-JcSdkAppleMdmDevice.ps1 | 99 +---- .../generated/Remove-JcSdkApplicationLogo.ps1 | 55 +-- .../generated/Remove-JcSdkApprovalFlow.ps1 | 51 +-- .../Remove-JcSdkAuthenticationPolicy.ps1 | 90 +---- .../generated/Remove-JcSdkBulkUserState.ps1 | 69 +--- .../Remove-JcSdkCustomEmailConfiguration.ps1 | 55 +-- .../generated/Remove-JcSdkDuoAccount.ps1 | 77 +--- .../generated/Remove-JcSdkDuoApplication.ps1 | 79 +--- .../Remove-JcSdkGSuiteTranslationRule.ps1 | 75 +--- .../custom/generated/Remove-JcSdkIPList.ps1 | 79 +--- .../Remove-JcSdkLdapServerSambaDomain.ps1 | 71 +--- .../Remove-JcSdkOffice365TranslationRule.ps1 | 75 +--- .../custom/generated/Remove-JcSdkPolicy.ps1 | 73 +--- .../generated/Remove-JcSdkPolicyGroup.ps1 | 83 +---- .../Remove-JcSdkProviderAdministrator.ps1 | 57 +-- .../generated/Remove-JcSdkSoftwareApp.ps1 | 75 +--- .../generated/Remove-JcSdkSystemGroup.ps1 | 88 +---- .../generated/Remove-JcSdkUserGroup.ps1 | 91 +---- .../Remove-JcSdkUserPushEndpoint.ps1 | 70 +--- .../Remove-JcSdkWorkdayAuthorization.ps1 | 71 +--- .../generated/Restart-JcSdkAppleMdmDevice.ps1 | 78 +--- .../generated/Set-JcSdkAccessRequest.ps1 | 61 +-- .../Set-JcSdkAccessRequestApproval.ps1 | 32 +- .../Set-JcSdkActiveDirectoryAssociation.ps1 | 94 +---- .../custom/generated/Set-JcSdkAppleMdm.ps1 | 209 +---------- .../Set-JcSdkApplicationAssociation.ps1 | 92 +---- .../generated/Set-JcSdkApprovalFlow.ps1 | 89 +---- .../Set-JcSdkApprovalFlowSetting.ps1 | 40 +- .../generated/Set-JcSdkCommandAssociation.ps1 | 96 +---- .../Set-JcSdkCustomEmailConfiguration.ps1 | 94 +---- .../generated/Set-JcSdkDuoApplication.ps1 | 107 +----- .../generated/Set-JcSdkGSuiteAssociation.ps1 | 96 +---- .../custom/generated/Set-JcSdkIPList.ps1 | 106 +----- .../Set-JcSdkLdapServerAssociation.ps1 | 94 +---- .../Set-JcSdkLdapServerSambaDomain.ps1 | 99 +---- .../Set-JcSdkOffice365Association.ps1 | 94 +---- .../custom/generated/Set-JcSdkPolicy.ps1 | 132 +------ .../generated/Set-JcSdkPolicyAssociation.ps1 | 94 +---- .../custom/generated/Set-JcSdkPolicyGroup.ps1 | 102 +---- .../Set-JcSdkPolicyGroupAssociation.ps1 | 96 +---- .../generated/Set-JcSdkPolicyGroupMember.ps1 | 89 +---- .../Set-JcSdkRadiusServerAssociation.ps1 | 98 +---- .../custom/generated/Set-JcSdkSoftwareApp.ps1 | 350 +----------------- .../Set-JcSdkSoftwareAppAssociation.ps1 | 90 +---- .../generated/Set-JcSdkSystemAssociation.ps1 | 110 +----- .../custom/generated/Set-JcSdkSystemGroup.ps1 | 135 +------ .../Set-JcSdkSystemGroupAssociation.ps1 | 96 +---- .../generated/Set-JcSdkSystemGroupMember.ps1 | 89 +---- .../generated/Set-JcSdkUserAssociation.ps1 | 110 +----- .../custom/generated/Set-JcSdkUserGroup.ps1 | 153 +------- .../Set-JcSdkUserGroupAssociation.ps1 | 96 +---- .../generated/Set-JcSdkUserGroupMember.ps1 | 89 +---- .../custom/generated/Set-JcSdkWorkday.ps1 | 117 +----- .../generated/Stop-JcSdkAppleMdmDevice.ps1 | 73 +--- .../generated/Sync-JcSdkAppleMdmDevice.ps1 | 73 +--- ...ate-JcSdkAppleMdmDeviceLockInformation.ps1 | 75 +--- .../Update-JcSdkAuthenticationPolicy.ps1 | 160 +------- .../custom/generated/Update-JcSdkBulkUser.ps1 | 156 +------- .../custom/generated/Update-JcSdkGSuite.ps1 | 164 +------- .../custom/generated/Update-JcSdkIPList.ps1 | 96 +---- .../generated/Update-JcSdkLdapServer.ps1 | 104 +----- .../generated/Update-JcSdkOffice365.ps1 | 168 +-------- .../Update-JcSdkUserPushEndpoint.ps1 | 91 +---- .../docs/exports/Clear-JcSdkAppleMdmDevice.md | 267 ------------- ...Clear-JcSdkAppleMdmDeviceActivationLock.md | 218 ----------- .../docs/exports/Get-JcSdkAccessRequest.md | 207 ----------- .../exports/Get-JcSdkAccessRequestProgress.md | 147 -------- .../docs/exports/Get-JcSdkActiveDirectory.md | 229 ------------ .../exports/Get-JcSdkActiveDirectoryAgent.md | 203 ---------- .../Get-JcSdkActiveDirectoryAssociation.md | 183 --------- .../Get-JcSdkActiveDirectoryTraverseUser.md | 203 ---------- ...t-JcSdkActiveDirectoryTraverseUserGroup.md | 203 ---------- .../Get-JcSdkAdministratorOrganization.md | 85 ----- .../Get-JcSdkAdministratorOrganizationLink.md | 85 ----- .../docs/exports/Get-JcSdkAppleMdm.md | 111 ------ .../docs/exports/Get-JcSdkAppleMdmDevice.md | 283 -------------- .../Get-JcSdkAppleMdmEnrollmentProfile.md | 103 ------ .../Get-JcSdkApplicationAssociation.md | 181 --------- .../Get-JcSdkApplicationTraverseUser.md | 203 ---------- .../Get-JcSdkApplicationTraverseUserGroup.md | 203 ---------- .../docs/exports/Get-JcSdkApprovalFlow.md | 207 ----------- .../exports/Get-JcSdkApprovalFlowSetting.md | 76 ---- .../exports/Get-JcSdkAuthenticationPolicy.md | 248 ------------- .../docs/exports/Get-JcSdkBulkUserState.md | 129 ------- .../docs/exports/Get-JcSdkBulkUsersResult.md | 162 -------- .../exports/Get-JcSdkCommandAssociation.md | 182 --------- .../exports/Get-JcSdkCommandTraverseSystem.md | 203 ---------- .../Get-JcSdkCommandTraverseSystemGroup.md | 203 ---------- .../Get-JcSdkCustomEmailConfiguration.md | 146 -------- .../exports/Get-JcSdkCustomEmailTemplate.md | 72 ---- .../docs/exports/Get-JcSdkDirectory.md | 122 ------ .../docs/exports/Get-JcSdkDuoAccount.md | 162 -------- .../docs/exports/Get-JcSdkDuoApplication.md | 181 --------- .../docs/exports/Get-JcSdkGSuite.md | 162 -------- .../exports/Get-JcSdkGSuiteAssociation.md | 182 --------- .../exports/Get-JcSdkGSuiteTranslationRule.md | 244 ------------ .../exports/Get-JcSdkGSuiteTraverseUser.md | 203 ---------- .../Get-JcSdkGSuiteTraverseUserGroup.md | 203 ---------- .../exports/Get-JcSdkGSuiteUsersToImport.md | 134 ------- .../docs/exports/Get-JcSdkGroup.md | 182 --------- .../Get-JcSdkGsuiteUsersToImportFormatted.md | 149 -------- .../docs/exports/Get-JcSdkIPList.md | 226 ----------- .../docs/exports/Get-JcSdkLdapServer.md | 229 ------------ .../exports/Get-JcSdkLdapServerAssociation.md | 183 --------- .../exports/Get-JcSdkLdapServerSambaDomain.md | 242 ------------ .../Get-JcSdkLdapServerTraverseUser.md | 203 ---------- .../Get-JcSdkLdapServerTraverseUserGroup.md | 203 ---------- .../Get-JcSdkNextScheduledBulkUserState.md | 105 ------ .../docs/exports/Get-JcSdkOffice365.md | 168 --------- .../exports/Get-JcSdkOffice365Association.md | 185 --------- .../Get-JcSdkOffice365TranslationRule.md | 246 ------------ .../exports/Get-JcSdkOffice365TraverseUser.md | 218 ----------- .../Get-JcSdkOffice365TraverseUserGroup.md | 203 ---------- .../Get-JcSdkOffice365UsersToImport.md | 167 --------- .../Get-JcSdkOrganizationPolicyResult.md | 158 -------- .../docs/exports/Get-JcSdkPolicy.md | 251 ------------- .../exports/Get-JcSdkPolicyAssociation.md | 180 --------- .../docs/exports/Get-JcSdkPolicyGroup.md | 231 ------------ .../Get-JcSdkPolicyGroupAssociation.md | 127 ------- .../exports/Get-JcSdkPolicyGroupMember.md | 267 ------------- 369 files changed, 397 insertions(+), 32205 deletions(-) delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDevice.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDeviceActivationLock.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequest.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequestProgress.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectory.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAgent.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUser.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUserGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganization.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganizationLink.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdm.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmDevice.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmEnrollmentProfile.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUser.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUserGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlow.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlowSetting.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAuthenticationPolicy.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUserState.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUsersResult.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystem.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystemGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailConfiguration.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailTemplate.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDirectory.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoAccount.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoApplication.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuite.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTranslationRule.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUser.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUserGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteUsersToImport.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGsuiteUsersToImportFormatted.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkIPList.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServer.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerSambaDomain.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUser.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUserGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkNextScheduledBulkUserState.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365Association.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TranslationRule.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUser.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUserGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365UsersToImport.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOrganizationPolicyResult.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicy.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMember.md diff --git a/ApiTransform.ps1 b/ApiTransform.ps1 index 5bf4711e3..de12faefa 100644 --- a/ApiTransform.ps1 +++ b/ApiTransform.ps1 @@ -543,16 +543,16 @@ function Add-ParameterizedHost { # Determine host prefix and enum values based on existing host $hostPrefix = 'console' - $enumValues = @('console', 'console.eu') + $enumValues = @('console', 'console.eu', 'console.in') if ($SwaggerObject.Contains('host')) { $currentHost = $SwaggerObject['host'] if ($currentHost -like 'api.jumpcloud.com*') { $hostPrefix = 'api' - $enumValues = @('api', 'api.eu') + $enumValues = @('api', 'api.eu', 'api.in') } elseif ($currentHost -like 'console.jumpcloud.com*') { $hostPrefix = 'console' - $enumValues = @('console', 'console.eu') + $enumValues = @('console', 'console.eu', 'console.in') } } @@ -563,7 +563,7 @@ function Add-ParameterizedHost { parameters = @( [ordered]@{ name = if ($SDKName -eq "JumpCloud.SDK.DirectoryInsights") { 'apiHost' } else { 'consoleHost' } - description = "Region for JumpCloud API host. Use '$hostPrefix' for US or '$hostPrefix.eu' for EU." + description = "Region for JumpCloud API host. Use '$hostPrefix' for US, '$hostPrefix.eu' for EU or '$hostPrefix.in' for IN." required = $true type = 'string' in = 'client' diff --git a/Configs/JumpCloud.SDK.DirectoryInsights.yaml b/Configs/JumpCloud.SDK.DirectoryInsights.yaml index d2838326f..9b4a51104 100644 --- a/Configs/JumpCloud.SDK.DirectoryInsights.yaml +++ b/Configs/JumpCloud.SDK.DirectoryInsights.yaml @@ -11,7 +11,7 @@ powershell: true dll-name: JumpCloud.SDK.DirectoryInsights.private base-folder: .. debug: true -module-version: 0.1.1 +module-version: 0.2.0 metadata: iconUri: https://console.jumpcloud.com/img/login-viewport-logo.png licenseUri: https://github.com/TheJumpCloud/jcapi-powershell/tree/$(branch)/LICENSE diff --git a/Configs/JumpCloud.SDK.V1.yaml b/Configs/JumpCloud.SDK.V1.yaml index 26f09cac6..edac09c84 100644 --- a/Configs/JumpCloud.SDK.V1.yaml +++ b/Configs/JumpCloud.SDK.V1.yaml @@ -33,7 +33,7 @@ input-file: module-name: JumpCloud.SDK.V1 namespace: JumpCloud.SDK.V1 sample-generation: true -module-version: 0.1.3 +module-version: 0.2.0 dll-name: JumpCloud.SDK.V1.private directive: diff --git a/Configs/JumpCloud.SDK.V2.yaml b/Configs/JumpCloud.SDK.V2.yaml index 50d54619c..07caab071 100644 --- a/Configs/JumpCloud.SDK.V2.yaml +++ b/Configs/JumpCloud.SDK.V2.yaml @@ -28,6 +28,6 @@ verbose: true module-name: JumpCloud.SDK.V2 output-folder: SDKs/PowerShell/JumpCloud.SDK.V2 dll-name: JumpCloud.SDK.V2.private -module-version: 0.2.1 +module-version: 0.3.0 powershell: true base-folder: .. diff --git a/Custom/Module.cs b/Custom/Module.cs index 9744bba08..963471dba 100644 --- a/Custom/Module.cs +++ b/Custom/Module.cs @@ -42,6 +42,10 @@ private void SetDefaultHostEnvInPowerShellSession() apiHostValue = "api.eu"; consoleHostValue = "console.eu"; break; + case "IN": + apiHostValue = "api.in"; + consoleHostValue = "console.in"; + break; case "STAGING": apiHostValue = "api.stg01"; consoleHostValue = "console.stg01"; @@ -53,6 +57,11 @@ private void SetDefaultHostEnvInPowerShellSession() apiHostValue = "api.eu"; consoleHostValue = "console.eu"; } + else if (userInputEnvValue.Contains(".in")) + { + apiHostValue = "api.in"; + consoleHostValue = "console.in"; + } else if (userInputEnvValue.Contains(".stg01")) { apiHostValue = "api.stg01"; @@ -81,8 +90,8 @@ private void SetDefaultHostEnvInPowerShellSession() { string defaultHostPrefix = ModuleIdentifier.SDKName == "DirectoryInsights" ? "api" : "console"; Console.WriteLine("JumpCloud SDK Module: {0} is running in the '{1}.jumpcloud.com' host environment.", ModuleIdentifier.SDKName, defaultHostPrefix); - Console.WriteLine("'{0}.jumpcloud.com' is the standard environment; '{0}.eu.jumpcloud.com' is the EU environment.", defaultHostPrefix); - Console.WriteLine("To use the EU environment, run: $ENV:{0} = 'EU' and re-import the module.", envVarNameForDefaultHostEnv); + Console.WriteLine("'{0}.jumpcloud.com' is the standard environment; '{0}.eu.jumpcloud.com' is the EU environment; '{0}.in.jumpcloud.com' is the India environment.", defaultHostPrefix); + Console.WriteLine("To use the EU or IN environments, run: $ENV:{0} = 'EU' or 'IN' and re-import the module.", envVarNameForDefaultHostEnv); Console.WriteLine("To use the standard environment, run: $ENV:{0} = 'STANDARD' and re-import the module.", envVarNameForDefaultHostEnv); } @@ -180,8 +189,8 @@ protected async Task AddAuthHeaders(HttpRequestMessage requ System.Environment.SetEnvironmentVariable("JCEnvironment", HostEnv); // Translate to both formats and set parameter defaults - string apiHost = HostEnv.Contains(".eu") ? "api.eu" : (HostEnv.Contains(".stg01") ? "api.stg01" : "api"); - string consoleHost = HostEnv.Contains(".eu") ? "console.eu" : (HostEnv.Contains(".stg01") ? "console.stg01" : "console"); + string apiHost = HostEnv.Contains(".eu") ? "api.eu" : HostEnv.Contains(".in") ? "api.in" : HostEnv.Contains(".stg01") ? "api.stg01" : "api"; + string consoleHost = HostEnv.Contains(".eu") ? "console.eu" : HostEnv.Contains(".in") ? "console.in" : HostEnv.Contains(".stg01") ? "console.stg01" : "console"; SetPSDefaultHostEnvParameterValue(apiHost, consoleHost); } diff --git a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/JumpCloud.SDK.DirectoryInsights.csproj b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/JumpCloud.SDK.DirectoryInsights.csproj index 06bc5b8f7..f41ea3062 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/JumpCloud.SDK.DirectoryInsights.csproj +++ b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/JumpCloud.SDK.DirectoryInsights.csproj @@ -1,7 +1,7 @@ - 0.1.1 + 0.2.0 7.1 netstandard2.0 Library diff --git a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/JumpCloud.SDK.DirectoryInsights.nuspec b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/JumpCloud.SDK.DirectoryInsights.nuspec index cf0076d5a..c4bcf5465 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/JumpCloud.SDK.DirectoryInsights.nuspec +++ b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/JumpCloud.SDK.DirectoryInsights.nuspec @@ -2,7 +2,7 @@ JumpCloud.SDK.DirectoryInsights - 0.1.1 + 0.2.0 JumpCloud JumpCloud false diff --git a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/JumpCloud.SDK.DirectoryInsights.psd1 b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/JumpCloud.SDK.DirectoryInsights.psd1 index bf5cf0f90..161ec712f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/JumpCloud.SDK.DirectoryInsights.psd1 +++ b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/JumpCloud.SDK.DirectoryInsights.psd1 @@ -3,7 +3,7 @@ # # Generated by: JumpCloud # -# Generated on: 11/24/2025 +# Generated on: 5/11/2026 # @{ @@ -12,7 +12,7 @@ RootModule = './JumpCloud.SDK.DirectoryInsights.psm1' # Version number of this module. -ModuleVersion = '0.1.1' +ModuleVersion = '0.2.0' # Supported PSEditions CompatiblePSEditions = 'Core', 'Desktop' diff --git a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/custom/Module.cs b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/custom/Module.cs index 94d1d3210..870e65618 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/custom/Module.cs +++ b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/custom/Module.cs @@ -42,6 +42,10 @@ private void SetDefaultHostEnvInPowerShellSession() apiHostValue = "api.eu"; consoleHostValue = "console.eu"; break; + case "IN": + apiHostValue = "api.in"; + consoleHostValue = "console.in"; + break; case "STAGING": apiHostValue = "api.stg01"; consoleHostValue = "console.stg01"; @@ -53,6 +57,11 @@ private void SetDefaultHostEnvInPowerShellSession() apiHostValue = "api.eu"; consoleHostValue = "console.eu"; } + else if (userInputEnvValue.Contains(".in")) + { + apiHostValue = "api.in"; + consoleHostValue = "console.in"; + } else if (userInputEnvValue.Contains(".stg01")) { apiHostValue = "api.stg01"; @@ -81,8 +90,8 @@ private void SetDefaultHostEnvInPowerShellSession() { string defaultHostPrefix = ModuleIdentifier.SDKName == "DirectoryInsights" ? "api" : "console"; Console.WriteLine("JumpCloud SDK Module: {0} is running in the '{1}.jumpcloud.com' host environment.", ModuleIdentifier.SDKName, defaultHostPrefix); - Console.WriteLine("'{0}.jumpcloud.com' is the standard environment; '{0}.eu.jumpcloud.com' is the EU environment.", defaultHostPrefix); - Console.WriteLine("To use the EU environment, run: $ENV:{0} = 'EU' and re-import the module.", envVarNameForDefaultHostEnv); + Console.WriteLine("'{0}.jumpcloud.com' is the standard environment; '{0}.eu.jumpcloud.com' is the EU environment; '{0}.in.jumpcloud.com' is the India environment.", defaultHostPrefix); + Console.WriteLine("To use the EU or IN environments, run: $ENV:{0} = 'EU' or 'IN' and re-import the module.", envVarNameForDefaultHostEnv); Console.WriteLine("To use the standard environment, run: $ENV:{0} = 'STANDARD' and re-import the module.", envVarNameForDefaultHostEnv); } @@ -180,8 +189,8 @@ protected async Task AddAuthHeaders(HttpRequestMessage requ System.Environment.SetEnvironmentVariable("JCEnvironment", HostEnv); // Translate to both formats and set parameter defaults - string apiHost = HostEnv.Contains(".eu") ? "api.eu" : (HostEnv.Contains(".stg01") ? "api.stg01" : "api"); - string consoleHost = HostEnv.Contains(".eu") ? "console.eu" : (HostEnv.Contains(".stg01") ? "console.stg01" : "console"); + string apiHost = HostEnv.Contains(".eu") ? "api.eu" : HostEnv.Contains(".in") ? "api.in" : HostEnv.Contains(".stg01") ? "api.stg01" : "api"; + string consoleHost = HostEnv.Contains(".eu") ? "console.eu" : HostEnv.Contains(".in") ? "console.in" : HostEnv.Contains(".stg01") ? "console.stg01" : "console"; SetPSDefaultHostEnvParameterValue(apiHost, consoleHost); } @@ -212,10 +221,10 @@ protected async Task AddAuthHeaders(HttpRequestMessage requ request.Headers.Add("Accept", "application/json"); } // If headers do not contain an "UserAgent" with the correct value fix it - if (request.Headers.UserAgent.ToString() != "JumpCloud_JumpCloud.PowerShell.SDK.DirectoryInsights/0.1.1") + if (request.Headers.UserAgent.ToString() != "JumpCloud_JumpCloud.PowerShell.SDK.DirectoryInsights/0.2.0") { request.Headers.UserAgent.Clear(); - request.Headers.UserAgent.ParseAdd("JumpCloud_JumpCloud.PowerShell.SDK.DirectoryInsights/0.1.1"); + request.Headers.UserAgent.ParseAdd("JumpCloud_JumpCloud.PowerShell.SDK.DirectoryInsights/0.2.0"); } // // request.Headers.Add("Content-Type", "application/json"); System.Net.Http.HttpResponseMessage response = await next.SendAsync(request, callback); diff --git a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/custom/ModuleIdentifier.cs b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/custom/ModuleIdentifier.cs index 9fefdbd7f..944d146a6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/custom/ModuleIdentifier.cs +++ b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/custom/ModuleIdentifier.cs @@ -2,6 +2,6 @@ namespace ModuleNameSpace { public static class ModuleIdentifier { - public const string SDKName = "DirectoryInsights"; + public const string SDKName = ""; } } diff --git a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEvent.md b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEvent.md index a6c3b9573..81b7a5dc1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEvent.md +++ b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEvent.md @@ -40,14 +40,14 @@ curl -X POST 'https://api.jumpcloud.com/insights/directory/v1/events' -H 'Conten ### -------------------------- EXAMPLE 1 -------------------------- ```powershell -Get-JcSdkEvent -Service:() -StartTime:() -EndTime:() -ExactMatch:() -Fields:() -Limit:() -Q:() -SearchAfter:() -SearchTermAnd:() -SearchTermNot:() -SearchTermOr:() -Skip:() -Sort:() +) -StartTime:() -EndTime:() -ExactMatch:() -Fields:() -Limit:() -Q:() -SearchAfter:() -SearchTermAnd:() -SearchTermNot:() -SearchTermOr:() -Skip:() -Sort:() ``` ### -------------------------- EXAMPLE 2 -------------------------- ```powershell -Get-JcSdkEvent -Body:() +) ``` diff --git a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEventCount.md b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEventCount.md index e84ce7527..d00649068 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEventCount.md +++ b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEventCount.md @@ -40,14 +40,14 @@ curl -X POST 'https://api.jumpcloud.com/insights/directory/v1/events/count' -H ' ### -------------------------- EXAMPLE 1 -------------------------- ```powershell -Get-JcSdkEventCount -Service:() -StartTime:() -EndTime:() -ExactMatch:() -Fields:() -Q:() -SearchAfter:() -SearchTermAnd:() -SearchTermNot:() -SearchTermOr:() -Sort:() +) -StartTime:() -EndTime:() -ExactMatch:() -Fields:() -Q:() -SearchAfter:() -SearchTermAnd:() -SearchTermNot:() -SearchTermOr:() -Sort:() ``` ### -------------------------- EXAMPLE 2 -------------------------- ```powershell -Get-JcSdkEventCount -Body:() +) ``` diff --git a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEventDistinct.md b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEventDistinct.md index 18fed97b9..008dbadf1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEventDistinct.md +++ b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEventDistinct.md @@ -39,14 +39,14 @@ curl -X POST 'https://api.jumpcloud.com/insights/directory/v1/events/distinct' - ### -------------------------- EXAMPLE 1 -------------------------- ```powershell -Get-JcSdkEventDistinct -Field:() -Service:() -StartTime:() -EndTime:() -SearchTermAnd:() -SearchTermNot:() -SearchTermOr:() +) -Service:() -StartTime:() -EndTime:() -SearchTermAnd:() -SearchTermNot:() -SearchTermOr:() ``` ### -------------------------- EXAMPLE 2 -------------------------- ```powershell -Get-JcSdkEventDistinct -Body:() +) ``` diff --git a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEventInterval.md b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEventInterval.md index 681d57102..316e63773 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEventInterval.md +++ b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkEventInterval.md @@ -40,14 +40,14 @@ curl -X POST 'https://api.jumpcloud.com/insights/directory/v1/events/interval' - ### -------------------------- EXAMPLE 1 -------------------------- ```powershell -Get-JcSdkEventInterval -IntervalUnit:() -Service:() -StartTime:() -EndTime:() -ExactMatch:() -IntervalValue:() -Q:() -SearchTermAnd:() -SearchTermNot:() -SearchTermOr:() -Timezone:() +) -Service:() -StartTime:() -EndTime:() -ExactMatch:() -IntervalValue:() -Q:() -SearchTermAnd:() -SearchTermNot:() -SearchTermOr:() -Timezone:() ``` ### -------------------------- EXAMPLE 2 -------------------------- ```powershell -Get-JcSdkEventInterval -Body:() +) ``` @@ -304,7 +304,7 @@ To create the parameters described below, construct a hash table containing the `BODY `: EventIntervalQuery is the users' command to search our auth logs for bucketed counts of values of the specified field - `Service >`: service name to query. - `StartTime `: query start time, UTC in RFC3339 format - - `IntervalUnit `: + - `IntervalUnit `: - `[EndTime ]`: optional query end time, UTC in RFC3339 format - `[ExactMatch ]`: optional string for specifying exact match query, do not use with full text query - `[IntervalValue ]`: Interval Value. This specifies how many units you want to bucket the event counts by diff --git a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkReportArtifactContent.md b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkReportArtifactContent.md index 5d1472e14..136ad4ec4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkReportArtifactContent.md +++ b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkReportArtifactContent.md @@ -30,7 +30,7 @@ Download a report by report ID and artifact ID ### -------------------------- EXAMPLE 1 -------------------------- ```powershell -Get-JcSdkReportArtifactContent -ArtifactId:() -ReportId:() +) -ReportId:() ``` diff --git a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/New-JcSdkReport.md b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/New-JcSdkReport.md index 63e100b4b..7170ababf 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/New-JcSdkReport.md +++ b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/New-JcSdkReport.md @@ -30,7 +30,7 @@ Request a JumpCloud report to be generated asynchronously ### -------------------------- EXAMPLE 1 -------------------------- ```powershell -New-JcSdkReport -ReportType:() +) ``` diff --git a/SDKs/PowerShell/JumpCloud.SDK.V1/JumpCloud.SDK.V1.csproj b/SDKs/PowerShell/JumpCloud.SDK.V1/JumpCloud.SDK.V1.csproj index 7e7a9cb40..2be9ca3af 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V1/JumpCloud.SDK.V1.csproj +++ b/SDKs/PowerShell/JumpCloud.SDK.V1/JumpCloud.SDK.V1.csproj @@ -1,7 +1,7 @@ - 0.1.3 + 0.2.0 7.1 netstandard2.0 Library diff --git a/SDKs/PowerShell/JumpCloud.SDK.V1/JumpCloud.SDK.V1.nuspec b/SDKs/PowerShell/JumpCloud.SDK.V1/JumpCloud.SDK.V1.nuspec index 49f2d287a..a9b0d9eeb 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V1/JumpCloud.SDK.V1.nuspec +++ b/SDKs/PowerShell/JumpCloud.SDK.V1/JumpCloud.SDK.V1.nuspec @@ -2,7 +2,7 @@ JumpCloud.SDK.V1 - 0.1.3 + 0.2.0 JumpCloud JumpCloud false diff --git a/SDKs/PowerShell/JumpCloud.SDK.V1/JumpCloud.SDK.V1.psd1 b/SDKs/PowerShell/JumpCloud.SDK.V1/JumpCloud.SDK.V1.psd1 index 348123baa..988ee741c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V1/JumpCloud.SDK.V1.psd1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V1/JumpCloud.SDK.V1.psd1 @@ -3,7 +3,7 @@ # # Generated by: JumpCloud # -# Generated on: 3/26/2026 +# Generated on: 5/11/2026 # @{ @@ -12,7 +12,7 @@ RootModule = './JumpCloud.SDK.V1.psm1' # Version number of this module. -ModuleVersion = '0.1.3' +ModuleVersion = '0.2.0' # Supported PSEditions CompatiblePSEditions = 'Core', 'Desktop' diff --git a/SDKs/PowerShell/JumpCloud.SDK.V1/custom/Module.cs b/SDKs/PowerShell/JumpCloud.SDK.V1/custom/Module.cs index 85494893d..756f13b54 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V1/custom/Module.cs +++ b/SDKs/PowerShell/JumpCloud.SDK.V1/custom/Module.cs @@ -42,6 +42,10 @@ private void SetDefaultHostEnvInPowerShellSession() apiHostValue = "api.eu"; consoleHostValue = "console.eu"; break; + case "IN": + apiHostValue = "api.in"; + consoleHostValue = "console.in"; + break; case "STAGING": apiHostValue = "api.stg01"; consoleHostValue = "console.stg01"; @@ -53,6 +57,11 @@ private void SetDefaultHostEnvInPowerShellSession() apiHostValue = "api.eu"; consoleHostValue = "console.eu"; } + else if (userInputEnvValue.Contains(".in")) + { + apiHostValue = "api.in"; + consoleHostValue = "console.in"; + } else if (userInputEnvValue.Contains(".stg01")) { apiHostValue = "api.stg01"; @@ -81,8 +90,8 @@ private void SetDefaultHostEnvInPowerShellSession() { string defaultHostPrefix = ModuleIdentifier.SDKName == "DirectoryInsights" ? "api" : "console"; Console.WriteLine("JumpCloud SDK Module: {0} is running in the '{1}.jumpcloud.com' host environment.", ModuleIdentifier.SDKName, defaultHostPrefix); - Console.WriteLine("'{0}.jumpcloud.com' is the standard environment; '{0}.eu.jumpcloud.com' is the EU environment.", defaultHostPrefix); - Console.WriteLine("To use the EU environment, run: $ENV:{0} = 'EU' and re-import the module.", envVarNameForDefaultHostEnv); + Console.WriteLine("'{0}.jumpcloud.com' is the standard environment; '{0}.eu.jumpcloud.com' is the EU environment; '{0}.in.jumpcloud.com' is the India environment.", defaultHostPrefix); + Console.WriteLine("To use the EU or IN environments, run: $ENV:{0} = 'EU' or 'IN' and re-import the module.", envVarNameForDefaultHostEnv); Console.WriteLine("To use the standard environment, run: $ENV:{0} = 'STANDARD' and re-import the module.", envVarNameForDefaultHostEnv); } @@ -180,8 +189,8 @@ protected async Task AddAuthHeaders(HttpRequestMessage requ System.Environment.SetEnvironmentVariable("JCEnvironment", HostEnv); // Translate to both formats and set parameter defaults - string apiHost = HostEnv.Contains(".eu") ? "api.eu" : (HostEnv.Contains(".stg01") ? "api.stg01" : "api"); - string consoleHost = HostEnv.Contains(".eu") ? "console.eu" : (HostEnv.Contains(".stg01") ? "console.stg01" : "console"); + string apiHost = HostEnv.Contains(".eu") ? "api.eu" : HostEnv.Contains(".in") ? "api.in" : HostEnv.Contains(".stg01") ? "api.stg01" : "api"; + string consoleHost = HostEnv.Contains(".eu") ? "console.eu" : HostEnv.Contains(".in") ? "console.in" : HostEnv.Contains(".stg01") ? "console.stg01" : "console"; SetPSDefaultHostEnvParameterValue(apiHost, consoleHost); } @@ -212,10 +221,10 @@ protected async Task AddAuthHeaders(HttpRequestMessage requ request.Headers.Add("Accept", "application/json"); } // If headers do not contain an "UserAgent" with the correct value fix it - if (request.Headers.UserAgent.ToString() != "JumpCloud_JumpCloud.PowerShell.SDK.V1/0.1.3") + if (request.Headers.UserAgent.ToString() != "JumpCloud_JumpCloud.PowerShell.SDK.V1/0.2.0") { request.Headers.UserAgent.Clear(); - request.Headers.UserAgent.ParseAdd("JumpCloud_JumpCloud.PowerShell.SDK.V1/0.1.3"); + request.Headers.UserAgent.ParseAdd("JumpCloud_JumpCloud.PowerShell.SDK.V1/0.2.0"); } // // request.Headers.Add("Content-Type", "application/json"); System.Net.Http.HttpResponseMessage response = await next.SendAsync(request, callback); diff --git a/SDKs/PowerShell/JumpCloud.SDK.V1/custom/ModuleIdentifier.cs b/SDKs/PowerShell/JumpCloud.SDK.V1/custom/ModuleIdentifier.cs index 4ccbc0c4a..944d146a6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V1/custom/ModuleIdentifier.cs +++ b/SDKs/PowerShell/JumpCloud.SDK.V1/custom/ModuleIdentifier.cs @@ -2,6 +2,6 @@ namespace ModuleNameSpace { public static class ModuleIdentifier { - public const string SDKName = "V1"; + public const string SDKName = ""; } } diff --git a/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkApplication.md b/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkApplication.md index fe27d6601..a00ee4e2c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkApplication.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkApplication.md @@ -134,7 +134,7 @@ A filter to apply to the query. Populate with a valid field from an endpoint response. ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: List Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkApplicationTemplate.md b/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkApplicationTemplate.md index 3776f36ed..c52694be5 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkApplicationTemplate.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkApplicationTemplate.md @@ -170,7 +170,7 @@ A filter to apply to the query. Populate with a valid field from an endpoint response. ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkCommand.md b/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkCommand.md index a13cfc5f4..754d227c7 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkCommand.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkCommand.md @@ -139,7 +139,7 @@ A filter to apply to the query. Populate with a valid field from an endpoint response. ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: List Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkCommandResult.md b/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkCommandResult.md index e3bb29791..6059f86a1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkCommandResult.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkCommandResult.md @@ -103,7 +103,7 @@ A filter to apply to the query. Populate with a valid field from an endpoint response. ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: Get, GetViaIdentity Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkOrganization.md b/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkOrganization.md index d8774250a..a8270685c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkOrganization.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkOrganization.md @@ -140,7 +140,7 @@ A filter to apply to the query. Populate with a valid field from an endpoint response. ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkRadiusServer.md b/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkRadiusServer.md index a099a64d8..00d371ec8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkRadiusServer.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkRadiusServer.md @@ -128,7 +128,7 @@ A filter to apply to the query. Populate with a valid field from an endpoint response. ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: List Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkSystem.md b/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkSystem.md index 3b1f3aaed..706accf7f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkSystem.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkSystem.md @@ -248,7 +248,7 @@ A filter to apply to the query. Populate with a valid field from an endpoint response. ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkUser.md b/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkUser.md index 5a734810f..c8ef576f1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkUser.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V1/docs/exports/Get-JcSdkUser.md @@ -234,7 +234,7 @@ A filter to apply to the query. Populate with a valid field from an endpoint response. ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/.gitignore b/SDKs/PowerShell/JumpCloud.SDK.V2/.gitignore index de788ced9..6ec158bd9 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/.gitignore +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/.gitignore @@ -2,10 +2,8 @@ bin obj .vs generated -!custom/generated internal exports -!docs/exports tools test/*-TestResults.xml license.txt @@ -15,4 +13,4 @@ license.txt /*.psm1 /*.snk /*.csproj -/*.nuspec +/*.nuspec \ No newline at end of file diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.csproj b/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.csproj index 7cbd6c9e0..ac7aaf1a3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.csproj +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.csproj @@ -1,7 +1,7 @@ - 0.2.1 + 0.3.0 7.1 netstandard2.0 Library diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.nuspec b/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.nuspec index 46d6b0550..405cedbe1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.nuspec +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.nuspec @@ -1,19 +1,17 @@ - + JumpCloud.SDK.V2 - 0.2.1 + 0.3.0 JumpCloud JumpCloud false https://github.com/TheJumpCloud/jcapi-powershell/tree/$(branch)/LICENSE https://github.com/TheJumpCloud/jcapi-powershell/tree/$(branch)/SDKs/PowerShell/JumpCloud.SDK.V2/ The JumpCloud V2 PowerShell SDK - - + (c) JumpCloud. All rights reserved. JumpCloud, DaaS, Jump, Cloud, Directory - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.psd1 b/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.psd1 index 64fc05cb0..0ff2eeedc 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.psd1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.psd1 @@ -1,306 +1,23 @@ -# -# Module manifest for module 'JumpCloud.SDK.V2' -# -# Generated by: JumpCloud -# -# Generated on: 3/26/2026 -# - @{ - -# Script module or binary module file associated with this manifest. -RootModule = './JumpCloud.SDK.V2.psm1' - -# Version number of this module. -ModuleVersion = '0.2.1' - -# Supported PSEditions -CompatiblePSEditions = 'Core', 'Desktop' - -# ID used to uniquely identify this module -GUID = 'ff397964-2121-4c89-a916-34b5c30d7187' - -# Author of this module -Author = 'JumpCloud' - -# Company or vendor of this module -CompanyName = 'JumpCloud' - -# Copyright statement for this module -Copyright = '(c) JumpCloud. All rights reserved.' - -# Description of the functionality provided by this module -Description = 'The JumpCloud V2 PowerShell SDK' - -# Minimum version of the PowerShell engine required by this module -PowerShellVersion = '5.1' - -# Name of the PowerShell host required by this module -# PowerShellHostName = '' - -# Minimum version of the PowerShell host required by this module -# PowerShellHostVersion = '' - -# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. -DotNetFrameworkVersion = '4.7.2' - -# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. -# ClrVersion = '' - -# Processor architecture (None, X86, Amd64) required by this module -# ProcessorArchitecture = '' - -# Modules that must be imported into the global environment prior to importing this module -# RequiredModules = @() - -# Assemblies that must be loaded prior to importing this module -RequiredAssemblies = './bin/JumpCloud.SDK.V2.private.dll' - -# Script files (.ps1) that are run in the caller's environment prior to importing this module. -# ScriptsToProcess = @() - -# Type files (.ps1xml) to be loaded when importing this module -# TypesToProcess = @() - -# Format files (.ps1xml) to be loaded when importing this module -# FormatsToProcess = @() - -# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess -# 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 = 'Clear-JcSdkAppleMdmDevice', - 'Clear-JcSdkAppleMdmDeviceActivationLock', 'Get-JcSdkAccessRequest', - 'Get-JcSdkAccessRequestProgress', 'Get-JcSdkActiveDirectory', - 'Get-JcSdkActiveDirectoryAgent', - 'Get-JcSdkActiveDirectoryAssociation', - 'Get-JcSdkActiveDirectoryTraverseUser', - 'Get-JcSdkActiveDirectoryTraverseUserGroup', - 'Get-JcSdkAdministratorOrganization', - 'Get-JcSdkAdministratorOrganizationLink', 'Get-JcSdkAppleMdm', - 'Get-JcSdkAppleMdmDevice', 'Get-JcSdkAppleMdmEnrollmentProfile', - 'Get-JcSdkApplicationAssociation', - 'Get-JcSdkApplicationTraverseUser', - 'Get-JcSdkApplicationTraverseUserGroup', 'Get-JcSdkApprovalFlow', - 'Get-JcSdkApprovalFlowSetting', 'Get-JcSdkAuthenticationPolicy', - 'Get-JcSdkBulkUsersResult', 'Get-JcSdkBulkUserState', - 'Get-JcSdkCommandAssociation', 'Get-JcSdkCommandTraverseSystem', - 'Get-JcSdkCommandTraverseSystemGroup', - 'Get-JcSdkCustomEmailConfiguration', 'Get-JcSdkCustomEmailTemplate', - 'Get-JcSdkDirectory', 'Get-JcSdkDuoAccount', - 'Get-JcSdkDuoApplication', 'Get-JcSdkGroup', 'Get-JcSdkGSuite', - 'Get-JcSdkGSuiteAssociation', 'Get-JcSdkGSuiteTranslationRule', - 'Get-JcSdkGSuiteTraverseUser', 'Get-JcSdkGSuiteTraverseUserGroup', - 'Get-JcSdkGSuiteUsersToImport', - 'Get-JcSdkGsuiteUsersToImportFormatted', 'Get-JcSdkIPList', - 'Get-JcSdkLdapServer', 'Get-JcSdkLdapServerAssociation', - 'Get-JcSdkLdapServerSambaDomain', 'Get-JcSdkLdapServerTraverseUser', - 'Get-JcSdkLdapServerTraverseUserGroup', - 'Get-JcSdkNextScheduledBulkUserState', 'Get-JcSdkOffice365', - 'Get-JcSdkOffice365Association', - 'Get-JcSdkOffice365TranslationRule', - 'Get-JcSdkOffice365TraverseUser', - 'Get-JcSdkOffice365TraverseUserGroup', - 'Get-JcSdkOffice365UsersToImport', - 'Get-JcSdkOrganizationPolicyResult', 'Get-JcSdkPolicy', - 'Get-JcSdkPolicyAssociation', 'Get-JcSdkPolicyGroup', - 'Get-JcSdkPolicyGroupAssociation', 'Get-JcSdkPolicyGroupMember', - 'Get-JcSdkPolicyGroupMembership', - 'Get-JcSdkPolicyGroupTraverseSystem', - 'Get-JcSdkPolicyGroupTraverseSystemGroup', 'Get-JcSdkPolicyResult', - 'Get-JcSdkPolicyStatus', 'Get-JcSdkPolicyTemplate', - 'Get-JcSdkPolicyTraverseSystem', - 'Get-JcSdkPolicyTraverseSystemGroup', - 'Get-JcSdkProviderAdministrator', 'Get-JcSdkProviderOrganization', - 'Get-JcSdkProvidersInvoice', 'Get-JcSdkRadiusServerAssociation', - 'Get-JcSdkRadiusServerTraverseUser', - 'Get-JcSdkRadiusServerTraverseUserGroup', 'Get-JcSdkSoftwareApp', - 'Get-JcSdkSoftwareAppAssociation', 'Get-JcSdkSoftwareAppStatus', - 'Get-JcSdkSoftwareAppTraverseSystem', - 'Get-JcSdkSoftwareAppTraverseSystemGroup', 'Get-JcSdkSubscription', - 'Get-JcSdkSystemAssociation', 'Get-JcSdkSystemFdeKey', - 'Get-JcSdkSystemGroup', 'Get-JcSdkSystemGroupAssociation', - 'Get-JcSdkSystemGroupMember', 'Get-JcSdkSystemGroupMembership', - 'Get-JcSdkSystemGroupTraverseCommand', - 'Get-JcSdkSystemGroupTraversePolicy', - 'Get-JcSdkSystemGroupTraversePolicyGroup', - 'Get-JcSdkSystemGroupTraverseUser', - 'Get-JcSdkSystemGroupTraverseUserGroup', - 'Get-JcSdkSystemInsightAlf', 'Get-JcSdkSystemInsightAlfException', - 'Get-JcSdkSystemInsightAlfExplicitAuth', - 'Get-JcSdkSystemInsightApp', 'Get-JcSdkSystemInsightAppCompatShim', - 'Get-JcSdkSystemInsightAuthorizedKey', - 'Get-JcSdkSystemInsightAzureInstanceMetadata', - 'Get-JcSdkSystemInsightAzureInstanceTag', - 'Get-JcSdkSystemInsightBattery', - 'Get-JcSdkSystemInsightBitlockerInfo', - 'Get-JcSdkSystemInsightBrowserPlugin', - 'Get-JcSdkSystemInsightCertificate', - 'Get-JcSdkSystemInsightChassisInfo', - 'Get-JcSdkSystemInsightChromeExtension', - 'Get-JcSdkSystemInsightConnectivity', 'Get-JcSdkSystemInsightCrash', - 'Get-JcSdkSystemInsightCupDestination', - 'Get-JcSdkSystemInsightDiskEncryption', - 'Get-JcSdkSystemInsightDiskInfo', - 'Get-JcSdkSystemInsightDnsResolver', - 'Get-JcSdkSystemInsightEtcHost', - 'Get-JcSdkSystemInsightFirefoxAddon', 'Get-JcSdkSystemInsightGroup', - 'Get-JcSdkSystemInsightIeExtension', - 'Get-JcSdkSystemInsightInterfaceAddress', - 'Get-JcSdkSystemInsightInterfaceDetail', - 'Get-JcSdkSystemInsightKernelInfo', 'Get-JcSdkSystemInsightLaunchd', - 'Get-JcSdkSystemInsightLinuxPackage', - 'Get-JcSdkSystemInsightLoggedinUser', - 'Get-JcSdkSystemInsightLogicalDrive', - 'Get-JcSdkSystemInsightManagedPolicy', - 'Get-JcSdkSystemInsightMount', 'Get-JcSdkSystemInsightOSVersion', - 'Get-JcSdkSystemInsightPatch', 'Get-JcSdkSystemInsightProgram', - 'Get-JcSdkSystemInsightPythonPackage', - 'Get-JcSdkSystemInsightSafariExtension', - 'Get-JcSdkSystemInsightScheduledTask', - 'Get-JcSdkSystemInsightSecureboot', 'Get-JcSdkSystemInsightService', - 'Get-JcSdkSystemInsightShadow', - 'Get-JcSdkSystemInsightSharedFolder', - 'Get-JcSdkSystemInsightSharedResource', - 'Get-JcSdkSystemInsightSharingPreference', - 'Get-JcSdkSystemInsightSipConfig', - 'Get-JcSdkSystemInsightStartupItem', - 'Get-JcSdkSystemInsightSystemControl', - 'Get-JcSdkSystemInsightSystemInfo', 'Get-JcSdkSystemInsightTpmInfo', - 'Get-JcSdkSystemInsightUptime', 'Get-JcSdkSystemInsightUsbDevice', - 'Get-JcSdkSystemInsightUser', 'Get-JcSdkSystemInsightUserAssist', - 'Get-JcSdkSystemInsightUserGroup', - 'Get-JcSdkSystemInsightUserSshKey', - 'Get-JcSdkSystemInsightWifiNetwork', - 'Get-JcSdkSystemInsightWifiStatus', - 'Get-JcSdkSystemInsightWindowsSecurityCenter', - 'Get-JcSdkSystemInsightWindowsSecurityProduct', - 'Get-JcSdkSystemMember', 'Get-JcSdkSystemPolicyStatus', - 'Get-JcSdkSystemTraverseCommand', 'Get-JcSdkSystemTraversePolicy', - 'Get-JcSdkSystemTraversePolicyGroup', 'Get-JcSdkSystemTraverseUser', - 'Get-JcSdkSystemTraverseUserGroup', 'Get-JcSdkUserAssociation', - 'Get-JcSdkUserGroup', 'Get-JcSdkUserGroupAssociation', - 'Get-JcSdkUserGroupMember', 'Get-JcSdkUserGroupMembership', - 'Get-JcSdkUserGroupTraverseActiveDirectory', - 'Get-JcSdkUserGroupTraverseApplication', - 'Get-JcSdkUserGroupTraverseDirectory', - 'Get-JcSdkUserGroupTraverseGSuite', - 'Get-JcSdkUserGroupTraverseLdapServer', - 'Get-JcSdkUserGroupTraverseOffice365', - 'Get-JcSdkUserGroupTraverseRadiusServer', - 'Get-JcSdkUserGroupTraverseSystem', - 'Get-JcSdkUserGroupTraverseSystemGroup', 'Get-JcSdkUserMember', - 'Get-JcSdkUserPushEndpoint', 'Get-JcSdkUserTraverseActiveDirectory', - 'Get-JcSdkUserTraverseApplication', - 'Get-JcSdkUserTraverseDirectory', 'Get-JcSdkUserTraverseGSuite', - 'Get-JcSdkUserTraverseLdapServer', 'Get-JcSdkUserTraverseOffice365', - 'Get-JcSdkUserTraverseRadiusServer', 'Get-JcSdkUserTraverseSystem', - 'Get-JcSdkUserTraverseSystemGroup', 'Get-JcSdkWorkday', - 'Get-JcSdkWorkdayWorker', 'Grant-JcSdkWorkday', 'Import-JcSdkScim', - 'Import-JcSdkWorkday', 'Import-JcSdkWorkdayResult', - 'Invoke-JcSdkReclaimSoftwareAppLicense', 'Lock-JcSdkAppleMdmDevice', - 'New-JcSdkActiveDirectory', 'New-JcSdkActiveDirectoryAgent', - 'New-JcSdkAdministratorOrganization', 'New-JcSdkApprovalFlow', - 'New-JcSdkAuthenticationPolicy', 'New-JcSdkBulkUser', - 'New-JcSdkBulkUserState', 'New-JcSdkCustomEmailConfiguration', - 'New-JcSdkDuoAccount', 'New-JcSdkDuoApplication', - 'New-JcSdkGSuiteTranslationRule', 'New-JcSdkIPList', - 'New-JcSdkLdapServerSambaDomain', - 'New-JcSdkOffice365TranslationRule', 'New-JcSdkPolicy', - 'New-JcSdkPolicyGroup', 'New-JcSdkProviderAdministrator', - 'New-JcSdkSoftwareApp', 'New-JcSdkSystemGroup', 'New-JcSdkUserGroup', - 'New-JcSdkWorkday', 'Remove-JcSdkActiveDirectory', - 'Remove-JcSdkActiveDirectoryAgent', - 'Remove-JcSdkAdministratorOrganization', 'Remove-JcSdkAppleMdm', - 'Remove-JcSdkAppleMdmDevice', 'Remove-JcSdkApplicationLogo', - 'Remove-JcSdkApprovalFlow', 'Remove-JcSdkAuthenticationPolicy', - 'Remove-JcSdkBulkUserState', 'Remove-JcSdkCustomEmailConfiguration', - 'Remove-JcSdkDuoAccount', 'Remove-JcSdkDuoApplication', - 'Remove-JcSdkGSuiteTranslationRule', 'Remove-JcSdkIPList', - 'Remove-JcSdkLdapServerSambaDomain', - 'Remove-JcSdkOffice365TranslationRule', 'Remove-JcSdkPolicy', - 'Remove-JcSdkPolicyGroup', 'Remove-JcSdkProviderAdministrator', - 'Remove-JcSdkSoftwareApp', 'Remove-JcSdkSystemGroup', - 'Remove-JcSdkUserGroup', 'Remove-JcSdkUserPushEndpoint', - 'Remove-JcSdkWorkdayAuthorization', 'Restart-JcSdkAppleMdmDevice', - 'Set-JcSdkAccessRequest', 'Set-JcSdkAccessRequestApproval', - 'Set-JcSdkActiveDirectoryAssociation', 'Set-JcSdkAppleMdm', - 'Set-JcSdkApplicationAssociation', 'Set-JcSdkApprovalFlow', - 'Set-JcSdkApprovalFlowSetting', 'Set-JcSdkCommandAssociation', - 'Set-JcSdkCustomEmailConfiguration', 'Set-JcSdkDuoApplication', - 'Set-JcSdkGSuiteAssociation', 'Set-JcSdkIPList', - 'Set-JcSdkLdapServerAssociation', 'Set-JcSdkLdapServerSambaDomain', - 'Set-JcSdkOffice365Association', 'Set-JcSdkPolicy', - 'Set-JcSdkPolicyAssociation', 'Set-JcSdkPolicyGroup', - 'Set-JcSdkPolicyGroupAssociation', 'Set-JcSdkPolicyGroupMember', - 'Set-JcSdkRadiusServerAssociation', 'Set-JcSdkSoftwareApp', - 'Set-JcSdkSoftwareAppAssociation', 'Set-JcSdkSystemAssociation', - 'Set-JcSdkSystemGroup', 'Set-JcSdkSystemGroupAssociation', - 'Set-JcSdkSystemGroupMember', 'Set-JcSdkUserAssociation', - 'Set-JcSdkUserGroup', 'Set-JcSdkUserGroupAssociation', - 'Set-JcSdkUserGroupMember', 'Set-JcSdkWorkday', - 'Stop-JcSdkAppleMdmDevice', 'Sync-JcSdkAppleMdmDevice', - 'Update-JcSdkAppleMdmDeviceLockInformation', - 'Update-JcSdkAuthenticationPolicy', 'Update-JcSdkBulkUser', - 'Update-JcSdkGSuite', 'Update-JcSdkIPList', 'Update-JcSdkLdapServer', - 'Update-JcSdkOffice365', 'Update-JcSdkUserPushEndpoint' - -# 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 = @() - -# Variables to export from this module -# VariablesToExport = @() - -# Aliases 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 aliases to export. -AliasesToExport = @() - -# DSC resources to export from this module -# DscResourcesToExport = @() - -# List of all modules packaged with this module -# ModuleList = @() - -# List of all files packaged with this module -# FileList = @() - -# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. -PrivateData = @{ - + GUID = '4dd823c0-5661-4a3b-aea8-f54997fa5d89' + RootModule = './JumpCloud.SDK.V2.psm1' + ModuleVersion = '0.3.0' + CompatiblePSEditions = 'Core', 'Desktop' + Author = 'JumpCloud' + CompanyName = 'JumpCloud' + Copyright = '(c) JumpCloud. All rights reserved.' + Description = 'The JumpCloud V2 PowerShell SDK' + PowerShellVersion = '5.1' + DotNetFrameworkVersion = '4.7.2' + RequiredAssemblies = './bin/JumpCloud.SDK.V2.private.dll' + FormatsToProcess = @() + FunctionsToExport = 'Clear-JcSdkAppleMdmDevice', 'Clear-JcSdkAppleMdmDeviceActivationLock', 'Get-JcSdkAccessRequest', 'Get-JcSdkAccessRequestProgress', 'Get-JcSdkActiveDirectory', 'Get-JcSdkActiveDirectoryAgent', 'Get-JcSdkActiveDirectoryAssociation', 'Get-JcSdkActiveDirectoryTraverseUser', 'Get-JcSdkActiveDirectoryTraverseUserGroup', 'Get-JcSdkAdministratorOrganization', 'Get-JcSdkAdministratorOrganizationLink', 'Get-JcSdkAppleMdm', 'Get-JcSdkAppleMdmDevice', 'Get-JcSdkAppleMdmEnrollmentProfile', 'Get-JcSdkApplicationAssociation', 'Get-JcSdkApplicationTraverseUser', 'Get-JcSdkApplicationTraverseUserGroup', 'Get-JcSdkApprovalFlow', 'Get-JcSdkApprovalFlowSetting', 'Get-JcSdkAuthenticationPolicy', 'Get-JcSdkBulkUsersResult', 'Get-JcSdkBulkUserState', 'Get-JcSdkCommandAssociation', 'Get-JcSdkCommandTraverseSystem', 'Get-JcSdkCommandTraverseSystemGroup', 'Get-JcSdkCustomEmailConfiguration', 'Get-JcSdkCustomEmailTemplate', 'Get-JcSdkDirectory', 'Get-JcSdkDuoAccount', 'Get-JcSdkDuoApplication', 'Get-JcSdkGroup', 'Get-JcSdkGSuite', 'Get-JcSdkGSuiteAssociation', 'Get-JcSdkGSuiteTranslationRule', 'Get-JcSdkGSuiteTraverseUser', 'Get-JcSdkGSuiteTraverseUserGroup', 'Get-JcSdkGSuiteUsersToImport', 'Get-JcSdkGsuiteUsersToImportFormatted', 'Get-JcSdkIPList', 'Get-JcSdkLdapServer', 'Get-JcSdkLdapServerAssociation', 'Get-JcSdkLdapServerSambaDomain', 'Get-JcSdkLdapServerTraverseUser', 'Get-JcSdkLdapServerTraverseUserGroup', 'Get-JcSdkNextScheduledBulkUserState', 'Get-JcSdkOffice365', 'Get-JcSdkOffice365Association', 'Get-JcSdkOffice365TranslationRule', 'Get-JcSdkOffice365TraverseUser', 'Get-JcSdkOffice365TraverseUserGroup', 'Get-JcSdkOffice365UsersToImport', 'Get-JcSdkOrganizationPolicyResult', 'Get-JcSdkPolicy', 'Get-JcSdkPolicyAssociation', 'Get-JcSdkPolicyGroup', 'Get-JcSdkPolicyGroupAssociation', 'Get-JcSdkPolicyGroupMember', 'Get-JcSdkPolicyGroupMembership', 'Get-JcSdkPolicyGroupTraverseSystem', 'Get-JcSdkPolicyGroupTraverseSystemGroup', 'Get-JcSdkPolicyResult', 'Get-JcSdkPolicyStatus', 'Get-JcSdkPolicyTemplate', 'Get-JcSdkPolicyTraverseSystem', 'Get-JcSdkPolicyTraverseSystemGroup', 'Get-JcSdkProviderAdministrator', 'Get-JcSdkProviderOrganization', 'Get-JcSdkProvidersInvoice', 'Get-JcSdkRadiusServerAssociation', 'Get-JcSdkRadiusServerTraverseUser', 'Get-JcSdkRadiusServerTraverseUserGroup', 'Get-JcSdkSoftwareApp', 'Get-JcSdkSoftwareAppAssociation', 'Get-JcSdkSoftwareAppStatus', 'Get-JcSdkSoftwareAppTraverseSystem', 'Get-JcSdkSoftwareAppTraverseSystemGroup', 'Get-JcSdkSubscription', 'Get-JcSdkSystemAssociation', 'Get-JcSdkSystemFdeKey', 'Get-JcSdkSystemGroup', 'Get-JcSdkSystemGroupAssociation', 'Get-JcSdkSystemGroupMember', 'Get-JcSdkSystemGroupMembership', 'Get-JcSdkSystemGroupTraverseCommand', 'Get-JcSdkSystemGroupTraversePolicy', 'Get-JcSdkSystemGroupTraversePolicyGroup', 'Get-JcSdkSystemGroupTraverseUser', 'Get-JcSdkSystemGroupTraverseUserGroup', 'Get-JcSdkSystemInsightAlf', 'Get-JcSdkSystemInsightAlfException', 'Get-JcSdkSystemInsightAlfExplicitAuth', 'Get-JcSdkSystemInsightApp', 'Get-JcSdkSystemInsightAppCompatShim', 'Get-JcSdkSystemInsightAuthorizedKey', 'Get-JcSdkSystemInsightAzureInstanceMetadata', 'Get-JcSdkSystemInsightAzureInstanceTag', 'Get-JcSdkSystemInsightBattery', 'Get-JcSdkSystemInsightBitlockerInfo', 'Get-JcSdkSystemInsightBrowserPlugin', 'Get-JcSdkSystemInsightCertificate', 'Get-JcSdkSystemInsightChassisInfo', 'Get-JcSdkSystemInsightChromeExtension', 'Get-JcSdkSystemInsightConnectivity', 'Get-JcSdkSystemInsightCrash', 'Get-JcSdkSystemInsightCupDestination', 'Get-JcSdkSystemInsightDiskEncryption', 'Get-JcSdkSystemInsightDiskInfo', 'Get-JcSdkSystemInsightDnsResolver', 'Get-JcSdkSystemInsightEtcHost', 'Get-JcSdkSystemInsightFirefoxAddon', 'Get-JcSdkSystemInsightGroup', 'Get-JcSdkSystemInsightIeExtension', 'Get-JcSdkSystemInsightInterfaceAddress', 'Get-JcSdkSystemInsightInterfaceDetail', 'Get-JcSdkSystemInsightKernelInfo', 'Get-JcSdkSystemInsightLaunchd', 'Get-JcSdkSystemInsightLinuxPackage', 'Get-JcSdkSystemInsightLoggedinUser', 'Get-JcSdkSystemInsightLogicalDrive', 'Get-JcSdkSystemInsightManagedPolicy', 'Get-JcSdkSystemInsightMount', 'Get-JcSdkSystemInsightOSVersion', 'Get-JcSdkSystemInsightPatch', 'Get-JcSdkSystemInsightProgram', 'Get-JcSdkSystemInsightPythonPackage', 'Get-JcSdkSystemInsightSafariExtension', 'Get-JcSdkSystemInsightScheduledTask', 'Get-JcSdkSystemInsightSecureboot', 'Get-JcSdkSystemInsightService', 'Get-JcSdkSystemInsightShadow', 'Get-JcSdkSystemInsightSharedFolder', 'Get-JcSdkSystemInsightSharedResource', 'Get-JcSdkSystemInsightSharingPreference', 'Get-JcSdkSystemInsightSipConfig', 'Get-JcSdkSystemInsightStartupItem', 'Get-JcSdkSystemInsightSystemControl', 'Get-JcSdkSystemInsightSystemInfo', 'Get-JcSdkSystemInsightTpmInfo', 'Get-JcSdkSystemInsightUptime', 'Get-JcSdkSystemInsightUsbDevice', 'Get-JcSdkSystemInsightUser', 'Get-JcSdkSystemInsightUserAssist', 'Get-JcSdkSystemInsightUserGroup', 'Get-JcSdkSystemInsightUserSshKey', 'Get-JcSdkSystemInsightWifiNetwork', 'Get-JcSdkSystemInsightWifiStatus', 'Get-JcSdkSystemInsightWindowsSecurityCenter', 'Get-JcSdkSystemInsightWindowsSecurityProduct', 'Get-JcSdkSystemMember', 'Get-JcSdkSystemPolicyStatus', 'Get-JcSdkSystemTraverseCommand', 'Get-JcSdkSystemTraversePolicy', 'Get-JcSdkSystemTraversePolicyGroup', 'Get-JcSdkSystemTraverseUser', 'Get-JcSdkSystemTraverseUserGroup', 'Get-JcSdkUserAssociation', 'Get-JcSdkUserGroup', 'Get-JcSdkUserGroupAssociation', 'Get-JcSdkUserGroupMember', 'Get-JcSdkUserGroupMembership', 'Get-JcSdkUserGroupTraverseActiveDirectory', 'Get-JcSdkUserGroupTraverseApplication', 'Get-JcSdkUserGroupTraverseDirectory', 'Get-JcSdkUserGroupTraverseGSuite', 'Get-JcSdkUserGroupTraverseLdapServer', 'Get-JcSdkUserGroupTraverseOffice365', 'Get-JcSdkUserGroupTraverseRadiusServer', 'Get-JcSdkUserGroupTraverseSystem', 'Get-JcSdkUserGroupTraverseSystemGroup', 'Get-JcSdkUserMember', 'Get-JcSdkUserPushEndpoint', 'Get-JcSdkUserTraverseActiveDirectory', 'Get-JcSdkUserTraverseApplication', 'Get-JcSdkUserTraverseDirectory', 'Get-JcSdkUserTraverseGSuite', 'Get-JcSdkUserTraverseLdapServer', 'Get-JcSdkUserTraverseOffice365', 'Get-JcSdkUserTraverseRadiusServer', 'Get-JcSdkUserTraverseSystem', 'Get-JcSdkUserTraverseSystemGroup', 'Get-JcSdkWorkday', 'Get-JcSdkWorkdayWorker', 'Grant-JcSdkWorkday', 'Import-JcSdkScim', 'Import-JcSdkWorkday', 'Import-JcSdkWorkdayResult', 'Invoke-JcSdkReclaimSoftwareAppLicense', 'Lock-JcSdkAppleMdmDevice', 'New-JcSdkActiveDirectory', 'New-JcSdkActiveDirectoryAgent', 'New-JcSdkAdministratorOrganization', 'New-JcSdkApprovalFlow', 'New-JcSdkAuthenticationPolicy', 'New-JcSdkBulkUser', 'New-JcSdkBulkUserState', 'New-JcSdkCustomEmailConfiguration', 'New-JcSdkDuoAccount', 'New-JcSdkDuoApplication', 'New-JcSdkGSuiteTranslationRule', 'New-JcSdkIPList', 'New-JcSdkLdapServerSambaDomain', 'New-JcSdkOffice365TranslationRule', 'New-JcSdkPolicy', 'New-JcSdkPolicyGroup', 'New-JcSdkProviderAdministrator', 'New-JcSdkSoftwareApp', 'New-JcSdkSystemGroup', 'New-JcSdkUserGroup', 'New-JcSdkWorkday', 'Remove-JcSdkActiveDirectory', 'Remove-JcSdkActiveDirectoryAgent', 'Remove-JcSdkAdministratorOrganization', 'Remove-JcSdkAppleMdm', 'Remove-JcSdkAppleMdmDevice', 'Remove-JcSdkApplicationLogo', 'Remove-JcSdkApprovalFlow', 'Remove-JcSdkAuthenticationPolicy', 'Remove-JcSdkBulkUserState', 'Remove-JcSdkCustomEmailConfiguration', 'Remove-JcSdkDuoAccount', 'Remove-JcSdkDuoApplication', 'Remove-JcSdkGSuiteTranslationRule', 'Remove-JcSdkIPList', 'Remove-JcSdkLdapServerSambaDomain', 'Remove-JcSdkOffice365TranslationRule', 'Remove-JcSdkPolicy', 'Remove-JcSdkPolicyGroup', 'Remove-JcSdkProviderAdministrator', 'Remove-JcSdkSoftwareApp', 'Remove-JcSdkSystemGroup', 'Remove-JcSdkUserGroup', 'Remove-JcSdkUserPushEndpoint', 'Remove-JcSdkWorkdayAuthorization', 'Restart-JcSdkAppleMdmDevice', 'Set-JcSdkAccessRequest', 'Set-JcSdkAccessRequestApproval', 'Set-JcSdkActiveDirectoryAssociation', 'Set-JcSdkAppleMdm', 'Set-JcSdkApplicationAssociation', 'Set-JcSdkApprovalFlow', 'Set-JcSdkApprovalFlowSetting', 'Set-JcSdkCommandAssociation', 'Set-JcSdkCustomEmailConfiguration', 'Set-JcSdkDuoApplication', 'Set-JcSdkGSuiteAssociation', 'Set-JcSdkIPList', 'Set-JcSdkLdapServerAssociation', 'Set-JcSdkLdapServerSambaDomain', 'Set-JcSdkOffice365Association', 'Set-JcSdkPolicy', 'Set-JcSdkPolicyAssociation', 'Set-JcSdkPolicyGroup', 'Set-JcSdkPolicyGroupAssociation', 'Set-JcSdkPolicyGroupMember', 'Set-JcSdkRadiusServerAssociation', 'Set-JcSdkSoftwareApp', 'Set-JcSdkSoftwareAppAssociation', 'Set-JcSdkSystemAssociation', 'Set-JcSdkSystemGroup', 'Set-JcSdkSystemGroupAssociation', 'Set-JcSdkSystemGroupMember', 'Set-JcSdkUserAssociation', 'Set-JcSdkUserGroup', 'Set-JcSdkUserGroupAssociation', 'Set-JcSdkUserGroupMember', 'Set-JcSdkWorkday', 'Stop-JcSdkAppleMdmDevice', 'Sync-JcSdkAppleMdmDevice', 'Update-JcSdkAppleMdmDeviceLockInformation', 'Update-JcSdkAuthenticationPolicy', 'Update-JcSdkBulkUser', 'Update-JcSdkGSuite', 'Update-JcSdkIPList', 'Update-JcSdkLdapServer', 'Update-JcSdkOffice365', 'Update-JcSdkUserPushEndpoint' + PrivateData = @{ PSData = @{ - - # Tags applied to this module. These help with module discovery in online galleries. - Tags = 'JumpCloud,','DaaS,','Jump,','Cloud,','Directory' - - # A URL to the license for this module. - LicenseUri = 'https://github.com/TheJumpCloud/jcapi-powershell/tree/master/LICENSE' - - # A URL to the main website for this project. - ProjectUri = 'https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/' - - # A URL to an icon representing this module. - # IconUri = '' - - # ReleaseNotes of this module - # ReleaseNotes = '' - - # Prerelease string of this module - # Prerelease = '' - - # Flag to indicate whether the module requires explicit user acceptance for install/update/save - # RequireLicenseAcceptance = $false - - # External dependent modules of this module - # ExternalModuleDependencies = @() - - } # End of PSData hashtable - - } # End of PrivateData hashtable - -# HelpInfo URI of this module -# HelpInfoURI = '' - -# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. -# DefaultCommandPrefix = '' - + Tags = 'JumpCloud,', 'DaaS,', 'Jump,', 'Cloud,', 'Directory' + LicenseUri = 'https://github.com/TheJumpCloud/jcapi-powershell/tree/master/LICENSE' + ProjectUri = 'https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/' + ReleaseNotes = '' + } + } } - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/check-dependencies.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/check-dependencies.ps1 index 6566187bc..b999d9d54 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/check-dependencies.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/check-dependencies.ps1 @@ -47,10 +47,9 @@ $resourceModule = Join-Path $HOME '.PSSharedModules\Resources\Az.Resources.TestS if ($Resources.IsPresent -and ((-not (Test-Path -Path $resourceModule)) -or $RegenerateSupportModule.IsPresent)) { Write-Host -ForegroundColor Green "Building local Resource module used for test..." Set-Location $resourceDir - $null = npx autorest .\README.md --version:3.10.8 --use:@autorest/powershell@3.0.414 --output-folder=$HOME/.PSSharedModules/Resources + $null = autorest .\README.md --use:@autorest/powershell@3.0.414 --output-folder=$HOME/.PSSharedModules/Resources $null = Copy-Item custom/* $HOME/.PSSharedModules/Resources/custom/ Set-Location $HOME/.PSSharedModules/Resources $null = .\build-module.ps1 Set-Location $PSScriptRoot } - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/Module.cs b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/Module.cs index 0cb6abc47..0747ef56a 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/Module.cs +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/Module.cs @@ -42,6 +42,10 @@ private void SetDefaultHostEnvInPowerShellSession() apiHostValue = "api.eu"; consoleHostValue = "console.eu"; break; + case "IN": + apiHostValue = "api.in"; + consoleHostValue = "console.in"; + break; case "STAGING": apiHostValue = "api.stg01"; consoleHostValue = "console.stg01"; @@ -53,6 +57,11 @@ private void SetDefaultHostEnvInPowerShellSession() apiHostValue = "api.eu"; consoleHostValue = "console.eu"; } + else if (userInputEnvValue.Contains(".in")) + { + apiHostValue = "api.in"; + consoleHostValue = "console.in"; + } else if (userInputEnvValue.Contains(".stg01")) { apiHostValue = "api.stg01"; @@ -81,8 +90,8 @@ private void SetDefaultHostEnvInPowerShellSession() { string defaultHostPrefix = ModuleIdentifier.SDKName == "DirectoryInsights" ? "api" : "console"; Console.WriteLine("JumpCloud SDK Module: {0} is running in the '{1}.jumpcloud.com' host environment.", ModuleIdentifier.SDKName, defaultHostPrefix); - Console.WriteLine("'{0}.jumpcloud.com' is the standard environment; '{0}.eu.jumpcloud.com' is the EU environment.", defaultHostPrefix); - Console.WriteLine("To use the EU environment, run: $ENV:{0} = 'EU' and re-import the module.", envVarNameForDefaultHostEnv); + Console.WriteLine("'{0}.jumpcloud.com' is the standard environment; '{0}.eu.jumpcloud.com' is the EU environment; '{0}.in.jumpcloud.com' is the India environment.", defaultHostPrefix); + Console.WriteLine("To use the EU or IN environments, run: $ENV:{0} = 'EU' or 'IN' and re-import the module.", envVarNameForDefaultHostEnv); Console.WriteLine("To use the standard environment, run: $ENV:{0} = 'STANDARD' and re-import the module.", envVarNameForDefaultHostEnv); } @@ -180,8 +189,8 @@ protected async Task AddAuthHeaders(HttpRequestMessage requ System.Environment.SetEnvironmentVariable("JCEnvironment", HostEnv); // Translate to both formats and set parameter defaults - string apiHost = HostEnv.Contains(".eu") ? "api.eu" : (HostEnv.Contains(".stg01") ? "api.stg01" : "api"); - string consoleHost = HostEnv.Contains(".eu") ? "console.eu" : (HostEnv.Contains(".stg01") ? "console.stg01" : "console"); + string apiHost = HostEnv.Contains(".eu") ? "api.eu" : HostEnv.Contains(".in") ? "api.in" : HostEnv.Contains(".stg01") ? "api.stg01" : "api"; + string consoleHost = HostEnv.Contains(".eu") ? "console.eu" : HostEnv.Contains(".in") ? "console.in" : HostEnv.Contains(".stg01") ? "console.stg01" : "console"; SetPSDefaultHostEnvParameterValue(apiHost, consoleHost); } @@ -212,10 +221,10 @@ protected async Task AddAuthHeaders(HttpRequestMessage requ request.Headers.Add("Accept", "application/json"); } // If headers do not contain an "UserAgent" with the correct value fix it - if (request.Headers.UserAgent.ToString() != "JumpCloud_JumpCloud.PowerShell.SDK.V2/0.2.1") + if (request.Headers.UserAgent.ToString() != "JumpCloud_JumpCloud.PowerShell.SDK.V2/0.3.0") { request.Headers.UserAgent.Clear(); - request.Headers.UserAgent.ParseAdd("JumpCloud_JumpCloud.PowerShell.SDK.V2/0.2.1"); + request.Headers.UserAgent.ParseAdd("JumpCloud_JumpCloud.PowerShell.SDK.V2/0.3.0"); } // // request.Headers.Add("Content-Type", "application/json"); System.Net.Http.HttpResponseMessage response = await next.SendAsync(request, callback); diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/ModuleIdentifier.cs b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/ModuleIdentifier.cs index bfdbd4863..944d146a6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/ModuleIdentifier.cs +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/ModuleIdentifier.cs @@ -2,6 +2,6 @@ namespace ModuleNameSpace { public static class ModuleIdentifier { - public const string SDKName = "V2"; + public const string SDKName = ""; } } diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Clear-JcSdkAppleMdmDevice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Clear-JcSdkAppleMdmDevice.ps1 index ac8c36063..9683ed4c3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Clear-JcSdkAppleMdmDevice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Clear-JcSdkAppleMdmDevice.ps1 @@ -1,78 +1,4 @@ -<# -.Synopsis -Erases a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/erase \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` -.Description -Erases a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/erase \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` -.Example -PS C:\> Clear-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Pin:() - - -.Example -PS C:\> Clear-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Body:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.IPaths1FfbqfwApplemdmsAppleMdmIdDevicesDeviceIdErasePostRequestbodyContentApplicationJsonSchema -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [Pin ]: 6-digit PIN, required for MacOS, to erase the device - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDevice.md -#> - Function Clear-JcSdkAppleMdmDevice +Function Clear-JcSdkAppleMdmDevice { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='ClearExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -217,5 +143,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Clear-JcSdkAppleMdmDeviceActivationLock.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Clear-JcSdkAppleMdmDeviceActivationLock.ps1 index 9f170e174..4715b0c04 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Clear-JcSdkAppleMdmDeviceActivationLock.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Clear-JcSdkAppleMdmDeviceActivationLock.ps1 @@ -1,73 +1,4 @@ -<# -.Synopsis -Clears the activation lock on the specified device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/clearActivationLock \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` -.Description -Clears the activation lock on the specified device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/clearActivationLock \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` -.Example -PS C:\> Clear-JcSdkAppleMdmDeviceActivationLock -AppleMdmId:() -DeviceId:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDeviceActivationLock.md -#> - Function Clear-JcSdkAppleMdmDeviceActivationLock +Function Clear-JcSdkAppleMdmDeviceActivationLock { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Clear', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -195,5 +126,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAccessRequest.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAccessRequest.ps1 index 6910c66c0..cae43aa4f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAccessRequest.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAccessRequest.ps1 @@ -1,53 +1,4 @@ -<# -.Synopsis -Endpoint that returns the workflow access request by id -.Description -Endpoint that returns the workflow access request by id -.Example -PS C:\> Get-JcSdkAccessRequest -Id:() -.Example -PS C:\> Get-JcSdkAccessRequest -Fields:() -Filter:() -Sort:() - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAllWorkflowAccessRequestResponse -.Outputs -JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetWorkflowAccessRequestResponse -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequest.md -#> - Function Get-JcSdkAccessRequest +Function Get-JcSdkAccessRequest { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetWorkflowAccessRequestResponse], [JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAllWorkflowAccessRequestResponse])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -253,5 +204,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAccessRequestProgress.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAccessRequestProgress.ps1 index f842de8ed..6c34a9d37 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAccessRequestProgress.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAccessRequestProgress.ps1 @@ -1,49 +1,4 @@ -<# -.Synopsis -Endpoint for getting the approval progress of a access request -.Description -Endpoint for getting the approval progress of a access request -.Example -PS C:\> Get-JcSdkAccessRequestProgress -Id:() - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAccessRequestApprovalProgressResponse -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequestProgress.md -#> - Function Get-JcSdkAccessRequestProgress +Function Get-JcSdkAccessRequestProgress { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAccessRequestApprovalProgressResponse])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -172,5 +127,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectory.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectory.ps1 index 531df2324..97f4dbc36 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectory.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectory.ps1 @@ -1,89 +1,4 @@ -<# -.Synopsis -This endpoint returns a specific Active Directory. - -#### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Description -This endpoint returns a specific Active Directory. - -#### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Example -PS C:\> Get-JcSdkActiveDirectory -Fields:() -Filter:() -Sort:() - - - ----- ---------- -Domain String -Id String -PrimaryAgent String -UseCase String - - -.Example -PS C:\> Get-JcSdkActiveDirectory -Id:() - - - ----- ---------- -Domain String -Id String -PrimaryAgent String -UseCase String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IActiveDirectory -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectory.md -#> - Function Get-JcSdkActiveDirectory +Function Get-JcSdkActiveDirectory { [OutputType([JumpCloud.SDK.V2.Models.IActiveDirectory])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -299,5 +214,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryAgent.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryAgent.ps1 index 7727b4369..731594a4e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryAgent.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryAgent.ps1 @@ -1,91 +1,4 @@ -<# -.Synopsis -This endpoint returns an Active Directory agent. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns an Active Directory agent. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -Sort:() - - - ----- ---------- -ContactAt String -Hostname String -Id String -SourceIP String -State String -Version String - - -.Example -PS C:\> Get-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -AgentId:() - - - ----- ---------- -ContactAt String -Hostname String -Id String -SourceIP String -State String -Version String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IActiveDirectoryAgentList -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAgent.md -#> - Function Get-JcSdkActiveDirectoryAgent +Function Get-JcSdkActiveDirectoryAgent { [OutputType([JumpCloud.SDK.V2.Models.IActiveDirectoryAgentList])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -278,5 +191,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryAssociation.ps1 index cef3273bd..d353988df 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryAssociation.ps1 @@ -1,88 +1,4 @@ -<# -.Synopsis -This endpoint returns the direct associations of this Active Directory instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. - - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/associations?targets=user \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns the direct associations of this Active Directory instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. - - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/associations?targets=user \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkActiveDirectoryAssociation -ActivedirectoryId:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphConnection -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAssociation.md -#> - Function Get-JcSdkActiveDirectoryAssociation +Function Get-JcSdkActiveDirectoryAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -266,5 +182,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryTraverseUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryTraverseUser.ps1 index 6f78e9a45..cc332b5c9 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryTraverseUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryTraverseUser.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Users bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Active Directory instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Active Directory instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/users \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Users bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Active Directory instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Active Directory instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/users \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkActiveDirectoryTraverseUser -ActivedirectoryId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUser.md -#> - Function Get-JcSdkActiveDirectoryTraverseUser +Function Get-JcSdkActiveDirectoryTraverseUser { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryTraverseUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryTraverseUserGroup.ps1 index ec9dc41c8..83dda1371 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryTraverseUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryTraverseUserGroup.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Users Groups bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Active Directory instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Active Directory instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/usergroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Users Groups bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Active Directory instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Active Directory instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/usergroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkActiveDirectoryTraverseUserGroup -ActivedirectoryId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUserGroup.md -#> - Function Get-JcSdkActiveDirectoryTraverseUserGroup +Function Get-JcSdkActiveDirectoryTraverseUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAdministratorOrganization.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAdministratorOrganization.ps1 index c26854694..e5b3c5df5 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAdministratorOrganization.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAdministratorOrganization.ps1 @@ -1,29 +1,4 @@ -<# -.Synopsis -This endpoint returns the association links between an Administrator and Organizations. -.Description -This endpoint returns the association links between an Administrator and Organizations. -.Example -PS C:\> Get-JcSdkAdministratorOrganization - - - ----- ---------- -Administrator String -Organization String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganization.md -#> - Function Get-JcSdkAdministratorOrganization +Function Get-JcSdkAdministratorOrganization { [OutputType([JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -194,5 +169,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAdministratorOrganizationLink.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAdministratorOrganizationLink.ps1 index d6a1c85d1..7a86e0ddf 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAdministratorOrganizationLink.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAdministratorOrganizationLink.ps1 @@ -1,29 +1,4 @@ -<# -.Synopsis -This endpoint returns the association links between an Organization and Administrators. -.Description -This endpoint returns the association links between an Organization and Administrators. -.Example -PS C:\> Get-JcSdkAdministratorOrganizationLink - - - ----- ---------- -Administrator String -Organization String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganizationLink.md -#> - Function Get-JcSdkAdministratorOrganizationLink +Function Get-JcSdkAdministratorOrganizationLink { [OutputType([JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -194,5 +169,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdm.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdm.ps1 index a08360833..db21f7546 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdm.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdm.ps1 @@ -1,41 +1,4 @@ -<# -.Synopsis -Get a list of all Apple MDM configurations. -An empty topic indicates that a signed certificate from Apple has not been provided to the PUT endpoint yet. - -Note: currently only one MDM configuration per organization is supported. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/applemdms \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -Get a list of all Apple MDM configurations. -An empty topic indicates that a signed certificate from Apple has not been provided to the PUT endpoint yet. - -Note: currently only one MDM configuration per organization is supported. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/applemdms \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkAppleMdm - -Get Apple MDM Server information within a JumpCloud Tenant - -.Outputs -JumpCloud.SDK.V2.Models.IAppleMdm -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdm.md -#> - Function Get-JcSdkAppleMdm +Function Get-JcSdkAppleMdm { [OutputType([JumpCloud.SDK.V2.Models.IAppleMdm])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -221,5 +184,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdmDevice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdmDevice.ps1 index 2a6244314..7b41f094c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdmDevice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdmDevice.ps1 @@ -1,129 +1,4 @@ -<# -.Synopsis -Gets a single Apple MDM device. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ - -H 'accept: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -Gets a single Apple MDM device. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ - -H 'accept: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkAppleMdmDevice -AppleMdmId:() -Filter:() -Sort:() -XTotalCount:() - - - ----- ---------- -CreatedAt String -DepRegistered Boolean -DeviceInformationActivationLockAllowedWhileSupervised Boolean -DeviceInformationAvailableDeviceCapacity System.Nullable[float] DeviceInformationAvailableDeviceCapacity {get;set;} -DeviceInformationDeviceCapacity System.Nullable[float] DeviceInformationDeviceCapacity {get;set;} -DeviceInformationDeviceName String -DeviceInformationIccid String -DeviceInformationImei String -DeviceInformationIsSupervised Boolean -DeviceInformationModelName String -DeviceInformationSecondIccid String -DeviceInformationSecondImei String -DeviceInformationSecondSubscriberCarrierNetwork String -DeviceInformationSubscriberCarrierNetwork String -DeviceInformationWifiMac String -Enrolled Boolean -HasActivationLockBypassCodes Boolean -Id String -OSVersion String -SecurityInfoEnrolledViaDep Boolean -SecurityInfoIsActivationLockManageable Boolean -SecurityInfoIsUserEnrollment Boolean -SecurityInfoPasscodePresent Boolean -SecurityInfoUserApprovedEnrollment Boolean -SerialNumber String -Udid String - - -.Example -PS C:\> Get-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() - - - ----- ---------- -CreatedAt String -DepRegistered Boolean -DeviceInformationActivationLockAllowedWhileSupervised Boolean -DeviceInformationAvailableDeviceCapacity System.Nullable[float] DeviceInformationAvailableDeviceCapacity {get;set;} -DeviceInformationDeviceCapacity System.Nullable[float] DeviceInformationDeviceCapacity {get;set;} -DeviceInformationDeviceName String -DeviceInformationIccid String -DeviceInformationImei String -DeviceInformationIsSupervised Boolean -DeviceInformationModelName String -DeviceInformationSecondIccid String -DeviceInformationSecondImei String -DeviceInformationSecondSubscriberCarrierNetwork String -DeviceInformationSubscriberCarrierNetwork String -DeviceInformationWifiMac String -Enrolled Boolean -HasActivationLockBypassCodes Boolean -Id String -OSVersion String -SecurityInfoEnrolledViaDep Boolean -SecurityInfoIsActivationLockManageable Boolean -SecurityInfoIsUserEnrollment Boolean -SecurityInfoPasscodePresent Boolean -SecurityInfoUserApprovedEnrollment Boolean -SerialNumber String -Udid String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IAppleMdmDevice -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmDevice.md -#> - Function Get-JcSdkAppleMdmDevice +Function Get-JcSdkAppleMdmDevice { [OutputType([JumpCloud.SDK.V2.Models.IAppleMdmDevice])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -343,5 +218,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdmEnrollmentProfile.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdmEnrollmentProfile.ps1 index 15e9c056d..26dd30fad 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdmEnrollmentProfile.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdmEnrollmentProfile.ps1 @@ -1,43 +1,4 @@ -<# -.Synopsis -Get a list of enrollment profiles for an apple mdm. - -Note: currently only one enrollment profile is supported. - -#### Sample Request -``` - curl https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/enrollmentprofiles \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -Get a list of enrollment profiles for an apple mdm. - -Note: currently only one enrollment profile is supported. - -#### Sample Request -``` - curl https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/enrollmentprofiles \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkAppleMdmEnrollmentProfile -AppleMdmId 5ecfd88e63336c651d4f4n59 - -Get a list of enrollment profiles for an apple mdm -.Example -PS C:\> Get-JcSdkAppleMdmEnrollmentProfile -AppleMdmId 5ecfd88e63336c651d4f4n59 -Id 5ecfd88e63336c651d4f4n60 - -Get an enrollment profile by Id - -.Outputs -JumpCloud.SDK.V2.Models.IAppleMdm -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmEnrollmentProfile.md -#> - Function Get-JcSdkAppleMdmEnrollmentProfile +Function Get-JcSdkAppleMdmEnrollmentProfile { [OutputType([JumpCloud.SDK.V2.Models.IAppleMdm])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -153,5 +114,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationAssociation.ps1 index 3d8446bfd..bc96b0f2c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationAssociation.ps1 @@ -1,86 +1,4 @@ -<# -.Synopsis -This endpoint will return the _direct_ associations of an Application. -A direct association can be a non-homogeneous relationship between 2 different objects, for example Applications and User Groups. - - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations?targets=user_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return the _direct_ associations of an Application. -A direct association can be a non-homogeneous relationship between 2 different objects, for example Applications and User Groups. - - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations?targets=user_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkApplicationAssociation -ApplicationId:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphConnection -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationAssociation.md -#> - Function Get-JcSdkApplicationAssociation +Function Get-JcSdkApplicationAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -264,5 +182,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationTraverseUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationTraverseUser.ps1 index 0a00ff4cb..373262c15 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationTraverseUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationTraverseUser.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkApplicationTraverseUser -ApplicationId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUser.md -#> - Function Get-JcSdkApplicationTraverseUser +Function Get-JcSdkApplicationTraverseUser { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationTraverseUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationTraverseUserGroup.ps1 index 9b66b8d65..3a9290a7d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationTraverseUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationTraverseUserGroup.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Users Groups bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Application to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Application. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/usergroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Users Groups bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Application to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Application. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/usergroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkApplicationTraverseUserGroup -ApplicationId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUserGroup.md -#> - Function Get-JcSdkApplicationTraverseUserGroup +Function Get-JcSdkApplicationTraverseUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApprovalFlow.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApprovalFlow.ps1 index c9a5bcc02..08693b796 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApprovalFlow.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApprovalFlow.ps1 @@ -1,53 +1,4 @@ -<# -.Synopsis -Endpoint for getting workflow by id -.Description -Endpoint for getting workflow by id -.Example -PS C:\> Get-JcSdkApprovalFlow -ApprovalFlowId:() -.Example -PS C:\> Get-JcSdkApprovalFlow -Fields:() -Filter:() -Sort:() - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IJumpcloudIngressoAccessWorkflow -.Outputs -JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAllAccessWorkFlowsResponse -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlow.md -#> - Function Get-JcSdkApprovalFlow +Function Get-JcSdkApprovalFlow { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoAccessWorkflow], [JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAllAccessWorkFlowsResponse])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -253,5 +204,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApprovalFlowSetting.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApprovalFlowSetting.ps1 index 531dd9a62..d7628af88 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApprovalFlowSetting.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApprovalFlowSetting.ps1 @@ -1,17 +1,4 @@ -<# -.Synopsis -Endpoint for getting workflow settings for an organisation -.Description -Endpoint for getting workflow settings for an organisation -.Example -PS C:\> Get-JcSdkApprovalFlowSetting - -.Outputs -JumpCloud.SDK.V2.Models.IJumpcloudIngressoAccessWorkflowSettings -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlowSetting.md -#> - Function Get-JcSdkApprovalFlowSetting +Function Get-JcSdkApprovalFlowSetting { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoAccessWorkflowSettings])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -128,5 +115,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAuthenticationPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAuthenticationPolicy.ps1 index bbf4bad89..a010e2bc0 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAuthenticationPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAuthenticationPolicy.ps1 @@ -1,109 +1,4 @@ -<# -.Synopsis -Return a specific authentication policy. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -Return a specific authentication policy. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkAuthenticationPolicy -Filter:() -Sort:() -XTotalCount:() - - - ----- ---------- -Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions -Description String -Disabled Boolean -EffectAction String -Id String -MfaRequired Boolean -Name String -TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] -Type String -UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserGroupExclusions String -UserGroupInclusions String -UserInclusions String -UserVerificationRequirement String - - -.Example -PS C:\> Get-JcSdkAuthenticationPolicy -Id:() - - - ----- ---------- -Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions -Description String -Disabled Boolean -EffectAction String -Id String -MfaRequired Boolean -Name String -TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] -Type String -UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserGroupExclusions String -UserGroupInclusions String -UserInclusions String -UserVerificationRequirement String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IAuthnPolicy -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAuthenticationPolicy.md -#> - Function Get-JcSdkAuthenticationPolicy +Function Get-JcSdkAuthenticationPolicy { [OutputType([JumpCloud.SDK.V2.Models.IAuthnPolicy])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -316,5 +211,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkBulkUserState.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkBulkUserState.ps1 index b46d95481..36cc80c39 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkBulkUserState.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkBulkUserState.ps1 @@ -1,45 +1,4 @@ -<# -.Synopsis -The endpoint allows you to list scheduled statechange jobs. -#### Sample Request -``` -curl -X GET \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ - -H 'x-api-key: {API_KEY}' \\ - -H 'Content-Type: application/json' \\ - -H 'Accept: application/json' -``` -.Description -The endpoint allows you to list scheduled statechange jobs. -#### Sample Request -``` -curl -X GET \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ - -H 'x-api-key: {API_KEY}' \\ - -H 'Content-Type: application/json' \\ - -H 'Accept: application/json' -``` -.Example -PS C:\> Get-JcSdkBulkUserState - - - ----- ---------- -ScheduledDate String -ScheduledJobId String -State String -SystemUserId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.IScheduledUserstateResult -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUserState.md -#> - Function Get-JcSdkBulkUserState +Function Get-JcSdkBulkUserState { [OutputType([JumpCloud.SDK.V2.Models.IScheduledUserstateResult])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -231,5 +190,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkBulkUsersResult.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkBulkUsersResult.ps1 index c4a060e1d..7bac6384d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkBulkUsersResult.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkBulkUsersResult.ps1 @@ -1,84 +1,4 @@ -<# -.Synopsis -This endpoint will return the results of particular user import or get job request. - -#### Sample Request -``` -curl -X GET \\ - https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Description -This endpoint will return the results of particular user import or get job request. - -#### Sample Request -``` -curl -X GET \\ - https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Example -PS C:\> Get-JcSdkBulkUsersResult -JobId:() - - - ----- ---------- -CreatedAt String -Id String -Meta JumpCloud.SDK.V2.Models.JobWorkresultMeta -PersistedFields JumpCloud.SDK.V2.Models.JobWorkresultPersistedFields -Status String -StatusMsg String -UpdatedAt String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IJobWorkresult -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUsersResult.md -#> - Function Get-JcSdkBulkUsersResult +Function Get-JcSdkBulkUsersResult { [OutputType([JumpCloud.SDK.V2.Models.IJobWorkresult])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -255,5 +175,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandAssociation.ps1 index 9786aa98e..4c15317db 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandAssociation.ps1 @@ -1,88 +1,4 @@ -<# -.Synopsis -This endpoint will return the _direct_ associations of this Command. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations?targets=system_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return the _direct_ associations of this Command. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations?targets=system_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkCommandAssociation -CommandId:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphConnection -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandAssociation.md -#> - Function Get-JcSdkCommandAssociation +Function Get-JcSdkCommandAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -266,5 +182,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandTraverseSystem.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandTraverseSystem.ps1 index 91f64e437..99fb7e9f6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandTraverseSystem.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandTraverseSystem.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Systems bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Command to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Command. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systems \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Systems bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Command to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Command. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systems \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkCommandTraverseSystem -CommandId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystem.md -#> - Function Get-JcSdkCommandTraverseSystem +Function Get-JcSdkCommandTraverseSystem { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandTraverseSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandTraverseSystemGroup.ps1 index cd9a1adec..a3672502d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandTraverseSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandTraverseSystemGroup.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all System Groups bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Command to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Command. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systemgroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all System Groups bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Command to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Command. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systemgroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkCommandTraverseSystemGroup -CommandId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystemGroup.md -#> - Function Get-JcSdkCommandTraverseSystemGroup +Function Get-JcSdkCommandTraverseSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCustomEmailConfiguration.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCustomEmailConfiguration.ps1 index 2d44b8f70..e84d74c83 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCustomEmailConfiguration.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCustomEmailConfiguration.ps1 @@ -1,67 +1,4 @@ -<# -.Synopsis -Get the custom email configuration for the specified custom email type -.Description -Get the custom email configuration for the specified custom email type -.Example -PS C:\> Get-JcSdkCustomEmailConfiguration -CustomEmailType:() - - - ----- ---------- -Body String -Button String -Header String -Id String -NextStepContactInfo String -Subject String -Title String -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.ICustomEmail -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailConfiguration.md -#> - Function Get-JcSdkCustomEmailConfiguration +Function Get-JcSdkCustomEmailConfiguration { [OutputType([JumpCloud.SDK.V2.Models.ICustomEmail])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -183,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCustomEmailTemplate.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCustomEmailTemplate.ps1 index af9cbdd95..10512fc11 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCustomEmailTemplate.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCustomEmailTemplate.ps1 @@ -1,31 +1,4 @@ -<# -.Synopsis -Get the list of custom email templates -.Description -Get the list of custom email templates -.Example -PS C:\> Get-JcSdkCustomEmailTemplate - - - ----- ---------- -Description String -DisplayName String -Fields JumpCloud.SDK.V2.Models.CustomEmailTemplateField[] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ICustomEmailTemplate -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailTemplate.md -#> - Function Get-JcSdkCustomEmailTemplate +Function Get-JcSdkCustomEmailTemplate { [OutputType([JumpCloud.SDK.V2.Models.ICustomEmailTemplate])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -135,5 +108,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDirectory.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDirectory.ps1 index 09f7292c5..ac5da6505 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDirectory.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDirectory.ps1 @@ -1,49 +1,4 @@ -<# -.Synopsis -This endpoint returns all active directories (LDAP, O365 Suite, G-Suite). - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/directories \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns all active directories (LDAP, O365 Suite, G-Suite). - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/directories \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkDirectory - - - ----- ---------- -DefaultDomainDomain String -DefaultDomainId String -Id String -Name String -OAuthStatus JumpCloud.SDK.V2.Models.DirectoryOAuthStatus -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.IDirectory -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDirectory.md -#> - Function Get-JcSdkDirectory +Function Get-JcSdkDirectory { [OutputType([JumpCloud.SDK.V2.Models.IDirectory])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -226,5 +181,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDuoAccount.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDuoAccount.ps1 index 5d1e434a1..ee1178cd0 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDuoAccount.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDuoAccount.ps1 @@ -1,83 +1,4 @@ -<# -.Synopsis -This endpoint returns a specific Duo account. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns a specific Duo account. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkDuoAccount - - - ----- ---------- -Id String -Name String - - -.Example -PS C:\> Get-JcSdkDuoAccount -Id:() - - - ----- ---------- -Id String -Name String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IDuoAccount -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoAccount.md -#> - Function Get-JcSdkDuoAccount +Function Get-JcSdkDuoAccount { [OutputType([JumpCloud.SDK.V2.Models.IDuoAccount])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -199,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDuoApplication.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDuoApplication.ps1 index e9c2cd31c..680bd89ea 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDuoApplication.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDuoApplication.ps1 @@ -1,87 +1,4 @@ -<# -.Synopsis -This endpoint returns a specific Duo application that is associated with the specified Duo account. - -#### Sample Request -``` - curl https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns a specific Duo application that is associated with the specified Duo account. - -#### Sample Request -``` - curl https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkDuoApplication -AccountId:() - - - ----- ---------- -ApiHost String -Id String -IntegrationKey String -Name String - - -.Example -PS C:\> Get-JcSdkDuoApplication -AccountId:() -ApplicationId:() - - - ----- ---------- -ApiHost String -Id String -IntegrationKey String -Name String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IDuoApplication -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoApplication.md -#> - Function Get-JcSdkDuoApplication +Function Get-JcSdkDuoApplication { [OutputType([JumpCloud.SDK.V2.Models.IDuoApplication])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -210,5 +127,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuite.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuite.ps1 index a6ada04bc..f24602ec6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuite.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuite.ps1 @@ -1,84 +1,4 @@ -<# -.Synopsis -This endpoint returns a specific G Suite. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns a specific G Suite. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkGSuite -Id:() - - - ----- ---------- -DefaultDomainDomain String -DefaultDomainId String -GroupsEnabled Boolean -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGsuite -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuite.md -#> - Function Get-JcSdkGSuite +Function Get-JcSdkGSuite { [OutputType([JumpCloud.SDK.V2.Models.IGsuite])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -200,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteAssociation.ps1 index 3e3aa8a6e..76a8782fc 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteAssociation.ps1 @@ -1,88 +1,4 @@ -<# -.Synopsis -This endpoint returns the _direct_ associations of this G Suite instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. - - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations?targets=user_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns the _direct_ associations of this G Suite instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. - - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations?targets=user_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkGSuiteAssociation -GsuiteId:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphConnection -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteAssociation.md -#> - Function Get-JcSdkGSuiteAssociation +Function Get-JcSdkGSuiteAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -266,5 +182,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTranslationRule.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTranslationRule.ps1 index f05ff5df1..84ad44cb7 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTranslationRule.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTranslationRule.ps1 @@ -1,89 +1,4 @@ -<# -.Synopsis -This endpoint returns a specific translation rule for a specific G Suite instance. -These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. - -###### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Description -This endpoint returns a specific translation rule for a specific G Suite instance. -These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. - -###### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Example -PS C:\> Get-JcSdkGSuiteTranslationRule -GsuiteId:() -Fields:() -Filter:() -Sort:() - - - ----- ---------- -BuiltIn String -Direction String -Id String - - -.Example -PS C:\> Get-JcSdkGSuiteTranslationRule -GsuiteId:() -Id:() - - - ----- ---------- -BuiltIn String -Direction String -Id String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGSuiteTranslationRule -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTranslationRule.md -#> - Function Get-JcSdkGSuiteTranslationRule +Function Get-JcSdkGSuiteTranslationRule { [OutputType([JumpCloud.SDK.V2.Models.IGSuiteTranslationRule])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -306,5 +221,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTraverseUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTraverseUser.ps1 index c4841b5e1..1ef04b6e2 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTraverseUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTraverseUser.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Users bound to a G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this G Suite instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this G Suite instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/users \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Users bound to a G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this G Suite instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this G Suite instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/users \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkGSuiteTraverseUser -GsuiteId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUser.md -#> - Function Get-JcSdkGSuiteTraverseUser +Function Get-JcSdkGSuiteTraverseUser { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTraverseUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTraverseUserGroup.ps1 index 2d21357c7..4571786b2 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTraverseUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTraverseUserGroup.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all User Groups bound to an G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this G Suite instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this G Suite instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSuite_ID}/usergroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all User Groups bound to an G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this G Suite instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this G Suite instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSuite_ID}/usergroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkGSuiteTraverseUserGroup -GsuiteId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUserGroup.md -#> - Function Get-JcSdkGSuiteTraverseUserGroup +Function Get-JcSdkGSuiteTraverseUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteUsersToImport.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteUsersToImport.ps1 index 5b36ccce5..f0947e353 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteUsersToImport.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteUsersToImport.ps1 @@ -1,29 +1,4 @@ -<# -.Synopsis -Lists G Suite users available for import. -.Description -Lists G Suite users available for import. -.Example -PS C:\> Get-JcSdkGSuiteUsersToImport - - - ----- ---------- -NextPageToken String -Users JumpCloud.SDK.V2.Models.Get200ApplicationJsonPropertiesItemsItem[] - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.IPathsC7Pl4LGsuitesGsuiteIdImportUsersGetResponses200ContentApplicationJsonSchema -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteUsersToImport.md -#> - Function Get-JcSdkGSuiteUsersToImport +Function Get-JcSdkGSuiteUsersToImport { [OutputType([JumpCloud.SDK.V2.Models.IPathsC7Pl4LGsuitesGsuiteIdImportUsersGetResponses200ContentApplicationJsonSchema])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -212,5 +187,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGroup.ps1 index 77ac209f4..353cd8cd3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGroup.ps1 @@ -1,65 +1,4 @@ -<# -.Synopsis -This endpoint returns all Groups that exist in your organization. - -#### Available filter fields: - - `name` - - `disabled` - - `type` - - `memberQueryErrorFlags` - -#### Sample Request - -``` - curl -X GET \\ - https://console.jumpcloud.com/api/v2/groups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns all Groups that exist in your organization. - -#### Available filter fields: - - `name` - - `disabled` - - `type` - - `memberQueryErrorFlags` - -#### Sample Request - -``` - curl -X GET \\ - https://console.jumpcloud.com/api/v2/groups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkGroup - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -Name String -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.IGroup -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGroup.md -#> - Function Get-JcSdkGroup +Function Get-JcSdkGroup { [OutputType([JumpCloud.SDK.V2.Models.IGroup])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -269,5 +208,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGsuiteUsersToImportFormatted.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGsuiteUsersToImportFormatted.ps1 index 373ac2a79..541b06f2e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGsuiteUsersToImportFormatted.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGsuiteUsersToImportFormatted.ps1 @@ -1,29 +1,4 @@ -<# -.Synopsis -Lists available G Suite users for import, translated to the Jumpcloud user schema. -.Description -Lists available G Suite users for import, translated to the Jumpcloud user schema. -.Example -PS C:\> Get-JcSdkGsuiteUsersToImportFormatted - - - ----- ---------- -NextPageToken String -Users JumpCloud.SDK.V2.Models.User[] - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.IPathsKa8FhwGsuitesGsuiteIdImportJumpcloudusersGetResponses200ContentApplicationJsonSchema -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGsuiteUsersToImportFormatted.md -#> - Function Get-JcSdkGsuiteUsersToImportFormatted +Function Get-JcSdkGsuiteUsersToImportFormatted { [OutputType([JumpCloud.SDK.V2.Models.IPathsKa8FhwGsuitesGsuiteIdImportJumpcloudusersGetResponses200ContentApplicationJsonSchema])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -218,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkIPList.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkIPList.ps1 index 59ecf399b..e3600ca00 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkIPList.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkIPList.ps1 @@ -1,87 +1,4 @@ -<# -.Synopsis -Return a specific IP list. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -Return a specific IP list. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkIPList -Filter:() -Sort:() -XTotalCount:() - - - ----- ---------- -Description String -Id String -Ips String -Name String - - -.Example -PS C:\> Get-JcSdkIPList -Id:() - - - ----- ---------- -Description String -Id String -Ips String -Name String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IIPList -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkIPList.md -#> - Function Get-JcSdkIPList +Function Get-JcSdkIPList { [OutputType([JumpCloud.SDK.V2.Models.IIPList])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -294,5 +211,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServer.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServer.ps1 index c7abfabe6..15d8c60a1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServer.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServer.ps1 @@ -1,89 +1,4 @@ -<# -.Synopsis -This endpoint returns a specific LDAP server. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns a specific LDAP server. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkLdapServer -Fields:() -Filter:() -Sort:() - - - ----- ---------- -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - - -.Example -PS C:\> Get-JcSdkLdapServer -Id:() - - - ----- ---------- -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.ILdapServer -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServer.md -#> - Function Get-JcSdkLdapServer +Function Get-JcSdkLdapServer { [OutputType([JumpCloud.SDK.V2.Models.ILdapServer])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -299,5 +214,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerAssociation.ps1 index 40b6ab696..66b424cd4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerAssociation.ps1 @@ -1,88 +1,4 @@ -<# -.Synopsis -This endpoint returns the _direct_ associations of this LDAP Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. - -#### Sample Request - -``` - curl -X GET 'https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations?targets=user_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns the _direct_ associations of this LDAP Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. - -#### Sample Request - -``` - curl -X GET 'https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations?targets=user_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkLdapServerAssociation -LdapserverId:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphConnection -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerAssociation.md -#> - Function Get-JcSdkLdapServerAssociation +Function Get-JcSdkLdapServerAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -266,5 +182,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerSambaDomain.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerSambaDomain.ps1 index 53483268e..330efc597 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerSambaDomain.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerSambaDomain.ps1 @@ -1,87 +1,4 @@ -<# -.Synopsis -This endpoint returns a specific samba domain for an LDAP server. - -##### Sample Request -``` -curl -X GET \\ - https://console.jumpcloud.com/api/v2/ldapservers/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Description -This endpoint returns a specific samba domain for an LDAP server. - -##### Sample Request -``` -curl -X GET \\ - https://console.jumpcloud.com/api/v2/ldapservers/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Example -PS C:\> Get-JcSdkLdapServerSambaDomain -LdapserverId:() -Fields:() -Filter:() -Sort:() - - - ----- ---------- -Id String -Name String -Sid String - - -.Example -PS C:\> Get-JcSdkLdapServerSambaDomain -LdapserverId:() -Id:() - - - ----- ---------- -Id String -Name String -Sid String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.ISambaDomain -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerSambaDomain.md -#> - Function Get-JcSdkLdapServerSambaDomain +Function Get-JcSdkLdapServerSambaDomain { [OutputType([JumpCloud.SDK.V2.Models.ISambaDomain])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -304,5 +221,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerTraverseUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerTraverseUser.ps1 index a12c560c1..43baead44 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerTraverseUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerTraverseUser.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Users bound to an LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this LDAP server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this LDAP server instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Users bound to an LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this LDAP server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this LDAP server instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkLdapServerTraverseUser -LdapserverId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUser.md -#> - Function Get-JcSdkLdapServerTraverseUser +Function Get-JcSdkLdapServerTraverseUser { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerTraverseUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerTraverseUserGroup.ps1 index 578cc6130..18634da8f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerTraverseUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerTraverseUserGroup.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Users Groups bound to a LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this LDAP server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this LDAP server instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Users Groups bound to a LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this LDAP server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this LDAP server instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkLdapServerTraverseUserGroup -LdapserverId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUserGroup.md -#> - Function Get-JcSdkLdapServerTraverseUserGroup +Function Get-JcSdkLdapServerTraverseUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkNextScheduledBulkUserState.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkNextScheduledBulkUserState.ps1 index c93819aa7..b300a7780 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkNextScheduledBulkUserState.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkNextScheduledBulkUserState.ps1 @@ -1,49 +1,4 @@ -<# -.Synopsis -This endpoint is used to lookup the next upcoming scheduled state change for each user in the -given list. -The users parameter is limited to 100 items per request. -The results are also limited -to 100 items. -This endpoint returns a max of 1 event per state per user. -For example, if a user -has 3 ACTIVATED events scheduled it will return the next upcoming activation event. -However, if a -user also has a SUSPENDED event scheduled along with the ACTIVATED events it will return the next -upcoming activation event _and_ the next upcoming suspension event. -.Description -This endpoint is used to lookup the next upcoming scheduled state change for each user in the -given list. -The users parameter is limited to 100 items per request. -The results are also limited -to 100 items. -This endpoint returns a max of 1 event per state per user. -For example, if a user -has 3 ACTIVATED events scheduled it will return the next upcoming activation event. -However, if a -user also has a SUSPENDED event scheduled along with the ACTIVATED events it will return the next -upcoming activation event _and_ the next upcoming suspension event. -.Example -PS C:\> Get-JcSdkNextScheduledBulkUserState - - - ----- ---------- -EventsCount Int -Results JumpCloud.SDK.V2.Models.ScheduledUserstateResult[] - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.IPathsUbbqf1BulkUserstatesEventlistNextGetResponses200ContentApplicationJsonSchema -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkNextScheduledBulkUserState.md -#> - Function Get-JcSdkNextScheduledBulkUserState +Function Get-JcSdkNextScheduledBulkUserState { [OutputType([JumpCloud.SDK.V2.Models.IPathsUbbqf1BulkUserstatesEventlistNextGetResponses200ContentApplicationJsonSchema])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -216,5 +171,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365.ps1 index f0bc4daf4..3d5ed546c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365.ps1 @@ -1,90 +1,4 @@ -<# -.Synopsis -This endpoint returns a specific Office 365 instance. - -##### - -Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint returns a specific Office 365 instance. - -##### - -Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkOffice365 -Office365Id:() - - - ----- ---------- -DefaultDomainDomain String -DefaultDomainId String -GroupsEnabled Boolean -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IOffice365 -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365.md -#> - Function Get-JcSdkOffice365 +Function Get-JcSdkOffice365 { [OutputType([JumpCloud.SDK.V2.Models.IOffice365])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -206,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365Association.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365Association.ps1 index 3e73b1b9c..c09d3bbbf 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365Association.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365Association.ps1 @@ -1,90 +1,4 @@ -<# -.Synopsis -This endpoint returns _direct_ associations of an Office 365 instance. - - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations?targets=user_group' \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint returns _direct_ associations of an Office 365 instance. - - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations?targets=user_group' \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkOffice365Association -Office365Id:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphConnection -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365Association.md -#> - Function Get-JcSdkOffice365Association +Function Get-JcSdkOffice365Association { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -268,5 +182,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TranslationRule.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TranslationRule.ps1 index 4f855842e..619b6491f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TranslationRule.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TranslationRule.ps1 @@ -1,89 +1,4 @@ -<# -.Synopsis -This endpoint returns a specific translation rule for a specific Office 365 instance. -These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. - -###### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Description -This endpoint returns a specific translation rule for a specific Office 365 instance. -These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. - -###### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Example -PS C:\> Get-JcSdkOffice365TranslationRule -Office365Id:() -Fields:() -Filter:() -Sort:() - - - ----- ---------- -BuiltIn String -Direction String -Id String - - -.Example -PS C:\> Get-JcSdkOffice365TranslationRule -Office365Id:() -Id:() - - - ----- ---------- -BuiltIn String -Direction String -Id String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IOffice365TranslationRule -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TranslationRule.md -#> - Function Get-JcSdkOffice365TranslationRule +Function Get-JcSdkOffice365TranslationRule { [OutputType([JumpCloud.SDK.V2.Models.IOffice365TranslationRule])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -306,5 +221,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TraverseUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TraverseUser.ps1 index 4cc16e918..1913d8c6a 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TraverseUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TraverseUser.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Users bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Office 365 instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Office 365 instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Users bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Office 365 instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Office 365 instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkOffice365TraverseUser -Office365Id:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUser.md -#> - Function Get-JcSdkOffice365TraverseUser +Function Get-JcSdkOffice365TraverseUser { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -293,5 +202,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TraverseUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TraverseUserGroup.ps1 index 0c4a01bcc..29d194c11 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TraverseUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TraverseUserGroup.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Users Groups bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Office 365 instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Office 365 instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Users Groups bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Office 365 instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Office 365 instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkOffice365TraverseUserGroup -Office365Id:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUserGroup.md -#> - Function Get-JcSdkOffice365TraverseUserGroup +Function Get-JcSdkOffice365TraverseUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365UsersToImport.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365UsersToImport.ps1 index be76309b4..539e14a67 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365UsersToImport.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365UsersToImport.ps1 @@ -1,30 +1,4 @@ -<# -.Synopsis -Lists Office 365 users available for import. -.Description -Lists Office 365 users available for import. -.Example -PS C:\> Get-JcSdkOffice365UsersToImport - - - ----- ---------- -SkipToken String -Top Int -Users JumpCloud.SDK.V2.Models.Paths1Hu9JikOffice365SOffice365IdImportUsersGetResponses200ContentApplicationJsonSchemaPropertiesUsersItem… - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.IPaths1J0ThkrOffice365SOffice365IdImportUsersGetResponses200ContentApplicationJsonSchema -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365UsersToImport.md -#> - Function Get-JcSdkOffice365UsersToImport +Function Get-JcSdkOffice365UsersToImport { [OutputType([JumpCloud.SDK.V2.Models.IPaths1J0ThkrOffice365SOffice365IdImportUsersGetResponses200ContentApplicationJsonSchema])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -227,5 +201,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOrganizationPolicyResult.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOrganizationPolicyResult.ps1 index 36a9e51f6..a2a54c8a1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOrganizationPolicyResult.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOrganizationPolicyResult.ps1 @@ -1,56 +1,4 @@ -<# -.Synopsis -This endpoint returns all policy results for an organization. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Description -This endpoint returns all policy results for an organization. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Example -PS C:\> Get-JcSdkOrganizationPolicyResult - - - ----- ---------- -Detail String -EndedAt Datetime -ExitStatus System.Nullable[long] ExitStatus {get;set;} -Id String -PolicyId String -StartedAt Datetime -State String -StdErr String -StdOut String -Success Boolean -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.IPolicyResult -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOrganizationPolicyResult.md -#> - Function Get-JcSdkOrganizationPolicyResult +Function Get-JcSdkOrganizationPolicyResult { [OutputType([JumpCloud.SDK.V2.Models.IPolicyResult])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -254,5 +202,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicy.ps1 index 0bbaf7804..455b149c8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicy.ps1 @@ -1,111 +1,4 @@ -<# -.Synopsis -This endpoint returns a specific policy. - -###### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/policies/{PolicyID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Description -This endpoint returns a specific policy. - -###### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/policies/{PolicyID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Example -PS C:\> Get-JcSdkPolicy -Fields:() -Filter:() -Sort:() - - - ----- ---------- -Id String -Name String -TemplateActivation String -TemplateAlert String -TemplateBehavior String -TemplateDeliveryTypes String -TemplateDescription String -TemplateDisplayName String -TemplateId String -TemplateName String -TemplateOSMetaFamily String -TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] -TemplateReference String -TemplateState String - - -.Example -PS C:\> Get-JcSdkPolicy -Id:() - - - ----- ---------- -Id String -Name String -TemplateActivation String -TemplateAlert String -TemplateBehavior String -TemplateDeliveryTypes String -TemplateDescription String -TemplateDisplayName String -TemplateId String -TemplateName String -TemplateOSMetaFamily String -TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] -TemplateReference String -TemplateState String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IPolicy -.Outputs -JumpCloud.SDK.V2.Models.IPolicyWithDetails -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicy.md -#> - Function Get-JcSdkPolicy +Function Get-JcSdkPolicy { [OutputType([JumpCloud.SDK.V2.Models.IPolicyWithDetails], [JumpCloud.SDK.V2.Models.IPolicy])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -321,5 +214,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyAssociation.ps1 index f34275680..3d5cdb143 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyAssociation.ps1 @@ -1,86 +1,4 @@ -<# -.Synopsis -This endpoint returns the _direct_ associations of a Policy. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations?targets=system_group \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns the _direct_ associations of a Policy. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations?targets=system_group \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkPolicyAssociation -PolicyId:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphConnection -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyAssociation.md -#> - Function Get-JcSdkPolicyAssociation +Function Get-JcSdkPolicyAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -264,5 +182,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroup.ps1 index 33737f2a5..fc636de5a 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroup.ps1 @@ -1,91 +1,4 @@ -<# -.Synopsis -This endpoint returns the details of a Policy Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns the details of a Policy Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkPolicyGroup -Fields:() -Filter:() -Sort:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -Name String -Type String - - -.Example -PS C:\> Get-JcSdkPolicyGroup -Id:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -Name String -Type String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IPolicyGroup -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroup.md -#> - Function Get-JcSdkPolicyGroup +Function Get-JcSdkPolicyGroup { [OutputType([JumpCloud.SDK.V2.Models.IPolicyGroup])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -301,5 +214,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupAssociation.ps1 index 758da874d..90645170c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupAssociation.ps1 @@ -1,56 +1,4 @@ -<# -.Synopsis -This endpoint returns the _direct_ associations of this Policy Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations?targets=system \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns the _direct_ associations of this Policy Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations?targets=system \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkPolicyGroupAssociation - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.IGraphConnection -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupAssociation.md -#> - Function Get-JcSdkPolicyGroupAssociation +Function Get-JcSdkPolicyGroupAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -228,5 +176,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupMember.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupMember.ps1 index f8237a781..4817e368b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupMember.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupMember.ps1 @@ -1,97 +1,4 @@ -<# -.Synopsis -This endpoint returns all the Policy Groups a Policy is a member of. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/memberof \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint returns all the Policy Groups a Policy is a member of. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/memberof \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkPolicyGroupMember -PolicyId:() -Filter:() -Sort:() -Authorization:() -Date:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - -.Example -PS C:\> Get-JcSdkPolicyGroupMember -GroupId:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphConnection -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMember.md -#> - Function Get-JcSdkPolicyGroupMember +Function Get-JcSdkPolicyGroupMember { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths], [JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -320,5 +227,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupMembership.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupMembership.ps1 index 6df8a2a6b..cc6419399 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupMembership.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupMembership.ps1 @@ -1,79 +1,4 @@ -<# -.Synopsis -This endpoint returns all Policy members that are a member of this Policy Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/membership \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns all Policy members that are a member of this Policy Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/membership \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkPolicyGroupMembership -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMembership.md -#> - Function Get-JcSdkPolicyGroupMembership +Function Get-JcSdkPolicyGroupMembership { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -280,5 +205,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupTraverseSystem.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupTraverseSystem.ps1 index d345b0d42..18ff3c0d5 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupTraverseSystem.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupTraverseSystem.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Systems bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Policy Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systems \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Systems bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Policy Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systems \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkPolicyGroupTraverseSystem -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystem.md -#> - Function Get-JcSdkPolicyGroupTraverseSystem +Function Get-JcSdkPolicyGroupTraverseSystem { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupTraverseSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupTraverseSystemGroup.ps1 index 8474aff9b..91dc0fa05 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupTraverseSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupTraverseSystemGroup.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all System Groups bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Policy Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all System Groups bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Policy Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkPolicyGroupTraverseSystemGroup -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystemGroup.md -#> - Function Get-JcSdkPolicyGroupTraverseSystemGroup +Function Get-JcSdkPolicyGroupTraverseSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyResult.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyResult.ps1 index 1ce182296..3285d0495 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyResult.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyResult.ps1 @@ -1,101 +1,4 @@ -<# -.Synopsis -This endpoint will return the policy results for a specific policy. - -##### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policyresults/{Policy_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Description -This endpoint will return the policy results for a specific policy. - -##### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policyresults/{Policy_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Example -PS C:\> Get-JcSdkPolicyResult -Id:() - - - ----- ---------- -Detail String -EndedAt Datetime -ExitStatus System.Nullable[long] ExitStatus {get;set;} -Id String -PolicyId String -StartedAt Datetime -State String -StdErr String -StdOut String -Success Boolean -SystemId String - - -.Example -PS C:\> Get-JcSdkPolicyResult -PolicyId:() -Fields:() -Filter:() -Sort:() - - - ----- ---------- -Detail String -EndedAt Datetime -ExitStatus System.Nullable[long] ExitStatus {get;set;} -Id String -PolicyId String -StartedAt Datetime -State String -StdErr String -StdOut String -Success Boolean -SystemId String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IPolicyResult -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyResult.md -#> - Function Get-JcSdkPolicyResult +Function Get-JcSdkPolicyResult { [OutputType([JumpCloud.SDK.V2.Models.IPolicyResult])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -317,5 +220,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyStatus.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyStatus.ps1 index fe959693f..cfe0e14b8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyStatus.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyStatus.ps1 @@ -1,56 +1,4 @@ -<# -.Synopsis -This endpoint returns the latest policy results for a specific policy. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Description -This endpoint returns the latest policy results for a specific policy. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Example -PS C:\> Get-JcSdkPolicyStatus - - - ----- ---------- -Detail String -EndedAt Datetime -ExitStatus System.Nullable[long] ExitStatus {get;set;} -Id String -PolicyId String -StartedAt Datetime -State String -StdErr String -StdOut String -Success Boolean -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.IPolicyResult -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyStatus.md -#> - Function Get-JcSdkPolicyStatus +Function Get-JcSdkPolicyStatus { [OutputType([JumpCloud.SDK.V2.Models.IPolicyResult])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -260,5 +208,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTemplate.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTemplate.ps1 index efa73d472..3ca59aae6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTemplate.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTemplate.ps1 @@ -1,105 +1,4 @@ -<# -.Synopsis -This endpoint returns a specific policy template. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/policytemplates/{Policy_Template_ID}\\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns a specific policy template. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/policytemplates/{Policy_Template_ID}\\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkPolicyTemplate -Fields:() -Filter:() -Sort:() - - - ----- ---------- -Activation String -Alert String -Behavior String -DeliveryTypes String -Description String -DisplayName String -Id String -Name String -OSMetaFamily String -OSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] -Reference String -State String - - -.Example -PS C:\> Get-JcSdkPolicyTemplate -Id:() - - - ----- ---------- -Activation String -Alert String -Behavior String -DeliveryTypes String -Description String -DisplayName String -Id String -Name String -OSMetaFamily String -OSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] -Reference String -State String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IPolicyTemplate -.Outputs -JumpCloud.SDK.V2.Models.IPolicyTemplateWithDetails -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTemplate.md -#> - Function Get-JcSdkPolicyTemplate +Function Get-JcSdkPolicyTemplate { [OutputType([JumpCloud.SDK.V2.Models.IPolicyTemplateWithDetails], [JumpCloud.SDK.V2.Models.IPolicyTemplate])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -315,5 +214,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTraverseSystem.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTraverseSystem.ps1 index 76cf75e6b..8e5d732f1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTraverseSystem.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTraverseSystem.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkPolicyTraverseSystem -PolicyId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystem.md -#> - Function Get-JcSdkPolicyTraverseSystem +Function Get-JcSdkPolicyTraverseSystem { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTraverseSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTraverseSystemGroup.ps1 index 655b193a8..50ce7c6dd 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTraverseSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTraverseSystemGroup.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Systems Groups bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Policy to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Systems Groups bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Policy to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkPolicyTraverseSystemGroup -PolicyId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystemGroup.md -#> - Function Get-JcSdkPolicyTraverseSystemGroup +Function Get-JcSdkPolicyTraverseSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProviderAdministrator.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProviderAdministrator.ps1 index ac41f47f6..85b5735ab 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProviderAdministrator.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProviderAdministrator.ps1 @@ -1,31 +1,4 @@ -<# -.Synopsis -This endpoint returns a list of the Administrators associated with the Provider. -You must be associated with the provider to use this route. -.Description -This endpoint returns a list of the Administrators associated with the Provider. -You must be associated with the provider to use this route. -.Example -PS C:\> Get-JcSdkProviderAdministrator - - - ----- ---------- -Results JumpCloud.SDK.V2.Models.Administrator[] -TotalCount Int - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.IPathsYwlyndProvidersProviderIdAdministratorsGetResponses200ContentApplicationJsonSchema -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderAdministrator.md -#> - Function Get-JcSdkProviderAdministrator +Function Get-JcSdkProviderAdministrator { [OutputType([JumpCloud.SDK.V2.Models.IPathsYwlyndProvidersProviderIdAdministratorsGetResponses200ContentApplicationJsonSchema])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -244,5 +217,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProviderOrganization.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProviderOrganization.ps1 index 28a2fa7f2..ae6e77219 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProviderOrganization.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProviderOrganization.ps1 @@ -1,31 +1,4 @@ -<# -.Synopsis -This endpoint returns a list of the Organizations associated with the Provider. -You must be associated with the provider to use this route. -.Description -This endpoint returns a list of the Organizations associated with the Provider. -You must be associated with the provider to use this route. -.Example -PS C:\> Get-JcSdkProviderOrganization - - - ----- ---------- -Results JumpCloud.SDK.V2.Models.Organization[] -TotalCount Int - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.IPaths1O3J7V8ProvidersProviderIdOrganizationsGetResponses200ContentApplicationJsonSchema -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderOrganization.md -#> - Function Get-JcSdkProviderOrganization +Function Get-JcSdkProviderOrganization { [OutputType([JumpCloud.SDK.V2.Models.IPaths1O3J7V8ProvidersProviderIdOrganizationsGetResponses200ContentApplicationJsonSchema])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -244,5 +217,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProvidersInvoice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProvidersInvoice.ps1 index b7e7e72b8..134d62efa 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProvidersInvoice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProvidersInvoice.ps1 @@ -1,63 +1,4 @@ -<# -.Synopsis -Retrieves a list of invoices for this provider. -You must be associated to the provider to use this endpoint. -.Description -Retrieves a list of invoices for this provider. -You must be associated to the provider to use this endpoint. -.Example -PS C:\> Get-JcSdkProvidersInvoice -ProviderId:() - - - ----- ---------- -Records JumpCloud.SDK.V2.Models.ProviderInvoice[] -TotalCount Int - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IProviderInvoiceResponse -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProvidersInvoice.md -#> - Function Get-JcSdkProvidersInvoice +Function Get-JcSdkProvidersInvoice { [OutputType([JumpCloud.SDK.V2.Models.IProviderInvoiceResponse])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -264,5 +205,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerAssociation.ps1 index dd825f1ed..4614a3e4c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerAssociation.ps1 @@ -1,86 +1,4 @@ -<# -.Synopsis -This endpoint returns the _direct_ associations of a Radius Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations?targets=user_group \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns the _direct_ associations of a Radius Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations?targets=user_group \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkRadiusServerAssociation -RadiusserverId:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphConnection -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerAssociation.md -#> - Function Get-JcSdkRadiusServerAssociation +Function Get-JcSdkRadiusServerAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -264,5 +182,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerTraverseUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerTraverseUser.ps1 index 4e66821a1..68865ec0a 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerTraverseUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerTraverseUser.ps1 @@ -1,97 +1,4 @@ -<# -.Synopsis -This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. - -See `/members` and `/associations` endpoints to manage those collections. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Description -This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. - -See `/members` and `/associations` endpoints to manage those collections. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Example -PS C:\> Get-JcSdkRadiusServerTraverseUser -RadiusserverId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUser.md -#> - Function Get-JcSdkRadiusServerTraverseUser +Function Get-JcSdkRadiusServerTraverseUser { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -289,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerTraverseUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerTraverseUserGroup.ps1 index 79b662d8b..6e3914f24 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerTraverseUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerTraverseUserGroup.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkRadiusServerTraverseUserGroup -RadiusserverId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUserGroup.md -#> - Function Get-JcSdkRadiusServerTraverseUserGroup +Function Get-JcSdkRadiusServerTraverseUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareApp.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareApp.ps1 index c969fd44a..601ff5638 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareApp.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareApp.ps1 @@ -1,87 +1,4 @@ -<# -.Synopsis -Retrieves a Software Application. -The optional isConfigEnabled and appConfiguration apple_vpp attributes are populated in this response. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -Retrieves a Software Application. -The optional isConfigEnabled and appConfiguration apple_vpp attributes are populated in this response. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkSoftwareApp -Filter:() -Sort:() - - - ----- ---------- -DisplayName String -Id String -Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] - - -.Example -PS C:\> Get-JcSdkSoftwareApp -Id:() - - - ----- ---------- -DisplayName String -Id String -Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.ISoftwareApp -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareApp.md -#> - Function Get-JcSdkSoftwareApp +Function Get-JcSdkSoftwareApp { [OutputType([JumpCloud.SDK.V2.Models.ISoftwareApp])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -288,5 +205,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppAssociation.ps1 index a3e6e16c6..6bde7f8b2 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppAssociation.ps1 @@ -1,86 +1,4 @@ -<# -.Synopsis -This endpoint will return the _direct_ associations of a Software Application. -A direct association can be a non-homogeneous relationship between 2 different objects, for example Software Application and System Groups. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations?targets=system_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return the _direct_ associations of a Software Application. -A direct association can be a non-homogeneous relationship between 2 different objects, for example Software Application and System Groups. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations?targets=system_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkSoftwareAppAssociation -SoftwareAppId:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphConnection -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppAssociation.md -#> - Function Get-JcSdkSoftwareAppAssociation +Function Get-JcSdkSoftwareAppAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -264,5 +182,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppStatus.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppStatus.ps1 index 382843b3b..f77bd8fca 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppStatus.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppStatus.ps1 @@ -1,83 +1,4 @@ -<# -.Synopsis -This endpoint allows you to get the status of the provided Software Application on associated JumpCloud systems. - -#### Sample Request -``` -$ curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/statuses \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ -``` -.Description -This endpoint allows you to get the status of the provided Software Application on associated JumpCloud systems. - -#### Sample Request -``` -$ curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/statuses \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ -``` -.Example -PS C:\> Get-JcSdkSoftwareAppStatus -SoftwareAppId:() - - - ----- ---------- -Code Int -Details String -Id String -SoftwareAppId String -State String -SystemId String -Timestamp String -Version String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.ISoftwareAppStatus -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppStatus.md -#> - Function Get-JcSdkSoftwareAppStatus +Function Get-JcSdkSoftwareAppStatus { [OutputType([JumpCloud.SDK.V2.Models.ISoftwareAppStatus])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -284,5 +205,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppTraverseSystem.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppTraverseSystem.ps1 index 7fd6a783a..20fde392c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppTraverseSystem.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppTraverseSystem.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Systems bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Software App to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Software App. - -See `/associations` endpoint to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systems \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Systems bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Software App to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Software App. - -See `/associations` endpoint to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systems \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkSoftwareAppTraverseSystem -SoftwareAppId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystem.md -#> - Function Get-JcSdkSoftwareAppTraverseSystem +Function Get-JcSdkSoftwareAppTraverseSystem { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppTraverseSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppTraverseSystemGroup.ps1 index a28850d1c..fd307a87f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppTraverseSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppTraverseSystemGroup.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Systems Groups bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Software App to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Software App. - -See `/associations` endpoint to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Systems Groups bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Software App to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Software App. - -See `/associations` endpoint to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkSoftwareAppTraverseSystemGroup -SoftwareAppId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystemGroup.md -#> - Function Get-JcSdkSoftwareAppTraverseSystemGroup +Function Get-JcSdkSoftwareAppTraverseSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSubscription.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSubscription.ps1 index 2b0d7e82d..19ed33ded 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSubscription.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSubscription.ps1 @@ -1,51 +1,4 @@ -<# -.Synopsis -This endpoint returns all pricing & packaging subscriptions. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/subscriptions \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Description -This endpoint returns all pricing & packaging subscriptions. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/subscriptions \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Example -PS C:\> Get-JcSdkSubscription - - - ----- ---------- -AnnualPrice float AnnualPrice {get;set;} -DisplayName String -Features JumpCloud.SDK.V2.Models.Feature[] -ListPrice float ListPrice {get;set;} -ProductCode String -UpgradeRecommendation String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISubscription -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSubscription.md -#> - Function Get-JcSdkSubscription +Function Get-JcSdkSubscription { [OutputType([JumpCloud.SDK.V2.Models.ISubscription])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -155,5 +108,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemAssociation.ps1 index ad656dacf..cd2cb47f6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemAssociation.ps1 @@ -1,90 +1,4 @@ -<# -.Synopsis -This endpoint returns the _direct_ associations of a System. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations?targets=user \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint returns the _direct_ associations of a System. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations?targets=user \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkSystemAssociation -SystemId:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphConnection -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemAssociation.md -#> - Function Get-JcSdkSystemAssociation +Function Get-JcSdkSystemAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -280,5 +194,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemFdeKey.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemFdeKey.ps1 index 622948823..a2ca07367 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemFdeKey.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemFdeKey.ps1 @@ -1,55 +1,4 @@ -<# -.Synopsis -This endpoint will return the current (latest) fde key saved for a system. -.Description -This endpoint will return the current (latest) fde key saved for a system. -.Example -PS C:\> Get-JcSdkSystemFdeKey -SystemId:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.ISystemfdekey -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemFdeKey.md -#> - Function Get-JcSdkSystemFdeKey +Function Get-JcSdkSystemFdeKey { [OutputType([JumpCloud.SDK.V2.Models.ISystemfdekey])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -171,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroup.ps1 index 762b87354..e1b3dc0c3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroup.ps1 @@ -1,101 +1,4 @@ -<# -.Synopsis -This endpoint returns the details of a System Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns the details of a System Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkSystemGroup -Fields:() -Filter:() -Sort:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -Type String - - -.Example -PS C:\> Get-JcSdkSystemGroup -Id:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -Type String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.ISystemGroup -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroup.md -#> - Function Get-JcSdkSystemGroup +Function Get-JcSdkSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.ISystemGroup])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -311,5 +214,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupAssociation.ps1 index decbcff75..c90ade75a 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupAssociation.ps1 @@ -1,88 +1,4 @@ -<# -.Synopsis -This endpoint returns the _direct_ associations of a System Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations?targets=user \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns the _direct_ associations of a System Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations?targets=user \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkSystemGroupAssociation -GroupId:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphConnection -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupAssociation.md -#> - Function Get-JcSdkSystemGroupAssociation +Function Get-JcSdkSystemGroupAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -266,5 +182,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupMember.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupMember.ps1 index dda37e1b1..882b66480 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupMember.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupMember.ps1 @@ -1,84 +1,4 @@ -<# -.Synopsis -This endpoint returns the system members of a System Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint returns the system members of a System Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkSystemGroupMember -GroupId:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphConnection -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMember.md -#> - Function Get-JcSdkSystemGroupMember +Function Get-JcSdkSystemGroupMember { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -255,5 +175,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupMembership.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupMembership.ps1 index f47a30d5f..51931a433 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupMembership.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupMembership.ps1 @@ -1,81 +1,4 @@ -<# -.Synopsis -This endpoint returns all Systems that are a member of this System Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID/membership \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint returns all Systems that are a member of this System Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID/membership \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkSystemGroupMembership -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMembership.md -#> - Function Get-JcSdkSystemGroupMembership +Function Get-JcSdkSystemGroupMembership { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -282,5 +205,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseCommand.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseCommand.ps1 index e52672c3b..dda97fe76 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseCommand.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseCommand.ps1 @@ -1,104 +1,4 @@ -<# -.Synopsis -This endpoint will return all Commands bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/commands \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Commands bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/commands \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkSystemGroupTraverseCommand -GroupId:() - - - ----- ---------- -Command String -CommandType String -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -LaunchType String -Name String -Organization String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Schedule String -ScheduleRepeatType String -Timeout String -TimeToLiveSeconds Int -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.ICommandsGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseCommand.md -#> - Function Get-JcSdkSystemGroupTraverseCommand +Function Get-JcSdkSystemGroupTraverseCommand { [OutputType([JumpCloud.SDK.V2.Models.ICommandsGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -303,5 +203,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraversePolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraversePolicy.ps1 index e86453e53..a40c5fef1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraversePolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraversePolicy.ps1 @@ -1,99 +1,4 @@ -<# -.Synopsis -This endpoint will return all Policies bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -This endpoint is not public yet as we haven't finished the code. - -##### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policies \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Policies bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -This endpoint is not public yet as we haven't finished the code. - -##### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policies \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkSystemGroupTraversePolicy -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicy.md -#> - Function Get-JcSdkSystemGroupTraversePolicy +Function Get-JcSdkSystemGroupTraversePolicy { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -291,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraversePolicyGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraversePolicyGroup.ps1 index 436149b23..3389253dc 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraversePolicyGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraversePolicyGroup.ps1 @@ -1,97 +1,4 @@ -<# -.Synopsis -This endpoint will return all Policy Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policygroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint will return all Policy Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policygroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkSystemGroupTraversePolicyGroup -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicyGroup.md -#> - Function Get-JcSdkSystemGroupTraversePolicyGroup +Function Get-JcSdkSystemGroupTraversePolicyGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -289,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseUser.ps1 index 5a4021bdc..f30d404a0 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseUser.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Users bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Users bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkSystemGroupTraverseUser -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUser.md -#> - Function Get-JcSdkSystemGroupTraverseUser +Function Get-JcSdkSystemGroupTraverseUser { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseUserGroup.ps1 index 9fb1d2209..92985c983 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseUserGroup.ps1 @@ -1,97 +1,4 @@ -<# -.Synopsis -This endpoint will return all User Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint will return all User Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkSystemGroupTraverseUserGroup -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUserGroup.md -#> - Function Get-JcSdkSystemGroupTraverseUserGroup +Function Get-JcSdkSystemGroupTraverseUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -289,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlf.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlf.ps1 index 809c93c2e..599230ea4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlf.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlf.ps1 @@ -1,36 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `global_state`. -.Description -Valid filter fields are `system_id` and `global_state`. -.Example -PS C:\> Get-JcSdkSystemInsightAlf - - - ----- ---------- -AllowSignedEnabled Int -CollectionTime String -FirewallUnload Int -GlobalState Int -LoggingEnabled Int -LoggingOption Int -StealthEnabled Int -SystemId String -Version String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsAlf -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlf.md -#> - Function Get-JcSdkSystemInsightAlf +Function Get-JcSdkSystemInsightAlf { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsAlf])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -225,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlfException.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlfException.ps1 index 40b66facd..bff0db81f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlfException.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlfException.ps1 @@ -1,31 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `state`. -.Description -Valid filter fields are `system_id` and `state`. -.Example -PS C:\> Get-JcSdkSystemInsightAlfException - - - ----- ---------- -CollectionTime String -Path String -State System.Nullable[float] State {get;set;} -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsAlfExceptions -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfException.md -#> - Function Get-JcSdkSystemInsightAlfException +Function Get-JcSdkSystemInsightAlfException { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsAlfExceptions])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -220,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlfExplicitAuth.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlfExplicitAuth.ps1 index bf7fc66e3..777053b68 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlfExplicitAuth.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlfExplicitAuth.ps1 @@ -1,30 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `process`. -.Description -Valid filter fields are `system_id` and `process`. -.Example -PS C:\> Get-JcSdkSystemInsightAlfExplicitAuth - - - ----- ---------- -CollectionTime String -Process String -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsAlfExplicitAuths -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfExplicitAuth.md -#> - Function Get-JcSdkSystemInsightAlfExplicitAuth +Function Get-JcSdkSystemInsightAlfExplicitAuth { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsAlfExplicitAuths])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -219,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightApp.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightApp.ps1 index 7dc436f20..e3a6f0c8e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightApp.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightApp.ps1 @@ -1,54 +1,4 @@ -<# -.Synopsis -Lists all apps for macOS devices. -For Windows devices, use [List System Insights Programs](#operation/systeminsights_list_programs). - -Valid filter fields are `system_id` and `bundle_name`. -.Description -Lists all apps for macOS devices. -For Windows devices, use [List System Insights Programs](#operation/systeminsights_list_programs). - -Valid filter fields are `system_id` and `bundle_name`. -.Example -PS C:\> Get-JcSdkSystemInsightApp - - - ----- ---------- -ApplescriptEnabled String -BundleExecutable String -BundleIdentifier String -BundleName String -BundlePackageType String -BundleShortVersion String -BundleVersion String -Category String -CollectionTime String -Compiler String -Copyright String -DevelopmentRegion String -DisplayName String -Element String -Environment String -InfoString -LastOpenedTime System.Nullable[float] LastOpenedTime {get;set;} -MinimumSystemVersion String -Name String -Path String -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsApps -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightApp.md -#> - Function Get-JcSdkSystemInsightApp +Function Get-JcSdkSystemInsightApp { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsApps])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -243,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAppCompatShim.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAppCompatShim.ps1 index 7b50a33e1..f4006ea7d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAppCompatShim.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAppCompatShim.ps1 @@ -1,35 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `enabled`. -.Description -Valid filter fields are `system_id` and `enabled`. -.Example -PS C:\> Get-JcSdkSystemInsightAppCompatShim - - - ----- ---------- -CollectionTime String -Description String -Executable String -InstallTime System.Nullable[float] InstallTime {get;set;} -Path String -SdbId String -SystemId String -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsAppcompatShims -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAppCompatShim.md -#> - Function Get-JcSdkSystemInsightAppCompatShim +Function Get-JcSdkSystemInsightAppCompatShim { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsAppcompatShims])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -224,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAuthorizedKey.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAuthorizedKey.ps1 index 0c6c3d873..a9f78c975 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAuthorizedKey.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAuthorizedKey.ps1 @@ -1,33 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `uid`. -.Description -Valid filter fields are `system_id` and `uid`. -.Example -PS C:\> Get-JcSdkSystemInsightAuthorizedKey - - - ----- ---------- -Algorithm String -CollectionTime String -Key String -KeyFile String -SystemId String -Uid String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsAuthorizedKeys -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAuthorizedKey.md -#> - Function Get-JcSdkSystemInsightAuthorizedKey +Function Get-JcSdkSystemInsightAuthorizedKey { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsAuthorizedKeys])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -222,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAzureInstanceMetadata.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAzureInstanceMetadata.ps1 index f5d93a4e4..c7fd6f9a4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAzureInstanceMetadata.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAzureInstanceMetadata.ps1 @@ -1,45 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id`. -.Description -Valid filter fields are `system_id`. -.Example -PS C:\> Get-JcSdkSystemInsightAzureInstanceMetadata - - - ----- ---------- -CollectionTime String -Location String -Name String -Offer String -OSType String -PlacementGroupId String -PlatformFaultDomain String -PlatformUpdateDomain String -Publisher String -ResourceGroupName String -Sku String -SubscriptionId String -SystemId String -Version String -VMId String -VMScaleSetName String -VMSize String -Zone String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsAzureInstanceMetadata -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceMetadata.md -#> - Function Get-JcSdkSystemInsightAzureInstanceMetadata +Function Get-JcSdkSystemInsightAzureInstanceMetadata { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsAzureInstanceMetadata])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -234,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAzureInstanceTag.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAzureInstanceTag.ps1 index 4f3b5d6f3..9f7791917 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAzureInstanceTag.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAzureInstanceTag.ps1 @@ -1,32 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id`. -.Description -Valid filter fields are `system_id`. -.Example -PS C:\> Get-JcSdkSystemInsightAzureInstanceTag - - - ----- ---------- -CollectionTime String -Key String -SystemId String -Value String -VMId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsAzureInstanceTags -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceTag.md -#> - Function Get-JcSdkSystemInsightAzureInstanceTag +Function Get-JcSdkSystemInsightAzureInstanceTag { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsAzureInstanceTags])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -221,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBattery.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBattery.ps1 index e0d62a19f..c0c13e696 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBattery.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBattery.ps1 @@ -1,47 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `health`. -.Description -Valid filter fields are `system_id` and `health`. -.Example -PS C:\> Get-JcSdkSystemInsightBattery - - - ----- ---------- -Amperage Int -Charged Int -Charging Int -CollectionTime String -Condition String -CurrentCapacity Int -CycleCount Int -DesignedCapacity Int -Health String -ManufactureDate Int -Manufacturer String -MaxCapacity Int -MinutesToFullCharge Int -MinutesUntilEmpty Int -Model String -PercentRemaining Int -SerialNumber String -State String -SystemId String -Voltage Int - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsBattery -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBattery.md -#> - Function Get-JcSdkSystemInsightBattery +Function Get-JcSdkSystemInsightBattery { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsBattery])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -236,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBitlockerInfo.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBitlockerInfo.ps1 index 3da742eda..22d71297b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBitlockerInfo.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBitlockerInfo.ps1 @@ -1,35 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `protection_status`. -.Description -Valid filter fields are `system_id` and `protection_status`. -.Example -PS C:\> Get-JcSdkSystemInsightBitlockerInfo - - - ----- ---------- -CollectionTime String -ConversionStatus Int -DeviceId String -DriveLetter String -EncryptionMethod String -PersistentVolumeId String -ProtectionStatus Int -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsBitlockerInfo -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBitlockerInfo.md -#> - Function Get-JcSdkSystemInsightBitlockerInfo +Function Get-JcSdkSystemInsightBitlockerInfo { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsBitlockerInfo])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -224,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBrowserPlugin.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBrowserPlugin.ps1 index ca30ea688..7d184a8d2 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBrowserPlugin.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBrowserPlugin.ps1 @@ -1,39 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `name`. -.Description -Valid filter fields are `system_id` and `name`. -.Example -PS C:\> Get-JcSdkSystemInsightBrowserPlugin - - - ----- ---------- -CollectionTime String -Description String -DevelopmentRegion String -Disabled Int -Identifier String -Name String -Native Int -Path String -Sdk String -SystemId String -Uid String -Version String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsBrowserPlugins -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBrowserPlugin.md -#> - Function Get-JcSdkSystemInsightBrowserPlugin +Function Get-JcSdkSystemInsightBrowserPlugin { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsBrowserPlugins])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -228,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCertificate.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCertificate.ps1 index deea6ee5f..3007eb5a6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCertificate.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCertificate.ps1 @@ -1,49 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `common_name`. -.Description -Valid filter fields are `system_id` and `common_name`. -.Example -PS C:\> Get-JcSdkSystemInsightCertificate - - - ----- ---------- -AuthorityKeyId String -Ca Int -CommonName String -Issuer String -KeyAlgorithm String -KeyStrength String -KeyUsage String -NotValidAfter String -NotValidBefore String -Path String -SelfSigned Int -Serial String -Sha1 String -Sid String -SigningAlgorithm String -Store String -StoreId String -StoreLocation String -Subject String -SubjectKeyId String -SystemId String -Username String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsCertificates -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCertificate.md -#> - Function Get-JcSdkSystemInsightCertificate +Function Get-JcSdkSystemInsightCertificate { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsCertificates])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -238,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightChassisInfo.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightChassisInfo.ps1 index 64bc0c083..f1be038e2 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightChassisInfo.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightChassisInfo.ps1 @@ -1,42 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id`. -.Description -Valid filter fields are `system_id`. -.Example -PS C:\> Get-JcSdkSystemInsightChassisInfo - - - ----- ---------- -AudibleAlarm String -BreachDescription String -ChassisTypes String -CollectionTime String -Description String -Lock String -Manufacturer String -Model String -SecurityBreach String -Serial String -Sku String -SmbiosTag String -Status String -SystemId String -VisibleAlarm String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsChassisInfo -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChassisInfo.md -#> - Function Get-JcSdkSystemInsightChassisInfo +Function Get-JcSdkSystemInsightChassisInfo { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsChassisInfo])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -231,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightChromeExtension.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightChromeExtension.ps1 index bb0718c7d..b4b575648 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightChromeExtension.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightChromeExtension.ps1 @@ -1,40 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `name`. -.Description -Valid filter fields are `system_id` and `name`. -.Example -PS C:\> Get-JcSdkSystemInsightChromeExtension - - - ----- ---------- -Author String -CollectionTime String -Description String -Identifier String -Locale String -Name String -Path String -Permissions String -Persistent Int -SystemId String -Uid String -UpdateUrl String -Version String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsChromeExtensions -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChromeExtension.md -#> - Function Get-JcSdkSystemInsightChromeExtension +Function Get-JcSdkSystemInsightChromeExtension { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsChromeExtensions])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -229,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightConnectivity.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightConnectivity.ps1 index fd221f6a3..bbf77cfcc 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightConnectivity.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightConnectivity.ps1 @@ -1,38 +1,4 @@ -<# -.Synopsis -The only valid filter field is `system_id`. -.Description -The only valid filter field is `system_id`. -.Example -PS C:\> Get-JcSdkSystemInsightConnectivity - - - ----- ---------- -CollectionTime String -Disconnected Int -Ipv4Internet Int -Ipv4LocalNetwork Int -Ipv4NoTraffic Int -Ipv4Subnet Int -Ipv6Internet Int -Ipv6LocalNetwork Int -Ipv6NoTraffic Int -Ipv6Subnet Int -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsConnectivity -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightConnectivity.md -#> - Function Get-JcSdkSystemInsightConnectivity +Function Get-JcSdkSystemInsightConnectivity { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsConnectivity])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -227,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCrash.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCrash.ps1 index 0cf3299e5..5471f0f4b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCrash.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCrash.ps1 @@ -1,45 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `identifier`. -.Description -Valid filter fields are `system_id` and `identifier`. -.Example -PS C:\> Get-JcSdkSystemInsightCrash - - - ----- ---------- -CollectionTime String -CrashedThread String -CrashPath String -Datetime String -ExceptionCodes String -ExceptionNotes String -ExceptionType String -Identifier String -Parent String -Path String -Pid String -Registers String -Responsible String -StackTrace String -SystemId String -Type String -Uid Int -Version String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsCrashes -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCrash.md -#> - Function Get-JcSdkSystemInsightCrash +Function Get-JcSdkSystemInsightCrash { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsCrashes])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -234,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCupDestination.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCupDestination.ps1 index 8a9aabae3..f9482fd48 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCupDestination.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCupDestination.ps1 @@ -1,31 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `name`. -.Description -Valid filter fields are `system_id` and `name`. -.Example -PS C:\> Get-JcSdkSystemInsightCupDestination - - - ----- ---------- -Name String -OptionName String -OptionValue String -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsCupsDestinations -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCupDestination.md -#> - Function Get-JcSdkSystemInsightCupDestination +Function Get-JcSdkSystemInsightCupDestination { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsCupsDestinations])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -220,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDiskEncryption.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDiskEncryption.ps1 index 45fc79afe..4bf3eca09 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDiskEncryption.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDiskEncryption.ps1 @@ -1,36 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `encryption_status`. -.Description -Valid filter fields are `system_id` and `encryption_status`. -.Example -PS C:\> Get-JcSdkSystemInsightDiskEncryption - - - ----- ---------- -CollectionTime String -Encrypted Int -EncryptionStatus String -Name String -SystemId String -Type String -Uid String -UserUuid String -Uuid String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsDiskEncryption -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskEncryption.md -#> - Function Get-JcSdkSystemInsightDiskEncryption +Function Get-JcSdkSystemInsightDiskEncryption { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsDiskEncryption])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -225,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDiskInfo.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDiskInfo.ps1 index 10c50ccdd..f94bf48e4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDiskInfo.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDiskInfo.ps1 @@ -1,40 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `disk_index`. -.Description -Valid filter fields are `system_id` and `disk_index`. -.Example -PS C:\> Get-JcSdkSystemInsightDiskInfo - - - ----- ---------- -CollectionTime String -Description String -DiskIndex Int -DiskSize String -HardwareModel String -Id String -Manufacturer String -Name String -Partitions Int -PnpDeviceId String -Serial String -SystemId String -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsDiskInfo -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskInfo.md -#> - Function Get-JcSdkSystemInsightDiskInfo +Function Get-JcSdkSystemInsightDiskInfo { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsDiskInfo])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -229,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDnsResolver.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDnsResolver.ps1 index 84aa72d5a..a13dce0cb 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDnsResolver.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDnsResolver.ps1 @@ -1,34 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `type`. -.Description -Valid filter fields are `system_id` and `type`. -.Example -PS C:\> Get-JcSdkSystemInsightDnsResolver - - - ----- ---------- -Address String -CollectionTime String -Id System.Nullable[float] Id {get;set;} -Netmask String -Options String -SystemId String -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsDnsResolvers -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDnsResolver.md -#> - Function Get-JcSdkSystemInsightDnsResolver +Function Get-JcSdkSystemInsightDnsResolver { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsDnsResolvers])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -223,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightEtcHost.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightEtcHost.ps1 index 8c7182fbc..32d2980d6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightEtcHost.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightEtcHost.ps1 @@ -1,31 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `address`. -.Description -Valid filter fields are `system_id` and `address`. -.Example -PS C:\> Get-JcSdkSystemInsightEtcHost - - - ----- ---------- -Address String -CollectionTime String -Hostnames String -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsEtcHosts -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightEtcHost.md -#> - Function Get-JcSdkSystemInsightEtcHost +Function Get-JcSdkSystemInsightEtcHost { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsEtcHosts])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -220,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightFirefoxAddon.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightFirefoxAddon.ps1 index a54c0dea1..a64b00c40 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightFirefoxAddon.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightFirefoxAddon.ps1 @@ -1,43 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `name`. -.Description -Valid filter fields are `system_id` and `name`. -.Example -PS C:\> Get-JcSdkSystemInsightFirefoxAddon - - - ----- ---------- -Active Int -Autoupdate Int -CollectionTime String -Creator String -Description String -Disabled Int -Identifier String -Location String -Name String -Path String -SourceUrl String -SystemId String -Type String -Uid String -Version String -Visible Int - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsFirefoxAddons -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightFirefoxAddon.md -#> - Function Get-JcSdkSystemInsightFirefoxAddon +Function Get-JcSdkSystemInsightFirefoxAddon { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsFirefoxAddons])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -232,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightGroup.ps1 index 438b4ec7d..87fa1618f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightGroup.ps1 @@ -1,34 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `groupname`. -.Description -Valid filter fields are `system_id` and `groupname`. -.Example -PS C:\> Get-JcSdkSystemInsightGroup - - - ----- ---------- -CollectionTime String -Comment String -Gid String -GidSigned String -Groupname String -GroupSid String -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsGroups -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightGroup.md -#> - Function Get-JcSdkSystemInsightGroup +Function Get-JcSdkSystemInsightGroup { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsGroups])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -223,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightIeExtension.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightIeExtension.ps1 index ad9118f68..6506758d8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightIeExtension.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightIeExtension.ps1 @@ -1,33 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `name`. -.Description -Valid filter fields are `system_id` and `name`. -.Example -PS C:\> Get-JcSdkSystemInsightIeExtension - - - ----- ---------- -CollectionTime String -Name String -Path String -RegistryPath String -SystemId String -Version String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsIeExtensions -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightIeExtension.md -#> - Function Get-JcSdkSystemInsightIeExtension +Function Get-JcSdkSystemInsightIeExtension { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsIeExtensions])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -222,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightInterfaceAddress.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightInterfaceAddress.ps1 index 2f8507782..e20a0020c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightInterfaceAddress.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightInterfaceAddress.ps1 @@ -1,36 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `address`. -.Description -Valid filter fields are `system_id` and `address`. -.Example -PS C:\> Get-JcSdkSystemInsightInterfaceAddress - - - ----- ---------- -Address String -Broadcast String -CollectionTime String -FriendlyName String -Interface String -Mask String -PointToPoint String -SystemId String -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsInterfaceAddresses -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceAddress.md -#> - Function Get-JcSdkSystemInsightInterfaceAddress +Function Get-JcSdkSystemInsightInterfaceAddress { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsInterfaceAddresses])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -225,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightInterfaceDetail.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightInterfaceDetail.ps1 index 761bcf3c6..cf0f85f02 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightInterfaceDetail.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightInterfaceDetail.ps1 @@ -1,63 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `interface`. -.Description -Valid filter fields are `system_id` and `interface`. -.Example -PS C:\> Get-JcSdkSystemInsightInterfaceDetail - - - ----- ---------- -Collisions String -ConnectionId String -ConnectionStatus String -Description String -DhcpEnabled Int -DhcpLeaseExpires String -DhcpLeaseObtained String -DhcpServer String -DnsDomain String -DnsDomainSuffixSearchOrder String -DnsHostName String -DnsServerSearchOrder String -Enabled Int -Flags Int -FriendlyName String -Ibytes String -Idrops String -Ierrors String -Interface String -Ipackets String -LastChange String -LinkSpeed String -Mac String -Manufacturer String -Metric Int -Mtu Int -Obytes String -Odrops String -Oerrors String -Opackets String -PciSlot String -PhysicalAdapter Int -Service String -Speed Int -SystemId String -Type Int - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsInterfaceDetails -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceDetail.md -#> - Function Get-JcSdkSystemInsightInterfaceDetail +Function Get-JcSdkSystemInsightInterfaceDetail { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsInterfaceDetails])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -252,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightKernelInfo.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightKernelInfo.ps1 index bf14f2d72..ab1ea3c39 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightKernelInfo.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightKernelInfo.ps1 @@ -1,33 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `version`. -.Description -Valid filter fields are `system_id` and `version`. -.Example -PS C:\> Get-JcSdkSystemInsightKernelInfo - - - ----- ---------- -Arguments String -CollectionTime String -Device String -Path String -SystemId String -Version String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsKernelInfo -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightKernelInfo.md -#> - Function Get-JcSdkSystemInsightKernelInfo +Function Get-JcSdkSystemInsightKernelInfo { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsKernelInfo])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -222,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLaunchd.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLaunchd.ps1 index 7df764526..410e10a07 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLaunchd.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLaunchd.ps1 @@ -1,50 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `name`. -.Description -Valid filter fields are `system_id` and `name`. -.Example -PS C:\> Get-JcSdkSystemInsightLaunchd - - - ----- ---------- -CollectionTime String -Disabled String -Groupname String -InetdCompatibility String -KeepAlive String -Label String -Name String -OnDemand String -Path String -ProcessType String -Program String -ProgramArguments String -QueueDirectories String -RootDirectory String -RunAtLoad String -StartInterval String -StartOnMount String -StderrPath String -StdoutPath String -SystemId String -Username String -WatchPaths String -WorkingDirectory String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsLaunchd -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLaunchd.md -#> - Function Get-JcSdkSystemInsightLaunchd +Function Get-JcSdkSystemInsightLaunchd { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsLaunchd])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -239,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLinuxPackage.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLinuxPackage.ps1 index 3c4e3001b..663709a0e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLinuxPackage.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLinuxPackage.ps1 @@ -1,47 +1,4 @@ -<# -.Synopsis -Lists all programs for Linux devices. -For macOS devices, use [List System Insights System Apps](#operation/systeminsights_list_apps). -For windows devices, use [List System Insights System Apps](#operation/systeminsights_list_programs). - -Valid filter fields are `name` and `package_format`. -.Description -Lists all programs for Linux devices. -For macOS devices, use [List System Insights System Apps](#operation/systeminsights_list_apps). -For windows devices, use [List System Insights System Apps](#operation/systeminsights_list_programs). - -Valid filter fields are `name` and `package_format`. -.Example -PS C:\> Get-JcSdkSystemInsightLinuxPackage - - - ----- ---------- -Arch String -InstallTime Int -MaintainerOrVendor String -MountNamespaceId String -Name String -PackageFormat String -PackageGroupOrSection String -PidWithNamespace Int -ReleaseOrRevision String -Size String -SystemId String -Version String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsLinuxPackages -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLinuxPackage.md -#> - Function Get-JcSdkSystemInsightLinuxPackage +Function Get-JcSdkSystemInsightLinuxPackage { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsLinuxPackages])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -236,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLoggedinUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLoggedinUser.ps1 index 997dc16f0..65e8195e8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLoggedinUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLoggedinUser.ps1 @@ -1,35 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `user`. -.Description -Valid filter fields are `system_id` and `user`. -.Example -PS C:\> Get-JcSdkSystemInsightLoggedinUser - - - ----- ---------- -CollectionTime String -Host String -Pid Int -SystemId String -Time Int -Tty String -Type String -User String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsLoggedInUsers -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLoggedinUser.md -#> - Function Get-JcSdkSystemInsightLoggedinUser +Function Get-JcSdkSystemInsightLoggedinUser { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsLoggedInUsers])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -224,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLogicalDrive.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLogicalDrive.ps1 index 067284dc7..afb27862e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLogicalDrive.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLogicalDrive.ps1 @@ -1,35 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `device_id`. -.Description -Valid filter fields are `system_id` and `device_id`. -.Example -PS C:\> Get-JcSdkSystemInsightLogicalDrive - - - ----- ---------- -BootPartition Int -CollectionTime String -DeviceId String -FileSystem String -FreeSpace String -Size String -SystemId String -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsLogicalDrives -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLogicalDrive.md -#> - Function Get-JcSdkSystemInsightLogicalDrive +Function Get-JcSdkSystemInsightLogicalDrive { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsLogicalDrives])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -224,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightManagedPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightManagedPolicy.ps1 index 0bd27bafb..25b13c400 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightManagedPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightManagedPolicy.ps1 @@ -1,35 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `domain`. -.Description -Valid filter fields are `system_id` and `domain`. -.Example -PS C:\> Get-JcSdkSystemInsightManagedPolicy - - - ----- ---------- -CollectionTime String -Domain String -Manual Int -Name String -SystemId String -Username String -Uuid String -Value String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsManagedPolicies -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightManagedPolicy.md -#> - Function Get-JcSdkSystemInsightManagedPolicy +Function Get-JcSdkSystemInsightManagedPolicy { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsManagedPolicies])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -224,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightMount.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightMount.ps1 index dc803e22a..9ae5e0ae0 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightMount.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightMount.ps1 @@ -1,40 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `path`. -.Description -Valid filter fields are `system_id` and `path`. -.Example -PS C:\> Get-JcSdkSystemInsightMount - - - ----- ---------- -Blocks String -BlocksAvailable String -BlocksFree String -BlocksSize String -CollectionTime String -Device String -DeviceAlias String -Flags String -Inodes String -InodesFree String -Path String -SystemId String -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsMounts -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightMount.md -#> - Function Get-JcSdkSystemInsightMount +Function Get-JcSdkSystemInsightMount { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsMounts])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -229,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightOSVersion.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightOSVersion.ps1 index 7e0d52aec..f1e382d63 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightOSVersion.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightOSVersion.ps1 @@ -1,39 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `version`. -.Description -Valid filter fields are `system_id` and `version`. -.Example -PS C:\> Get-JcSdkSystemInsightOSVersion - - - ----- ---------- -Build String -Codename String -CollectionTime String -InstallDate String -Major Int -Minor Int -Name String -Patch Int -Platform String -PlatformLike String -SystemId String -Version String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsOSVersion -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightOSVersion.md -#> - Function Get-JcSdkSystemInsightOSVersion +Function Get-JcSdkSystemInsightOSVersion { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsOSVersion])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -228,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightPatch.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightPatch.ps1 index 449616376..ccd54c7b4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightPatch.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightPatch.ps1 @@ -1,37 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `hotfix_id`. -.Description -Valid filter fields are `system_id` and `hotfix_id`. -.Example -PS C:\> Get-JcSdkSystemInsightPatch - - - ----- ---------- -Caption String -CollectionTime String -Csname String -Description String -FixComments String -HotfixId String -InstallDate String -InstalledBy String -InstalledOn String -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsPatches -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPatch.md -#> - Function Get-JcSdkSystemInsightPatch +Function Get-JcSdkSystemInsightPatch { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsPatches])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -226,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightProgram.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightProgram.ps1 index 9895708c1..e5dc3d50b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightProgram.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightProgram.ps1 @@ -1,44 +1,4 @@ -<# -.Synopsis -Lists all programs for Windows devices. -For macOS devices, use [List System Insights Apps](#operation/systeminsights_list_apps). - -Valid filter fields are `system_id` and `name`. -.Description -Lists all programs for Windows devices. -For macOS devices, use [List System Insights Apps](#operation/systeminsights_list_apps). - -Valid filter fields are `system_id` and `name`. -.Example -PS C:\> Get-JcSdkSystemInsightProgram - - - ----- ---------- -CollectionTime String -IdentifyingNumber String -InstallDate String -InstallLocation String -InstallSource String -Language String -Name String -Publisher String -SystemId String -UninstallString -Version String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsPrograms -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightProgram.md -#> - Function Get-JcSdkSystemInsightProgram +Function Get-JcSdkSystemInsightProgram { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsPrograms])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -233,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightPythonPackage.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightPythonPackage.ps1 index 8307d5cc4..1c4fa0e34 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightPythonPackage.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightPythonPackage.ps1 @@ -1,35 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `name`. -.Description -Valid filter fields are `system_id` and `name`. -.Example -PS C:\> Get-JcSdkSystemInsightPythonPackage - - - ----- ---------- -Auther String -Directory String -License String -Name String -Path String -Summary String -SystemId String -Version String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsPythonPackages -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPythonPackage.md -#> - Function Get-JcSdkSystemInsightPythonPackage +Function Get-JcSdkSystemInsightPythonPackage { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsPythonPackages])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -224,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSafariExtension.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSafariExtension.ps1 index 189a7cd02..90c9dcfbe 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSafariExtension.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSafariExtension.ps1 @@ -1,39 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `name`. -.Description -Valid filter fields are `system_id` and `name`. -.Example -PS C:\> Get-JcSdkSystemInsightSafariExtension - - - ----- ---------- -Author String -CollectionTime String -Description String -DeveloperId String -Identifier String -Name String -Path String -Sdk String -SystemId String -Uid String -UpdateUrl String -Version String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsSafariExtensions -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSafariExtension.md -#> - Function Get-JcSdkSystemInsightSafariExtension +Function Get-JcSdkSystemInsightSafariExtension { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsSafariExtensions])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -228,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightScheduledTask.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightScheduledTask.ps1 index 3c9a0bdd2..14687f1bf 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightScheduledTask.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightScheduledTask.ps1 @@ -1,38 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `enabled`. -.Description -Valid filter fields are `system_id` and `enabled`. -.Example -PS C:\> Get-JcSdkSystemInsightScheduledTask - - - ----- ---------- -Action String -Enabled Int -Hidden Int -LastRunCode String -LastRunMessage String -LastRunTime String -Name String -NextRunTime String -Path String -State String -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsScheduledTasks -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightScheduledTask.md -#> - Function Get-JcSdkSystemInsightScheduledTask +Function Get-JcSdkSystemInsightScheduledTask { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsScheduledTasks])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -227,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSecureboot.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSecureboot.ps1 index c8f20626f..315db03c8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSecureboot.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSecureboot.ps1 @@ -1,31 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id`. -.Description -Valid filter fields are `system_id`. -.Example -PS C:\> Get-JcSdkSystemInsightSecureboot - - - ----- ---------- -CollectionTime String -SecureBoot System.Nullable[float] SecureBoot {get;set;} -SetupMode System.Nullable[float] SetupMode {get;set;} -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsSecureboot -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSecureboot.md -#> - Function Get-JcSdkSystemInsightSecureboot +Function Get-JcSdkSystemInsightSecureboot { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsSecureboot])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -220,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightService.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightService.ps1 index 1a9502bc8..afd070421 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightService.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightService.ps1 @@ -1,40 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `name`. -.Description -Valid filter fields are `system_id` and `name`. -.Example -PS C:\> Get-JcSdkSystemInsightService - - - ----- ---------- -Description String -DisplayName String -ModulePath String -Name String -Path String -Pid Int -ServiceExitCode Int -ServiceType String -StartType String -Status String -SystemId String -UserAccount String -Win32ExitCode Int - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsServices -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightService.md -#> - Function Get-JcSdkSystemInsightService +Function Get-JcSdkSystemInsightService { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsServices])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -229,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightShadow.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightShadow.ps1 index 695dc8243..d0e6e32ad 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightShadow.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightShadow.ps1 @@ -1,39 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `username`. -.Description -Valid filter fields are `system_id` and `username`. -.Example -PS C:\> Get-JcSdkSystemInsightShadow - - - ----- ---------- -CollectionTime String -Expire String -Flag String -HashAlg String -Inactive String -LastChange String -Max String -Min String -PasswordStatus String -SystemId String -Username String -Warning String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsShadow -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightShadow.md -#> - Function Get-JcSdkSystemInsightShadow +Function Get-JcSdkSystemInsightShadow { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsShadow])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -228,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharedFolder.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharedFolder.ps1 index fa8b23f83..4ef0db8a2 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharedFolder.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharedFolder.ps1 @@ -1,31 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `name`. -.Description -Valid filter fields are `system_id` and `name`. -.Example -PS C:\> Get-JcSdkSystemInsightSharedFolder - - - ----- ---------- -CollectionTime String -Name String -Path String -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsSharedFolders -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedFolder.md -#> - Function Get-JcSdkSystemInsightSharedFolder +Function Get-JcSdkSystemInsightSharedFolder { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsSharedFolders])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -220,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharedResource.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharedResource.ps1 index d9debb1fb..aace56e6a 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharedResource.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharedResource.ps1 @@ -1,37 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `type`. -.Description -Valid filter fields are `system_id` and `type`. -.Example -PS C:\> Get-JcSdkSystemInsightSharedResource - - - ----- ---------- -AllowMaximum Int -CollectionTime String -Description String -InstallDate String -MaximumAllowed String -Name String -Path String -Status String -SystemId String -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsSharedResources -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedResource.md -#> - Function Get-JcSdkSystemInsightSharedResource +Function Get-JcSdkSystemInsightSharedResource { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsSharedResources])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -226,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharingPreference.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharingPreference.ps1 index 91f16cfec..ab9652b81 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharingPreference.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharingPreference.ps1 @@ -1,39 +1,4 @@ -<# -.Synopsis -Only valid filed field is `system_id`. -.Description -Only valid filed field is `system_id`. -.Example -PS C:\> Get-JcSdkSystemInsightSharingPreference - - - ----- ---------- -BluetoothSharing Int -CollectionTime String -ContentCaching Int -DiscSharing Int -FileSharing Int -InternetSharing Int -PrinterSharing Int -RemoteAppleEvents Int -RemoteLogin Int -RemoteManagement Int -ScreenSharing Int -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsSharingPreferences -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharingPreference.md -#> - Function Get-JcSdkSystemInsightSharingPreference +Function Get-JcSdkSystemInsightSharingPreference { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsSharingPreferences])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -228,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSipConfig.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSipConfig.ps1 index 3e6f8aec3..97eb10e7a 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSipConfig.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSipConfig.ps1 @@ -1,32 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `enabled`. -.Description -Valid filter fields are `system_id` and `enabled`. -.Example -PS C:\> Get-JcSdkSystemInsightSipConfig - - - ----- ---------- -CollectionTime String -ConfigFlag String -Enabled Int -EnabledNvram Int -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsSipConfig -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSipConfig.md -#> - Function Get-JcSdkSystemInsightSipConfig +Function Get-JcSdkSystemInsightSipConfig { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsSipConfig])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -221,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightStartupItem.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightStartupItem.ps1 index bdc4a23b6..8431f518e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightStartupItem.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightStartupItem.ps1 @@ -1,35 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `name`. -.Description -Valid filter fields are `system_id` and `name`. -.Example -PS C:\> Get-JcSdkSystemInsightStartupItem - - - ----- ---------- -Args String -Name String -Path String -Source String -Status String -SystemId String -Type String -Username String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsStartupItems -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightStartupItem.md -#> - Function Get-JcSdkSystemInsightStartupItem +Function Get-JcSdkSystemInsightStartupItem { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsStartupItems])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -224,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSystemControl.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSystemControl.ps1 index b15441920..7852f2cd0 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSystemControl.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSystemControl.ps1 @@ -1,36 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `name`. -.Description -Valid filter fields are `system_id` and `name`. -.Example -PS C:\> Get-JcSdkSystemInsightSystemControl - - - ----- ---------- -CollectionTime String -ConfigValue String -CurrentValue String -FieldName String -Name String -Oid String -Subsystem String -SystemId String -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsSystemControls -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemControl.md -#> - Function Get-JcSdkSystemInsightSystemControl +Function Get-JcSdkSystemInsightSystemControl { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsSystemControls])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -225,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSystemInfo.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSystemInfo.ps1 index 5c090bc42..5ee5ddb62 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSystemInfo.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSystemInfo.ps1 @@ -1,44 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `cpu_subtype`. -.Description -Valid filter fields are `system_id` and `cpu_subtype`. -.Example -PS C:\> Get-JcSdkSystemInsightSystemInfo - - - ----- ---------- -CollectionTime String -ComputerName String -CpuBrand String -CpuLogicalCores Int -CpuMicrocode String -CpuPhysicalCores Int -CpuSubtype String -CpuType String -HardwareModel String -HardwareSerial String -HardwareVendor String -HardwareVersion String -Hostname String -LocalHostname String -PhysicalMemory String -SystemId String -Uuid String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsSystemInfo -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemInfo.md -#> - Function Get-JcSdkSystemInsightSystemInfo +Function Get-JcSdkSystemInsightSystemInfo { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsSystemInfo])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -233,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightTpmInfo.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightTpmInfo.ps1 index cceb72c87..ca9c067d5 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightTpmInfo.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightTpmInfo.ps1 @@ -1,38 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id`. -.Description -Valid filter fields are `system_id`. -.Example -PS C:\> Get-JcSdkSystemInsightTpmInfo - - - ----- ---------- -Activated System.Nullable[float] Activated {get;set;} -CollectionTime String -Enabled System.Nullable[float] Enabled {get;set;} -ManufacturerId System.Nullable[float] ManufacturerId {get;set;} -ManufacturerName String -ManufacturerVersion String -Owned System.Nullable[float] Owned {get;set;} -PhysicalPresenceVersion String -ProductName String -SpecVersion String -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsTpmInfo -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightTpmInfo.md -#> - Function Get-JcSdkSystemInsightTpmInfo +Function Get-JcSdkSystemInsightTpmInfo { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsTpmInfo])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -227,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUptime.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUptime.ps1 index 3edf3047f..6b4b42477 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUptime.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUptime.ps1 @@ -1,34 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `days`. -.Description -Valid filter fields are `system_id` and `days`. -.Example -PS C:\> Get-JcSdkSystemInsightUptime - - - ----- ---------- -CollectionTime String -Days Int -Hours Int -Minutes Int -Seconds Int -SystemId String -TotalSeconds String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsUptime -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUptime.md -#> - Function Get-JcSdkSystemInsightUptime +Function Get-JcSdkSystemInsightUptime { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsUptime])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -223,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUsbDevice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUsbDevice.ps1 index 2c68ae51e..65de3f8f6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUsbDevice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUsbDevice.ps1 @@ -1,41 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `model`. -.Description -Valid filter fields are `system_id` and `model`. -.Example -PS C:\> Get-JcSdkSystemInsightUsbDevice - - - ----- ---------- -Class String -CollectionTime String -Model String -ModelId String -Protocol String -Removable Int -Serial String -Subclass String -SystemId String -UsbAddress Int -UsbPort Int -Vendor String -VendorId String -Version String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsUsbDevices -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUsbDevice.md -#> - Function Get-JcSdkSystemInsightUsbDevice +Function Get-JcSdkSystemInsightUsbDevice { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsUsbDevices])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -230,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUser.ps1 index 6d12c5660..cceadf1a4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUser.ps1 @@ -1,45 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `username`. -.Description -Valid filter fields are `system_id` and `username`. -.Example -PS C:\> Get-JcSdkSystemInsightUser - - - ----- ---------- -AdManaged Boolean -Admin Boolean -CollectionTime String -Description String -Directory String -Gid String -GidSigned String -LastLogin String -Managed Boolean -RealUser Boolean -Shell String -Suspended Boolean -SystemId String -Type String -Uid String -UidSigned String -Username String -Uuid String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsUsers -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUser.md -#> - Function Get-JcSdkSystemInsightUser +Function Get-JcSdkSystemInsightUser { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsUsers])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -234,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserAssist.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserAssist.ps1 index d02a6682d..203a2b972 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserAssist.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserAssist.ps1 @@ -1,33 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id`. -.Description -Valid filter fields are `system_id`. -.Example -PS C:\> Get-JcSdkSystemInsightUserAssist - - - ----- ---------- -CollectionTime String -Count System.Nullable[float] Count {get;set;} -LastExecutionTime System.Nullable[float] LastExecutionTime {get;set;} -Path String -Sid String -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsUserassist -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserAssist.md -#> - Function Get-JcSdkSystemInsightUserAssist +Function Get-JcSdkSystemInsightUserAssist { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsUserassist])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -222,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserGroup.ps1 index 2118d3675..504a7c791 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserGroup.ps1 @@ -1,31 +1,4 @@ -<# -.Synopsis -Only valid filter field is `system_id`. -.Description -Only valid filter field is `system_id`. -.Example -PS C:\> Get-JcSdkSystemInsightUserGroup - - - ----- ---------- -CollectionTime String -Gid String -SystemId String -Uid String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsUserGroups -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserGroup.md -#> - Function Get-JcSdkSystemInsightUserGroup +Function Get-JcSdkSystemInsightUserGroup { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsUserGroups])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -220,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserSshKey.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserSshKey.ps1 index c7b25c022..cc5861f79 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserSshKey.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserSshKey.ps1 @@ -1,32 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `uid`. -.Description -Valid filter fields are `system_id` and `uid`. -.Example -PS C:\> Get-JcSdkSystemInsightUserSshKey - - - ----- ---------- -CollectionTime String -Encrypted Int -Path String -SystemId String -Uid String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsUserSshKeys -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserSshKey.md -#> - Function Get-JcSdkSystemInsightUserSshKey +Function Get-JcSdkSystemInsightUserSshKey { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsUserSshKeys])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -221,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWifiNetwork.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWifiNetwork.ps1 index 5e26586aa..56b2c04cc 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWifiNetwork.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWifiNetwork.ps1 @@ -1,41 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `security_type`. -.Description -Valid filter fields are `system_id` and `security_type`. -.Example -PS C:\> Get-JcSdkSystemInsightWifiNetwork - - - ----- ---------- -AutoLogin System.Nullable[float] AutoLogin {get;set;} -CaptivePortal System.Nullable[float] CaptivePortal {get;set;} -CollectionTime String -Disabled System.Nullable[float] Disabled {get;set;} -LastConnected System.Nullable[float] LastConnected {get;set;} -NetworkName String -Passpoint System.Nullable[float] Passpoint {get;set;} -PossiblyHidden System.Nullable[float] PossiblyHidden {get;set;} -Roaming System.Nullable[float] Roaming {get;set;} -RoamingProfile String -SecurityType String -Ssid String -SystemId String -TemporarilyDisabled System.Nullable[float] TemporarilyDisabled {get;set;} - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsWifiNetworks -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiNetwork.md -#> - Function Get-JcSdkSystemInsightWifiNetwork +Function Get-JcSdkSystemInsightWifiNetwork { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsWifiNetworks])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -230,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWifiStatus.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWifiStatus.ps1 index 161c0e936..fc3f7bdd7 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWifiStatus.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWifiStatus.ps1 @@ -1,42 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `security_type`. -.Description -Valid filter fields are `system_id` and `security_type`. -.Example -PS C:\> Get-JcSdkSystemInsightWifiStatus - - - ----- ---------- -Bssid String -Channel System.Nullable[float] Channel {get;set;} -ChannelBand System.Nullable[float] ChannelBand {get;set;} -ChannelWidth System.Nullable[float] ChannelWidth {get;set;} -CollectionTime String -CountryCode String -Interface String -Mode String -NetworkName String -Noise System.Nullable[float] Noise {get;set;} -Rssi System.Nullable[float] Rssi {get;set;} -SecurityType String -Ssid String -SystemId String -TransmitRate String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsWifiStatus -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiStatus.md -#> - Function Get-JcSdkSystemInsightWifiStatus +Function Get-JcSdkSystemInsightWifiStatus { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsWifiStatus])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -231,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWindowsSecurityCenter.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWindowsSecurityCenter.ps1 index 8ba603026..820684282 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWindowsSecurityCenter.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWindowsSecurityCenter.ps1 @@ -1,36 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id`. -.Description -Valid filter fields are `system_id`. -.Example -PS C:\> Get-JcSdkSystemInsightWindowsSecurityCenter - - - ----- ---------- -Antispyware String -Antivirus String -Autoupdate String -CollectionTime String -Firewall String -InternetSettings String -SystemId String -UserAccountControl String -WindowsSecurityCenterService String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsWindowsSecurityCenter -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityCenter.md -#> - Function Get-JcSdkSystemInsightWindowsSecurityCenter +Function Get-JcSdkSystemInsightWindowsSecurityCenter { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsWindowsSecurityCenter])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -225,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWindowsSecurityProduct.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWindowsSecurityProduct.ps1 index 444260a24..44535daeb 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWindowsSecurityProduct.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWindowsSecurityProduct.ps1 @@ -1,35 +1,4 @@ -<# -.Synopsis -Valid filter fields are `system_id` and `state`. -.Description -Valid filter fields are `system_id` and `state`. -.Example -PS C:\> Get-JcSdkSystemInsightWindowsSecurityProduct - - - ----- ---------- -CollectionTime String -Name String -RemediationPath String -SignaturesUpToDate System.Nullable[float] SignaturesUpToDate {get;set;} -State String -StateTimestamp String -SystemId String -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.ISystemInsightsWindowsSecurityProducts -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityProduct.md -#> - Function Get-JcSdkSystemInsightWindowsSecurityProduct +Function Get-JcSdkSystemInsightWindowsSecurityProduct { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsWindowsSecurityProducts])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -224,5 +193,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemMember.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemMember.ps1 index b54853154..030ba9ed8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemMember.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemMember.ps1 @@ -1,81 +1,4 @@ -<# -.Synopsis -This endpoint returns all the System Groups a System is a member of. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/memberof \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint returns all the System Groups a System is a member of. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/memberof \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkSystemMember -SystemId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemMember.md -#> - Function Get-JcSdkSystemMember +Function Get-JcSdkSystemMember { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -294,5 +217,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemPolicyStatus.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemPolicyStatus.ps1 index 05d108ece..6c93420f2 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemPolicyStatus.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemPolicyStatus.ps1 @@ -1,58 +1,4 @@ -<# -.Synopsis -This endpoint returns the policy results for a particular system. - -##### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint returns the policy results for a particular system. - -##### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkSystemPolicyStatus - - - ----- ---------- -Detail String -EndedAt Datetime -ExitStatus System.Nullable[long] ExitStatus {get;set;} -Id String -PolicyId String -StartedAt Datetime -State String -StdErr String -StdOut String -Success Boolean -SystemId String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.IPolicyResult -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemPolicyStatus.md -#> - Function Get-JcSdkSystemPolicyStatus +Function Get-JcSdkSystemPolicyStatus { [OutputType([JumpCloud.SDK.V2.Models.IPolicyResult])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -262,5 +208,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseCommand.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseCommand.ps1 index f25f2c2d9..7d6cb912d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseCommand.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseCommand.ps1 @@ -1,106 +1,4 @@ -<# -.Synopsis -This endpoint will return all Commands bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/commands \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint will return all Commands bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/commands \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkSystemTraverseCommand -SystemId:() - - - ----- ---------- -Command String -CommandType String -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -LaunchType String -Name String -Organization String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Schedule String -ScheduleRepeatType String -Timeout String -TimeToLiveSeconds Int -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.ICommandsGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseCommand.md -#> - Function Get-JcSdkSystemTraverseCommand +Function Get-JcSdkSystemTraverseCommand { [OutputType([JumpCloud.SDK.V2.Models.ICommandsGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -305,5 +203,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraversePolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraversePolicy.ps1 index bccf31411..d70ae6458 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraversePolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraversePolicy.ps1 @@ -1,103 +1,4 @@ -<# -.Synopsis -This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -This endpoint is not yet public as we have finish the code. - -##### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -This endpoint is not yet public as we have finish the code. - -##### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkSystemTraversePolicy -SystemId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicy.md -#> - Function Get-JcSdkSystemTraversePolicy +Function Get-JcSdkSystemTraversePolicy { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -295,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraversePolicyGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraversePolicyGroup.ps1 index d2f557bcb..5fc6b1d80 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraversePolicyGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraversePolicyGroup.ps1 @@ -1,97 +1,4 @@ -<# -.Synopsis -This endpoint will return all Policy Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policygroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint will return all Policy Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policygroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkSystemTraversePolicyGroup -SystemId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicyGroup.md -#> - Function Get-JcSdkSystemTraversePolicyGroup +Function Get-JcSdkSystemTraversePolicyGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -301,5 +208,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseUser.ps1 index 2ef4bf10c..171d0e288 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseUser.ps1 @@ -1,97 +1,4 @@ -<# -.Synopsis -This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkSystemTraverseUser -SystemId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUser.md -#> - Function Get-JcSdkSystemTraverseUser +Function Get-JcSdkSystemTraverseUser { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -301,5 +208,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseUserGroup.ps1 index f4eccf8f3..23d315583 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseUserGroup.ps1 @@ -1,97 +1,4 @@ -<# -.Synopsis -This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkSystemTraverseUserGroup -SystemId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUserGroup.md -#> - Function Get-JcSdkSystemTraverseUserGroup +Function Get-JcSdkSystemTraverseUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -301,5 +208,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserAssociation.ps1 index b1daf5df2..9fb10ed0e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserAssociation.ps1 @@ -1,90 +1,4 @@ -<# -.Synopsis -This endpoint returns the _direct_ associations of a User. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/associations?targets=system_group \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint returns the _direct_ associations of a User. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/associations?targets=system_group \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkUserAssociation -UserId:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphConnection -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserAssociation.md -#> - Function Get-JcSdkUserAssociation +Function Get-JcSdkUserAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -268,5 +182,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroup.ps1 index 87cd98019..fe53ed33b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroup.ps1 @@ -1,107 +1,4 @@ -<# -.Synopsis -This endpoint returns the details of a User Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns the details of a User Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserGroup -Fields:() -Filter:() -Sort:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -SuggestionCountAdd Int -SuggestionCountRemove Int -SuggestionCountTotal Int -Type String - - -.Example -PS C:\> Get-JcSdkUserGroup -Id:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -SuggestionCountAdd Int -SuggestionCountRemove Int -SuggestionCountTotal Int -Type String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IUserGroup -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroup.md -#> - Function Get-JcSdkUserGroup +Function Get-JcSdkUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IUserGroup])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -317,5 +214,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupAssociation.ps1 index 0c4e94629..09c565ef9 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupAssociation.ps1 @@ -1,88 +1,4 @@ -<# -.Synopsis -This endpoint returns the _direct_ associations of this User Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations?targets=system \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns the _direct_ associations of this User Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations?targets=system \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserGroupAssociation -GroupId:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphConnection -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupAssociation.md -#> - Function Get-JcSdkUserGroupAssociation +Function Get-JcSdkUserGroupAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -266,5 +182,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupMember.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupMember.ps1 index 177de5343..1d305c12d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupMember.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupMember.ps1 @@ -1,82 +1,4 @@ -<# -.Synopsis -This endpoint returns the user members of a User Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns the user members of a User Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserGroupMember -GroupId:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphConnection -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMember.md -#> - Function Get-JcSdkUserGroupMember +Function Get-JcSdkUserGroupMember { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -253,5 +175,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupMembership.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupMembership.ps1 index 57de04877..87f655e41 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupMembership.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupMembership.ps1 @@ -1,79 +1,4 @@ -<# -.Synopsis -This endpoint returns all users members that are a member of this User Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/membership \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns all users members that are a member of this User Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/membership \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserGroupMembership -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMembership.md -#> - Function Get-JcSdkUserGroupMembership +Function Get-JcSdkUserGroupMembership { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -280,5 +205,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseActiveDirectory.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseActiveDirectory.ps1 index 4771f397f..9235f0c01 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseActiveDirectory.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseActiveDirectory.ps1 @@ -1,91 +1,4 @@ -<# -.Synopsis -This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserGroupTraverseActiveDirectory -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseActiveDirectory.md -#> - Function Get-JcSdkUserGroupTraverseActiveDirectory +Function Get-JcSdkUserGroupTraverseActiveDirectory { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -283,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseApplication.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseApplication.ps1 index c5c3336ef..83f712f18 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseApplication.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseApplication.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Applications bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/applications \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Applications bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/applications \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserGroupTraverseApplication -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseApplication.md -#> - Function Get-JcSdkUserGroupTraverseApplication +Function Get-JcSdkUserGroupTraverseApplication { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseDirectory.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseDirectory.ps1 index 680ec5102..b3051ded6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseDirectory.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseDirectory.ps1 @@ -1,97 +1,4 @@ -<# -.Synopsis -This endpoint will return all Directories bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directories from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/directories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint will return all Directories bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directories from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/directories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkUserGroupTraverseDirectory -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseDirectory.md -#> - Function Get-JcSdkUserGroupTraverseDirectory +Function Get-JcSdkUserGroupTraverseDirectory { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -289,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseGSuite.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseGSuite.ps1 index c0fdcbad8..2e2349678 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseGSuite.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseGSuite.ps1 @@ -1,97 +1,4 @@ -<# -.Synopsis -This endpoint will return all G Suite Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID/gsuites \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint will return all G Suite Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID/gsuites \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkUserGroupTraverseGSuite -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseGSuite.md -#> - Function Get-JcSdkUserGroupTraverseGSuite +Function Get-JcSdkUserGroupTraverseGSuite { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -289,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseLdapServer.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseLdapServer.ps1 index 49690e109..77516c5e9 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseLdapServer.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseLdapServer.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all LDAP Servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/ldapservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all LDAP Servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/ldapservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserGroupTraverseLdapServer -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseLdapServer.md -#> - Function Get-JcSdkUserGroupTraverseLdapServer +Function Get-JcSdkUserGroupTraverseLdapServer { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseOffice365.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseOffice365.ps1 index c1cc6434f..c99783f62 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseOffice365.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseOffice365.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Office 365 instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/office365s \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Office 365 instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/office365s \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserGroupTraverseOffice365 -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseOffice365.md -#> - Function Get-JcSdkUserGroupTraverseOffice365 +Function Get-JcSdkUserGroupTraverseOffice365 { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseRadiusServer.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseRadiusServer.ps1 index 59cc875d6..7fb3d2f45 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseRadiusServer.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseRadiusServer.ps1 @@ -1,97 +1,4 @@ -<# -.Synopsis -This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Get-JcSdkUserGroupTraverseRadiusServer -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseRadiusServer.md -#> - Function Get-JcSdkUserGroupTraverseRadiusServer +Function Get-JcSdkUserGroupTraverseRadiusServer { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -289,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseSystem.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseSystem.ps1 index 32a25e5f4..dd60aef0d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseSystem.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseSystem.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserGroupTraverseSystem -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystem.md -#> - Function Get-JcSdkUserGroupTraverseSystem +Function Get-JcSdkUserGroupTraverseSystem { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseSystemGroup.ps1 index ba31c4794..27dad23cc 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseSystemGroup.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserGroupTraverseSystemGroup -GroupId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystemGroup.md -#> - Function Get-JcSdkUserGroupTraverseSystemGroup +Function Get-JcSdkUserGroupTraverseSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserMember.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserMember.ps1 index d2d5f6e56..ddbb88f68 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserMember.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserMember.ps1 @@ -1,79 +1,4 @@ -<# -.Synopsis -This endpoint returns all the User Groups a User is a member of. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/memberof \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint returns all the User Groups a User is a member of. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/memberof \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserMember -UserId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserMember.md -#> - Function Get-JcSdkUserMember +Function Get-JcSdkUserMember { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -280,5 +205,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserPushEndpoint.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserPushEndpoint.ps1 index fafbbcc70..97bf2df08 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserPushEndpoint.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserPushEndpoint.ps1 @@ -1,85 +1,4 @@ -<# -.Synopsis -This endpoint will retrieve a push endpoint associated with a user. -.Description -This endpoint will retrieve a push endpoint associated with a user. -.Example -PS C:\> Get-JcSdkUserPushEndpoint -UserId:() - - - ----- ---------- -DeviceAppVersion String -DeviceMake String -DeviceModel String -DeviceOS String -DeviceOSVersion String -DeviceUvEnabled Boolean -EnrollmentDate Datetime -Id String -LastUsedDate Datetime -Name String -State String - - -.Example -PS C:\> Get-JcSdkUserPushEndpoint -UserId:() -PushEndpointId:() - - - ----- ---------- -DeviceAppVersion String -DeviceMake String -DeviceModel String -DeviceOS String -DeviceOSVersion String -DeviceUvEnabled Boolean -EnrollmentDate Datetime -Id String -LastUsedDate Datetime -Name String -State String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IPushEndpointResponse -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserPushEndpoint.md -#> - Function Get-JcSdkUserPushEndpoint +Function Get-JcSdkUserPushEndpoint { [OutputType([JumpCloud.SDK.V2.Models.IPushEndpointResponse])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -208,5 +127,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseActiveDirectory.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseActiveDirectory.ps1 index 34a944110..4e51c23e0 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseActiveDirectory.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseActiveDirectory.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Active Directory Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Active Directory instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory instance from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/activedirectories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Active Directory Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Active Directory instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory instance from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/activedirectories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserTraverseActiveDirectory -UserId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseActiveDirectory.md -#> - Function Get-JcSdkUserTraverseActiveDirectory +Function Get-JcSdkUserTraverseActiveDirectory { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseApplication.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseApplication.ps1 index 3d00bfb17..95783c961 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseApplication.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseApplication.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserTraverseApplication -UserId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseApplication.md -#> - Function Get-JcSdkUserTraverseApplication +Function Get-JcSdkUserTraverseApplication { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseDirectory.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseDirectory.ps1 index 7139fd7e8..d87d3a4d9 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseDirectory.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseDirectory.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserTraverseDirectory -UserId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseDirectory.md -#> - Function Get-JcSdkUserTraverseDirectory +Function Get-JcSdkUserTraverseDirectory { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseGSuite.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseGSuite.ps1 index 928795c46..c0c0eaa1b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseGSuite.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseGSuite.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserTraverseGSuite -UserId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseGSuite.md -#> - Function Get-JcSdkUserTraverseGSuite +Function Get-JcSdkUserTraverseGSuite { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseLdapServer.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseLdapServer.ps1 index 6a7ebbc21..9e514f95b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseLdapServer.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseLdapServer.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserTraverseLdapServer -UserId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseLdapServer.md -#> - Function Get-JcSdkUserTraverseLdapServer +Function Get-JcSdkUserTraverseLdapServer { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseOffice365.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseOffice365.ps1 index 802241a03..e83c1d410 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseOffice365.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseOffice365.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserTraverseOffice365 -UserId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseOffice365.md -#> - Function Get-JcSdkUserTraverseOffice365 +Function Get-JcSdkUserTraverseOffice365 { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseRadiusServer.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseRadiusServer.ps1 index 73c976d64..cf38d90d3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseRadiusServer.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseRadiusServer.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserTraverseRadiusServer -UserId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseRadiusServer.md -#> - Function Get-JcSdkUserTraverseRadiusServer +Function Get-JcSdkUserTraverseRadiusServer { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseSystem.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseSystem.ps1 index 46eb43c30..b8127d895 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseSystem.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseSystem.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserTraverseSystem -UserId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystem.md -#> - Function Get-JcSdkUserTraverseSystem +Function Get-JcSdkUserTraverseSystem { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseSystemGroup.ps1 index 1c62522cc..2665b9225 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseSystemGroup.ps1 @@ -1,95 +1,4 @@ -<# -.Synopsis -This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Get-JcSdkUserTraverseSystemGroup -UserId:() - - - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGraphObjectWithPaths -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystemGroup.md -#> - Function Get-JcSdkUserTraverseSystemGroup +Function Get-JcSdkUserTraverseSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -287,5 +196,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkWorkday.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkWorkday.ps1 index c6734c8d1..e64dea5d7 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkWorkday.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkWorkday.ps1 @@ -1,101 +1,4 @@ -<# -.Synopsis -This endpoint will return all the available information about an instance of Workday. - -#### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/workdays/ \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Description -This endpoint will return all the available information about an instance of Workday. - -#### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/workdays/ \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Example -PS C:\> Get-JcSdkWorkday -Fields:() -Filter:() -Sort:() - - - ----- ---------- -BasicExpiry String -BasicIsValid Boolean -BasicMessage String -Id String -LastImport String -Name String -OauthExpiry String -OauthIsValid Boolean -OauthMessage String -ReportUrl String - - -.Example -PS C:\> Get-JcSdkWorkday -Id:() - - - ----- ---------- -BasicExpiry String -BasicIsValid Boolean -BasicMessage String -Id String -LastImport String -Name String -OauthExpiry String -OauthIsValid Boolean -OauthMessage String -ReportUrl String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IWorkdayOutput -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkday.md -#> - Function Get-JcSdkWorkday +Function Get-JcSdkWorkday { [OutputType([JumpCloud.SDK.V2.Models.IWorkdayOutput])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -311,5 +214,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkWorkdayWorker.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkWorkdayWorker.ps1 index 3ac3e9fdb..a48fe8d55 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkWorkdayWorker.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkWorkdayWorker.ps1 @@ -1,86 +1,4 @@ -<# -.Synopsis -This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. - -##### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - - -``` -.Description -This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. - -##### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - - -``` -.Example -PS C:\> Get-JcSdkWorkdayWorker -WorkdayId:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.WorkdayWorkerAttributes -Email String -FirstName String -LastName String -Username String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IWorkdayWorker -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkdayWorker.md -#> - Function Get-JcSdkWorkdayWorker +Function Get-JcSdkWorkdayWorker { [OutputType([JumpCloud.SDK.V2.Models.IWorkdayWorker])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -266,5 +184,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Grant-JcSdkWorkday.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Grant-JcSdkWorkday.ps1 index d3677e0e3..62ad8313f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Grant-JcSdkWorkday.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Grant-JcSdkWorkday.ps1 @@ -1,110 +1,4 @@ -<# -.Synopsis -This endpoint adds an authorization method to a workday instance. - -You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. -Failure to provide these credentials will result in the request being rejected. - -Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ -\t\"auth\":{ -\t \"basic\": { -\t\t\"username\": \"someDeveloper\",\t -\t\t\"password\": \"notTheRealPassword\" - -\t } -\t} -}' - -``` -.Description -This endpoint adds an authorization method to a workday instance. - -You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. -Failure to provide these credentials will result in the request being rejected. - -Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ -\t\"auth\":{ -\t \"basic\": { -\t\t\"username\": \"someDeveloper\",\t -\t\t\"password\": \"notTheRealPassword\" - -\t } -\t} -}' - -``` -.Example -PS C:\> Grant-JcSdkWorkday -WorkdayId:() -BasicPassword:() -BasicUsername:() -OauthCode:() - - -.Example -PS C:\> Grant-JcSdkWorkday -WorkdayId:() -Body:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IAuthInputObject -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [BasicPassword ]: - [BasicUsername ]: - [OauthCode ]: - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Grant-JcSdkWorkday.md -#> - Function Grant-JcSdkWorkday +Function Grant-JcSdkWorkday { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='AuthorizeExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -256,5 +150,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkScim.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkScim.ps1 index c8493ac4d..4a063de29 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkScim.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkScim.ps1 @@ -1,61 +1,4 @@ -<# -.Synopsis -Get a list of users to import from an Application IdM service provider. -.Description -Get a list of users to import from an Application IdM service provider. -.Example -PS C:\> Import-JcSdkScim -ApplicationId:() - - - ----- ---------- -TotalCount System.Nullable[float] TotalCount {get;set;} -Users JumpCloud.SDK.V2.Models.ImportUser[] - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IImportUsersResponse -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkScim.md -#> - Function Import-JcSdkScim +Function Import-JcSdkScim { [OutputType([JumpCloud.SDK.V2.Models.IImportUsersResponse])] [CmdletBinding(DefaultParameterSetName='Import', PositionalBinding=$false)] @@ -221,5 +164,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkWorkday.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkWorkday.ps1 index adcb9b770..8ad705817 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkWorkday.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkWorkday.ps1 @@ -1,167 +1,4 @@ -<# -.Synopsis -The endpoint allows you to import a Workday Import request. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '[ -\t{ -\t\t\"email\":\"{email}\", -\t\t\"firstname\":\"{firstname}\", -\t\t\"lastname\":\"{firstname}\", -\t\t\"username\":\"{username}\", -\t\t\"attributes\":[ -\t\t\t{\"name\":\"EmployeeID\",\"value\":\"0000\"}, -\t\t\t{\"name\":\"WorkdayID\",\"value\":\"name.name\"} -\t\t\t] -\t\t -\t} -] -``` -.Description -The endpoint allows you to import a Workday Import request. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '[ -\t{ -\t\t\"email\":\"{email}\", -\t\t\"firstname\":\"{firstname}\", -\t\t\"lastname\":\"{firstname}\", -\t\t\"username\":\"{username}\", -\t\t\"attributes\":[ -\t\t\t{\"name\":\"EmployeeID\",\"value\":\"0000\"}, -\t\t\t{\"name\":\"WorkdayID\",\"value\":\"name.name\"} -\t\t\t] -\t\t -\t} -] -``` -.Example -PS C:\> Import-JcSdkWorkday -WorkdayId:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -System.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserCreate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] -.Outputs -JumpCloud.SDK.V2.Models.IJobIdResult -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY >: - [AccountLocked ]: - [Activated ]: - [Addresses >]: - [Country ]: - [ExtendedAddress ]: - [Locality ]: - [PoBox ]: - [PostalCode ]: - [Region ]: - [StreetAddress ]: - [Type ]: - [AllowPublicKey ]: - [AlternateEmail ]: - [Attributes >]: - [Name ]: - [Value ]: - [Company ]: - [CostCenter ]: - [DelegatedAuthorityId ]: ObjectId of the target Active Directory connection - [DelegatedAuthorityName ]: Authority name - [Department ]: - [Description ]: - [DisableDeviceMaxLoginAttempts ]: - [Displayname ]: - [Email ]: - [EmployeeIdentifier ]: Must be unique per user. - [EmployeeType ]: - [EnableManagedUid ]: - [EnableUserPortalMultifactor ]: - [ExternalDn ]: - [ExternalPasswordExpirationDate ]: - [ExternalSourceType ]: - [ExternallyManaged ]: - [Firstname ]: - [JobTitle ]: - [Lastname ]: - [LdapBindingUser ]: - [Location ]: - [ManagedAppleId ]: - [Manager ]: Relation with another systemuser to identify the last as a manager. - [MfaConfigured ]: - [MfaExclusion ]: - [MfaExclusionDays ]: - [MfaExclusionUntil ]: - [Middlename ]: - [Password ]: - [PasswordNeverExpires ]: - [PasswordlessSudo ]: - [PhoneNumbers >]: - [Number ]: - [Type ]: - [PublicKey ]: - [RecoveryEmailAddress ]: - [Relationships >]: - [Type ]: - [Value ]: - [RestrictedField ]: - [RestrictedFieldId ]: - [RestrictedFieldType ]: - [SambaServiceUser ]: - [State ]: - [Sudo ]: - [Suspended ]: - [UnixGuid ]: - [UnixUid ]: - [Username ]: - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkday.md -#> - Function Import-JcSdkWorkday +Function Import-JcSdkWorkday { [OutputType([JumpCloud.SDK.V2.Models.IJobIdResult])] [CmdletBinding(DefaultParameterSetName='Import', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -285,5 +122,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkWorkdayResult.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkWorkdayResult.ps1 index cbcdaa5fd..142d8d8ec 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkWorkdayResult.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkWorkdayResult.ps1 @@ -1,82 +1,4 @@ -<# -.Synopsis -This endpoint provides a list of job results from the workday import and will contain all imported data from Workday. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import/{ImportJobID}/results \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint provides a list of job results from the workday import and will contain all imported data from Workday. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import/{ImportJobID}/results \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Import-JcSdkWorkdayResult -Id:() -JobId:() - - - ----- ---------- -CreatedAt String -Id String -Meta JumpCloud.SDK.V2.Models.JobWorkresultMeta -PersistedFields JumpCloud.SDK.V2.Models.JobWorkresultPersistedFields -Status String -StatusMsg String -UpdatedAt String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IJobWorkresult -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkdayResult.md -#> - Function Import-JcSdkWorkdayResult +Function Import-JcSdkWorkdayResult { [OutputType([JumpCloud.SDK.V2.Models.IJobWorkresult])] [CmdletBinding(DefaultParameterSetName='Import', PositionalBinding=$false)] @@ -198,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Invoke-JcSdkReclaimSoftwareAppLicense.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Invoke-JcSdkReclaimSoftwareAppLicense.ps1 index a18779165..6757f2e5e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Invoke-JcSdkReclaimSoftwareAppLicense.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Invoke-JcSdkReclaimSoftwareAppLicense.ps1 @@ -1,79 +1,4 @@ -<# -.Synopsis -This endpoint allows you to reclaim the licenses from a software app associated with devices that are deleted. -#### Sample Request -``` -$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/reclaim-licenses \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '{}' -``` -.Description -This endpoint allows you to reclaim the licenses from a software app associated with devices that are deleted. -#### Sample Request -``` -$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/reclaim-licenses \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '{}' -``` -.Example -PS C:\> Invoke-JcSdkReclaimSoftwareAppLicense -SoftwareAppId:() - - - ----- ---------- -AssignedLicenses Int -AvailableLicenses Int -ReclaimedLicenses Int -TotalLicenses Int - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.ISoftwareAppReclaimLicenses -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Invoke-JcSdkReclaimSoftwareAppLicense.md -#> - Function Invoke-JcSdkReclaimSoftwareAppLicense +Function Invoke-JcSdkReclaimSoftwareAppLicense { [OutputType([JumpCloud.SDK.V2.Models.ISoftwareAppReclaimLicenses])] [CmdletBinding(DefaultParameterSetName='Reclaim', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -189,5 +114,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Lock-JcSdkAppleMdmDevice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Lock-JcSdkAppleMdmDevice.ps1 index ee974cf26..93ad445c7 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Lock-JcSdkAppleMdmDevice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Lock-JcSdkAppleMdmDevice.ps1 @@ -1,78 +1,4 @@ -<# -.Synopsis -Locks a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/lock \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` -.Description -Locks a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/lock \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` -.Example -PS C:\> Lock-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Pin:() - - -.Example -PS C:\> Lock-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Body:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.IPathsLf7IzoApplemdmsAppleMdmIdDevicesDeviceIdLockPostRequestbodyContentApplicationJsonSchema -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [Pin ]: 6-digit PIN, required for MacOS, to lock the device - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Lock-JcSdkAppleMdmDevice.md -#> - Function Lock-JcSdkAppleMdmDevice +Function Lock-JcSdkAppleMdmDevice { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='LockExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -217,5 +143,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkActiveDirectory.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkActiveDirectory.ps1 index bec6e445f..5a2fac231 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkActiveDirectory.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkActiveDirectory.ps1 @@ -1,76 +1,4 @@ -<# -.Synopsis -This endpoint allows you to create a new Active Directory. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/ \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"domain\": \"{DC=AD_domain_name;DC=com}\" - }' -``` -.Description -This endpoint allows you to create a new Active Directory. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/ \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"domain\": \"{DC=AD_domain_name;DC=com}\" - }' -``` -.Example -PS C:\> New-JcSdkActiveDirectory -Domain:() -UseCase:() - - - ----- ---------- -Domain String -Id String -PrimaryAgent String -UseCase String - - -.Example -PS C:\> New-JcSdkActiveDirectory -Body:() - - - ----- ---------- -Domain String -Id String -PrimaryAgent String -UseCase String - - - -.Inputs -JumpCloud.SDK.V2.Models.IActiveDirectory -.Outputs -JumpCloud.SDK.V2.Models.IActiveDirectory -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [DelegationState ]: Delegation state of the Active Directory instance - [Domain ]: Domain name for this Active Directory instance. - [GroupsEnabled ]: - [UpdatedAt ]: - [UseCase ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectory.md -#> - Function New-JcSdkActiveDirectory +Function New-JcSdkActiveDirectory { [OutputType([JumpCloud.SDK.V2.Models.IActiveDirectory])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -210,5 +138,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkActiveDirectoryAgent.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkActiveDirectoryAgent.ps1 index 8ce74c28b..69ed2b955 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkActiveDirectoryAgent.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkActiveDirectoryAgent.ps1 @@ -1,102 +1,4 @@ -<# -.Synopsis -This endpoint allows you to create a new Active Directory Agent. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ \"agent_type\":\"{SYNC}\" }' -``` -.Description -This endpoint allows you to create a new Active Directory Agent. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ \"agent_type\":\"{SYNC}\" }' -``` -.Example -PS C:\> New-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -AgentType:() - - - ----- ---------- -ConnectKey String -ContactAt String -Hostname String -Id String -SourceIP String -State String -Version String - - -.Example -PS C:\> New-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -Body:() - - - ----- ---------- -ConnectKey String -ContactAt String -Hostname String -Id String -SourceIP String -State String -Version String - - - -.Inputs -JumpCloud.SDK.V2.Models.IActiveDirectoryAgent -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IActiveDirectoryAgentGet -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [AgentType ]: - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectoryAgent.md -#> - Function New-JcSdkActiveDirectoryAgent +Function New-JcSdkActiveDirectoryAgent { [OutputType([JumpCloud.SDK.V2.Models.IActiveDirectoryAgentGet])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -228,5 +130,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkAdministratorOrganization.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkAdministratorOrganization.ps1 index a18826a57..dd75673bc 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkAdministratorOrganization.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkAdministratorOrganization.ps1 @@ -1,72 +1,4 @@ -<# -.Synopsis -This endpoint allows you to grant Administrator access to an Organization. -.Description -This endpoint allows you to grant Administrator access to an Organization. -.Example -PS C:\> New-JcSdkAdministratorOrganization -Id:() -Organization:() - - - ----- ---------- -Administrator String -Organization String - - -.Example -PS C:\> New-JcSdkAdministratorOrganization -Id:() -Body:() - - - ----- ---------- -Administrator String -Organization String - - - -.Inputs -JumpCloud.SDK.V2.Models.IAdministratorOrganizationLinkReq -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [Organization ]: The identifier for an organization to link this administrator to. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAdministratorOrganization.md -#> - Function New-JcSdkAdministratorOrganization +Function New-JcSdkAdministratorOrganization { [OutputType([JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -198,5 +130,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkApprovalFlow.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkApprovalFlow.ps1 index ba4747448..aa2854965 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkApprovalFlow.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkApprovalFlow.ps1 @@ -1,61 +1,4 @@ -<# -.Synopsis -Endpoint for adding a new access workflow -.Description -Endpoint for adding a new access workflow -.Example -New-JcSdkApprovalFlow -ApprovalType 'manual' -Category "Application" -Description "A new workflow" -MultiSelectDuration @("P5D") -Name "New Workflow" -ResourceId 5d67fd481da3c52aa1faa883 -ResourceType "user_group" -Status "active" -TimeBasedAccess -TtlConfig "TTL_CONFIG_MULTI_SELECT_DURATIONS" -VisibleTo @('6148cd739d38866f0814e874') - -.Inputs -JumpCloud.SDK.V2.Models.IJumpcloudIngressoCreateAccessWorkflowRequest -.Outputs -JumpCloud.SDK.V2.Models.IJumpcloudIngressoCreateAccessWorkflowResponse -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -APPROVERRESOURCES : - [RequireAll ]: - [ResourceId ]: - [ResourceName ]: - [ResourceOrder ]: - [ResourceType ]: - -BODY : - [ApprovalType ]: - [ApproverRequirement ]: - [ApproverResources >]: - [RequireAll ]: - [ResourceId ]: - [ResourceName ]: - [ResourceOrder ]: - [ResourceType ]: - [Category ]: - [Description ]: - [FixedDuration ]: - [IconColor ]: - [IconUrl ]: - [MultiSelectDuration >]: - [Name ]: - [NonAdminApproval ]: - [OrganizationObjectId ]: - [ResourceId ]: - [ResourceType ]: - [SlackConfig >]: - [SlackResourceId ]: - [SlackEnabled ]: - [Status ]: - [TimeBasedAccess ]: - [TtlConfig ]: - [VisibleTo >]: - -SLACKCONFIG : - [SlackResourceId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkApprovalFlow.md -#> - Function New-JcSdkApprovalFlow +Function New-JcSdkApprovalFlow { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoCreateAccessWorkflowResponse])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -289,5 +232,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkAuthenticationPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkAuthenticationPolicy.ps1 index 7fb4fc3e3..ad736b106 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkAuthenticationPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkAuthenticationPolicy.ps1 @@ -1,168 +1,4 @@ -<# -.Synopsis -Create an authentication policy. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/authn/policies \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Sample Policy\", - \"disabled\": false, - \"effect\": { - \"action\": \"allow\" - }, - \"targets\": { - \"users\": { - \"inclusions\": [\"ALL\"] - }, - \"userGroups\": { - \"exclusions\": [{USER_GROUP_ID}] - }, - \"resources\": [ {\"type\": \"user_portal\" } ] - }, - \"conditions\":{ - \"ipAddressIn\": [{IP_LIST_ID}] - } - }' -``` -.Description -Create an authentication policy. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/authn/policies \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Sample Policy\", - \"disabled\": false, - \"effect\": { - \"action\": \"allow\" - }, - \"targets\": { - \"users\": { - \"inclusions\": [\"ALL\"] - }, - \"userGroups\": { - \"exclusions\": [{USER_GROUP_ID}] - }, - \"resources\": [ {\"type\": \"user_portal\" } ] - }, - \"conditions\":{ - \"ipAddressIn\": [{IP_LIST_ID}] - } - }' -``` -.Example -PS C:\> New-JcSdkAuthenticationPolicy -Conditions:() -Description:() -Disabled:() -EffectAction:() -MfaRequired:() -Name:() -TargetResources:() -Type:() -UserAttributeExclusions:() -UserAttributeInclusions:() -UserGroupExclusions:() -UserGroupInclusions:() -UserInclusions:() -UserVerificationRequirement:() - - - ----- ---------- -Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions -Description String -Disabled Boolean -EffectAction String -Id String -MfaRequired Boolean -Name String -TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] -Type String -UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserGroupExclusions String -UserGroupInclusions String -UserInclusions String -UserVerificationRequirement String - - -.Example -PS C:\> New-JcSdkAuthenticationPolicy -Body:() - - - ----- ---------- -Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions -Description String -Disabled Boolean -EffectAction String -Id String -MfaRequired Boolean -Name String -TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] -Type String -UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserGroupExclusions String -UserGroupInclusions String -UserInclusions String -UserVerificationRequirement String - - - -.Inputs -JumpCloud.SDK.V2.Models.IAuthnPolicy -.Outputs -JumpCloud.SDK.V2.Models.IAuthnPolicy -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [Conditions ]: Dictionary of - [(Any) ]: This indicates any property can be added to this object. - [CustomErrorMessage ]: The custom error message to be displayed when the policy is applied. - [CustomErrorMessageEnabled ]: Indicates whether the custom error message is enabled or not. - [Description ]: - [Disabled ]: - [EffectAction ]: - [MfaRequired ]: - [Name ]: - [ObligationMfaFactors >]: - [Type ]: - [PrimaryHelpText ]: The text to be displayed for the help link. - [PrimaryHelpUrl ]: The URL to be opened when the help link is clicked. - [SecondaryHelpText ]: The text to be displayed for the help link. - [SecondaryHelpUrl ]: The URL to be opened when the help link is clicked. - [TargetResources >]: - Type : - [Id ]: Object ID of the resource target. If undefined, then all resources of the given type are targeted. - [Type ]: AuthnPolicyType - [UserAttributeExclusions >]: - [Field ]: The only field that is currently supported is ldap_binding_user - [Operator ]: - [Value ]: Can be any value - string, number, boolean, array or object. - [UserAttributeInclusions >]: - [UserGroupExclusions >]: - [UserGroupInclusions >]: - [UserInclusions >]: - [UserVerificationRequirement ]: - -OBLIGATIONMFAFACTORS : - [Type ]: - -TARGETRESOURCES : - Type : - [Id ]: Object ID of the resource target. If undefined, then all resources of the given type are targeted. - -USERATTRIBUTEEXCLUSIONS : - [Field ]: The only field that is currently supported is ldap_binding_user - [Operator ]: - [Value ]: Can be any value - string, number, boolean, array or object. - -USERATTRIBUTEINCLUSIONS : - [Field ]: The only field that is currently supported is ldap_binding_user - [Operator ]: - [Value ]: Can be any value - string, number, boolean, array or object. -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAuthenticationPolicy.md -#> - Function New-JcSdkAuthenticationPolicy +Function New-JcSdkAuthenticationPolicy { [OutputType([JumpCloud.SDK.V2.Models.IAuthnPolicy])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -407,5 +243,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkBulkUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkBulkUser.ps1 index ddd6e28e2..ab9a7c713 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkBulkUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkBulkUser.ps1 @@ -1,193 +1,4 @@ -<# -.Synopsis -The endpoint allows you to create a bulk job to asynchronously create users. -See [create a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_post) -for the full list of attributes. - -#### Default User State -The `state` of each user in the request can be explicitly passed in or -omitted. -If `state` is omitted, then the user will get created -using the value returned from the -[Get an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organizations_get) -endpoint. -The default user state for bulk created users depends on the -`creation-source` header. -For `creation-source:jumpcloud:bulk` the -default state is stored in `settings.newSystemUserStateDefaults.csvImport`. -For other `creation-source` header values, the default state is stored in -`settings.newSystemUserStateDefaults.applicationImport` - -These default state values can be changed in the admin portal settings -or by using the -[create an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organization_put) -endpoint. - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '[ - { - \"email\":\"{email}\", - \"firstname\":\"{firstname}\", - \"lastname\":\"{firstname}\", - \"username\":\"{username}\", - \"attributes\":[ - { - \"name\":\"EmployeeID\", - \"value\":\"0000\" - }, - { - \"name\":\"Custom\", - \"value\":\"attribute\" - } - ] - } -]' -``` -.Description -The endpoint allows you to create a bulk job to asynchronously create users. -See [create a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_post) -for the full list of attributes. - -#### Default User State -The `state` of each user in the request can be explicitly passed in or -omitted. -If `state` is omitted, then the user will get created -using the value returned from the -[Get an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organizations_get) -endpoint. -The default user state for bulk created users depends on the -`creation-source` header. -For `creation-source:jumpcloud:bulk` the -default state is stored in `settings.newSystemUserStateDefaults.csvImport`. -For other `creation-source` header values, the default state is stored in -`settings.newSystemUserStateDefaults.applicationImport` - -These default state values can be changed in the admin portal settings -or by using the -[create an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organization_put) -endpoint. - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '[ - { - \"email\":\"{email}\", - \"firstname\":\"{firstname}\", - \"lastname\":\"{firstname}\", - \"username\":\"{username}\", - \"attributes\":[ - { - \"name\":\"EmployeeID\", - \"value\":\"0000\" - }, - { - \"name\":\"Custom\", - \"value\":\"attribute\" - } - ] - } -]' -``` -.Example -PS C:\> New-JcSdkBulkUser - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -System.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserCreate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] -.Outputs -JumpCloud.SDK.V2.Models.IJobIdResult -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY >: - [AccountLocked ]: - [Activated ]: - [Addresses >]: - [Country ]: - [ExtendedAddress ]: - [Locality ]: - [PoBox ]: - [PostalCode ]: - [Region ]: - [StreetAddress ]: - [Type ]: - [AllowPublicKey ]: - [AlternateEmail ]: - [Attributes >]: - [Name ]: - [Value ]: - [Company ]: - [CostCenter ]: - [DelegatedAuthorityId ]: ObjectId of the target Active Directory connection - [DelegatedAuthorityName ]: Authority name - [Department ]: - [Description ]: - [DisableDeviceMaxLoginAttempts ]: - [Displayname ]: - [Email ]: - [EmployeeIdentifier ]: Must be unique per user. - [EmployeeType ]: - [EnableManagedUid ]: - [EnableUserPortalMultifactor ]: - [ExternalDn ]: - [ExternalPasswordExpirationDate ]: - [ExternalSourceType ]: - [ExternallyManaged ]: - [Firstname ]: - [JobTitle ]: - [Lastname ]: - [LdapBindingUser ]: - [Location ]: - [ManagedAppleId ]: - [Manager ]: Relation with another systemuser to identify the last as a manager. - [MfaConfigured ]: - [MfaExclusion ]: - [MfaExclusionDays ]: - [MfaExclusionUntil ]: - [Middlename ]: - [Password ]: - [PasswordNeverExpires ]: - [PasswordlessSudo ]: - [PhoneNumbers >]: - [Number ]: - [Type ]: - [PublicKey ]: - [RecoveryEmailAddress ]: - [Relationships >]: - [Type ]: - [Value ]: - [RestrictedField ]: - [RestrictedFieldId ]: - [RestrictedFieldType ]: - [SambaServiceUser ]: - [State ]: - [Sudo ]: - [Suspended ]: - [UnixGuid ]: - [UnixUid ]: - [Username ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUser.md -#> - Function New-JcSdkBulkUser +Function New-JcSdkBulkUser { [OutputType([JumpCloud.SDK.V2.Models.IJobIdResult])] [CmdletBinding(DefaultParameterSetName='Create', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -317,5 +128,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkBulkUserState.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkBulkUserState.ps1 index 618446209..a269a0d5f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkBulkUserState.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkBulkUserState.ps1 @@ -1,76 +1,4 @@ -<# -.Synopsis -This endpoint allows you to create scheduled statechange jobs. -#### Sample Request -``` -curl -X POST \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ - -H 'x-api-key: {API_KEY}' \\ - -H 'Content-Type: application/json' \\ - -H 'Accept: application/json' \\ - -d '{ - \"user_ids\": [\"{User_ID_1}\", \"{User_ID_2}\", \"{User_ID_3}\"], - \"state\": \"SUSPENDED\", - \"start_date\": \"2000-01-01T00:00:00.000Z\" - }' -``` -.Description -This endpoint allows you to create scheduled statechange jobs. -#### Sample Request -``` -curl -X POST \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ - -H 'x-api-key: {API_KEY}' \\ - -H 'Content-Type: application/json' \\ - -H 'Accept: application/json' \\ - -d '{ - \"user_ids\": [\"{User_ID_1}\", \"{User_ID_2}\", \"{User_ID_3}\"], - \"state\": \"SUSPENDED\", - \"start_date\": \"2000-01-01T00:00:00.000Z\" - }' -``` -.Example -PS C:\> New-JcSdkBulkUserState -StartDate:() -State:() -UserIds:() -ActivationEmailOverride:() -SendActivationEmails:() - - - ----- ---------- -ScheduledDate String -ScheduledJobId String -State String -SystemUserId String - - -.Example -PS C:\> New-JcSdkBulkUserState -Body:() - - - ----- ---------- -ScheduledDate String -ScheduledJobId String -State String -SystemUserId String - - - -.Inputs -JumpCloud.SDK.V2.Models.IBulkScheduledStatechangeCreate -.Outputs -JumpCloud.SDK.V2.Models.IScheduledUserstateResult -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - StartDate : Date and time that scheduled action should occur - State : The state to move the user(s) to - UserIds >: Array of system user ids to schedule for a state change - [ActivationEmailOverride ]: Send the activation or welcome email to the specified email address upon activation. Can only be used with a single user_id and scheduled activation. This field will be ignored if `send_activation_emails` is explicitly set to false. - [SendActivationEmails ]: Set to true to send activation or welcome email(s) to each user_id upon activation. Set to false to suppress emails. Can only be used with scheduled activation(s). -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUserState.md -#> - Function New-JcSdkBulkUserState +Function New-JcSdkBulkUserState { [OutputType([JumpCloud.SDK.V2.Models.IScheduledUserstateResult])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -215,5 +143,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkCustomEmailConfiguration.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkCustomEmailConfiguration.ps1 index 73683f48b..ac887644d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkCustomEmailConfiguration.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkCustomEmailConfiguration.ps1 @@ -1,66 +1,4 @@ -<# -.Synopsis -Create the custom email configuration for the specified custom email type. - -This action is only available to paying customers. -.Description -Create the custom email configuration for the specified custom email type. - -This action is only available to paying customers. -.Example -PS C:\> New-JcSdkCustomEmailConfiguration -Subject:() -Type:() -Body:() -Button:() -Header:() -NextStepContactInfo:() -Title:() - - - ----- ---------- -Body String -Button String -Header String -Id String -NextStepContactInfo String -Subject String -Title String -Type String - - -.Example -PS C:\> New-JcSdkCustomEmailConfiguration -CustomEmail:() - - - ----- ---------- -Body String -Button String -Header String -Id String -NextStepContactInfo String -Subject String -Title String -Type String - - - -.Inputs -JumpCloud.SDK.V2.Models.ICustomEmail -.Outputs -JumpCloud.SDK.V2.Models.ICustomEmail -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -CUSTOMEMAIL : - Subject : - Type : - [Body ]: - [Button ]: - [Header ]: - [NextStepContactInfo ]: - [Title ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkCustomEmailConfiguration.md -#> - Function New-JcSdkCustomEmailConfiguration +Function New-JcSdkCustomEmailConfiguration { [OutputType([JumpCloud.SDK.V2.Models.ICustomEmail])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -212,5 +150,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkDuoAccount.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkDuoAccount.ps1 index 98a43eed9..74a86e581 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkDuoAccount.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkDuoAccount.ps1 @@ -1,51 +1,4 @@ -<# -.Synopsis -Registers a Duo account for an organization. -Only one Duo account will be allowed, -in case an organization has a Duo account already a 409 (Conflict) code will be returned. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` -.Description -Registers a Duo account for an organization. -Only one Duo account will be allowed, -in case an organization has a Duo account already a 409 (Conflict) code will be returned. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` -.Example -PS C:\> New-JcSdkDuoAccount - - - ----- ---------- -Id String -Name String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Outputs -JumpCloud.SDK.V2.Models.IDuoAccount -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoAccount.md -#> - Function New-JcSdkDuoAccount +Function New-JcSdkDuoAccount { [OutputType([JumpCloud.SDK.V2.Models.IDuoAccount])] [CmdletBinding(DefaultParameterSetName='Create', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -149,5 +102,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkDuoApplication.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkDuoApplication.ps1 index 25757ddec..6d2aeef0b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkDuoApplication.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkDuoApplication.ps1 @@ -1,107 +1,4 @@ -<# -.Synopsis -Create a Duo application for your organization and the specified account. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Application Name\", - \"apiHost\": \"api-1234.duosecurity.com\", - \"integrationKey\": \"1234\", - \"secretKey\": \"5678\" - }' -``` -.Description -Create a Duo application for your organization and the specified account. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Application Name\", - \"apiHost\": \"api-1234.duosecurity.com\", - \"integrationKey\": \"1234\", - \"secretKey\": \"5678\" - }' -``` -.Example -PS C:\> New-JcSdkDuoApplication -AccountId:() -ApiHost:() -IntegrationKey:() -Name:() -SecretKey:() - - - ----- ---------- -ApiHost String -Id String -IntegrationKey String -Name String - - -.Example -PS C:\> New-JcSdkDuoApplication -AccountId:() -Body:() - - - ----- ---------- -ApiHost String -Id String -IntegrationKey String -Name String - - - -.Inputs -JumpCloud.SDK.V2.Models.IDuoApplicationReq -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IDuoApplication -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - ApiHost : - IntegrationKey : - Name : - SecretKey : - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoApplication.md -#> - Function New-JcSdkDuoApplication +Function New-JcSdkDuoApplication { [OutputType([JumpCloud.SDK.V2.Models.IDuoApplication])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -254,5 +151,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkGSuiteTranslationRule.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkGSuiteTranslationRule.ps1 index 53d5fbf70..95f0c7ed5 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkGSuiteTranslationRule.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkGSuiteTranslationRule.ps1 @@ -1,99 +1,4 @@ -<# -.Synopsis -This endpoint allows you to create a translation rule for a specific G Suite instance. -These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Translation Rule Parameters} - }' -``` -.Description -This endpoint allows you to create a translation rule for a specific G Suite instance. -These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Translation Rule Parameters} - }' -``` -.Example -PS C:\> New-JcSdkGSuiteTranslationRule -GsuiteId:() -BuiltIn:() -Direction:() - - - ----- ---------- -BuiltIn String -Direction String -Id String - - -.Example -PS C:\> New-JcSdkGSuiteTranslationRule -GsuiteId:() -Body:() - - - ----- ---------- -BuiltIn String -Direction String -Id String - - - -.Inputs -JumpCloud.SDK.V2.Models.IGSuiteTranslationRuleRequest -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGSuiteTranslationRule -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [BuiltIn ]: Built-in translations for G Suite export: * `user_home_addresses` - Translate all JumpCloud user addresses of type `home` to G Suite Directory user addresses of type `home` * `user_work_addresses` - Translate all JumpCloud user addresses of type `work` to G Suite Directory user addresses of type `work` * `user_other_addresses` - Translate all JumpCloud user addresses of type `other` to G Suite Directory user addresses of type `other` * `user_home_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `home` to G Suite Directory user phones of type `home` * `user_mobile_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `mobile` to G Suite Directory user phones of type `mobile` * `user_other_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `other` to G Suite Directory user phones of type `other` * `user_work_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work` to G Suite Directory user phones of type `work` * `user_work_fax_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work_fax` to G Suite Directory user phones of type `work_fax` * `user_work_mobile_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work_mobile` to G Suite Directory user phones of type `work_mobile` * `user_manager` - Translate JumpCloud user `manager` to G Suite Directory user `relations-manager` * `user_primary_organization_cost_center` - Translate JumpCloud user `costCenter` to G Suite Directory user `costCenter` for `primary` organization * `user_primary_organization_department` - Translate JumpCloud user `department` to G Suite Directory user `department` for `primary` organization * `user_primary_organization_description` - Translate JumpCloud user `employeeType` to G Suite Directory user `description` for `primary` organization * `user_primary_organization_employee_id` - Translate JumpCloud user `employeeIdentifier` to G Suite Directory user `externalIds` element of type `organization` * `user_primary_organization_title` - Translate JumpCloud user `jobTitle` to G Suite Directory user `title` for `primary` organization * `user_alternate_email` - Translate JumpCloud user `alternateEmail` to G Suite Directory user `emails` * `user_status` - Translate JumpCloud user `status` to G Suite Directory user `status` * `user_password` - Translate JumpCloud user `password` to G Suite Directory user `password` - [Direction ]: Direction identify if an attribute is going to be exported or imported from GSuite * `Import`- The data will be imported from GSuite into the user modal * `Export`- The data will be exported from the user modal to GSuite - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkGSuiteTranslationRule.md -#> - Function New-JcSdkGSuiteTranslationRule +Function New-JcSdkGSuiteTranslationRule { [OutputType([JumpCloud.SDK.V2.Models.IGSuiteTranslationRule])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -232,5 +137,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkIPList.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkIPList.ps1 index b335cefd1..bc5824473 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkIPList.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkIPList.ps1 @@ -1,82 +1,4 @@ -<# -.Synopsis -Create an IP list. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/iplists \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Sample IP List\", - \"ips\": [ - \"192.168.10.12\", - \"192.168.10.20 - 192.168.10.30\", - \"123.225.10.0/32\" - ] - }' -``` -.Description -Create an IP list. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/iplists \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Sample IP List\", - \"ips\": [ - \"192.168.10.12\", - \"192.168.10.20 - 192.168.10.30\", - \"123.225.10.0/32\" - ] - }' -``` -.Example -PS C:\> New-JcSdkIPList -Description:() -Ips:() -Name:() - - - ----- ---------- -Description String -Id String -Ips String -Name String - - -.Example -PS C:\> New-JcSdkIPList -Body:() - - - ----- ---------- -Description String -Id String -Ips String -Name String - - - -.Inputs -JumpCloud.SDK.V2.Models.IIPListRequest -.Outputs -JumpCloud.SDK.V2.Models.IIPList -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [Description ]: - [Ips >]: - [Name ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkIPList.md -#> - Function New-JcSdkIPList +Function New-JcSdkIPList { [OutputType([JumpCloud.SDK.V2.Models.IIPList])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -205,5 +127,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkLdapServerSambaDomain.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkLdapServerSambaDomain.ps1 index 2890bb211..b2c4aa53e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkLdapServerSambaDomain.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkLdapServerSambaDomain.ps1 @@ -1,99 +1,4 @@ -<# -.Synopsis -This endpoint allows you to create a samba domain for an LDAP server. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"sid\":\"{SID_ID}\", - \"name\":\"{WORKGROUP_NAME}\" - }' -``` -.Description -This endpoint allows you to create a samba domain for an LDAP server. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"sid\":\"{SID_ID}\", - \"name\":\"{WORKGROUP_NAME}\" - }' -``` -.Example -PS C:\> New-JcSdkLdapServerSambaDomain -LdapserverId:() -Name:() -Sid:() - - - ----- ---------- -Id String -Name String -Sid String - - -.Example -PS C:\> New-JcSdkLdapServerSambaDomain -LdapserverId:() -Body:() - - - ----- ---------- -Id String -Name String -Sid String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.ISambaDomain -.Outputs -JumpCloud.SDK.V2.Models.ISambaDomain -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Name : Name of this domain's WorkGroup - Sid : Security identifier of this domain - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkLdapServerSambaDomain.md -#> - Function New-JcSdkLdapServerSambaDomain +Function New-JcSdkLdapServerSambaDomain { [OutputType([JumpCloud.SDK.V2.Models.ISambaDomain])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -232,5 +137,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkOffice365TranslationRule.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkOffice365TranslationRule.ps1 index 21653c6af..117427c1f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkOffice365TranslationRule.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkOffice365TranslationRule.ps1 @@ -1,99 +1,4 @@ -<# -.Synopsis -This endpoint allows you to create a translation rule for a specific Office 365 instance. -These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Translation Rule Parameters} - }' -``` -.Description -This endpoint allows you to create a translation rule for a specific Office 365 instance. -These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Translation Rule Parameters} - }' -``` -.Example -PS C:\> New-JcSdkOffice365TranslationRule -Office365Id:() -BuiltIn:() -Direction:() - - - ----- ---------- -BuiltIn String -Direction String -Id String - - -.Example -PS C:\> New-JcSdkOffice365TranslationRule -Office365Id:() -Body:() - - - ----- ---------- -BuiltIn String -Direction String -Id String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.IOffice365TranslationRuleRequest -.Outputs -JumpCloud.SDK.V2.Models.IOffice365TranslationRule -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [BuiltIn ]: Built-in translations for Office 365 (Microsoft Graph) export: * `user_alternate_email` - Translate `alternateEmail` field of JumpCloud user to `otherMails` field of Microsoft Graph `user` * `user_business_phones` - Translate `number` field of first JumpCloud user `phoneNumber` of type `work` to `businessPhones` field of Microsoft Graph `user` * `user_city` - Translate `locality` field of JumpCloud user address of type `work` to `city` field of Microsoft Graph user * `user_country` - Translate `country` field of JumpCloud user address of type `work` to `country` field of Microsoft Graph `user` * `user_department` - Translate `department` field of JumpCloud user to `department` field of Microsoft Graph `user` * `user_job_title` - Translate `jobTitle` field of JumpCloud user to `jobTitle` field of Microsoft Graph `user` * `user_manager` - Translate `manager` field of JumpCloud user to `manager` field of Microsoft Graph `user` * `user_mobile_phone` - Translate `number` field of first JumpCloud user `phoneNumber` of type `mobile` to `mobilePhone` field of Microsoft Graph `user` * `user_office_location` - Translate `location` field of JumpCloud user to `officeLocation` field of Microsoft Graph `user` * `user_postal_code` - Translate `postalCode` field of JumpCloud user address of type `work` to `postalCode` field of Microsoft Graph `user` * `user_principal_name_from_alternate_email` - Translate user `alternateEmail` field of Jumpcloud user to `userPrincipalName` field of Microsoft Graph `user` * `user_state` - Translate `region` field of JumpCloud user address of type `work` to `state` field of Microsoft Graph `user` * `user_street_address` - Translate `streetAddress` field of JumpCloud user address of type `work` to `streetAddress` field of Microsoft Graph user - [Direction ]: Direction identify if a attribute is going to be exported or imported from Office365 * `Export`- The data will exported from the user modal to Office365 - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkOffice365TranslationRule.md -#> - Function New-JcSdkOffice365TranslationRule +Function New-JcSdkOffice365TranslationRule { [OutputType([JumpCloud.SDK.V2.Models.IOffice365TranslationRule])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -232,5 +137,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkPolicy.ps1 index ebc6890d1..3ca38c77c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkPolicy.ps1 @@ -1,109 +1,4 @@ -<# -.Synopsis -This endpoint allows you to create a policy. -Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policies \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Policy_Parameters} - }' -``` -.Description -This endpoint allows you to create a policy. -Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policies \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Policy_Parameters} - }' -``` -.Example -PS C:\> New-JcSdkPolicy -Name:() -TemplateId:() -Notes:() -Values:() - - - ----- ---------- -ConfigFields JumpCloud.SDK.V2.Models.PolicyTemplateConfigField[] -Id String -Name String -Notes String -TemplateActivation String -TemplateAlert String -TemplateBehavior String -TemplateDeliveryTypes String -TemplateDescription String -TemplateDisplayName String -TemplateId String -TemplateName String -TemplateOSMetaFamily String -TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] -TemplateReference String -TemplateState String -Values JumpCloud.SDK.V2.Models.PolicyValue[] - - -.Example -PS C:\> New-JcSdkPolicy -Body:() - - - ----- ---------- -ConfigFields JumpCloud.SDK.V2.Models.PolicyTemplateConfigField[] -Id String -Name String -Notes String -TemplateActivation String -TemplateAlert String -TemplateBehavior String -TemplateDeliveryTypes String -TemplateDescription String -TemplateDisplayName String -TemplateId String -TemplateName String -TemplateOSMetaFamily String -TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] -TemplateReference String -TemplateState String -Values JumpCloud.SDK.V2.Models.PolicyValue[] - - - -.Inputs -JumpCloud.SDK.V2.Models.IPolicyCreateRequest -.Outputs -JumpCloud.SDK.V2.Models.IPolicyWithDetails -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Name : The description for this specific Policy. - TemplateId : ObjectId uniquely identifying a Policy instance. - [Notes ]: The notes for this specific Policy. - [Values >]: - [ConfigFieldId ]: The ObjectId of the corresponding Policy Template configuration field. - [Sensitive ]: Defines if the value is sensitive or not. - [Value ]: The value for the configuration field for this Policy instance. - -VALUES : - [ConfigFieldId ]: The ObjectId of the corresponding Policy Template configuration field. - [Sensitive ]: Defines if the value is sensitive or not. - [Value ]: The value for the configuration field for this Policy instance. -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicy.md -#> - Function New-JcSdkPolicy +Function New-JcSdkPolicy { [OutputType([JumpCloud.SDK.V2.Models.IPolicyWithDetails])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -238,5 +133,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkPolicyGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkPolicyGroup.ps1 index 69583a9c0..3f76e9c61 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkPolicyGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkPolicyGroup.ps1 @@ -1,74 +1,4 @@ -<# -.Synopsis -This endpoint allows you to create a new Policy Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policygroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"{Group_Name}\" - }' -``` -.Description -This endpoint allows you to create a new Policy Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policygroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"{Group_Name}\" - }' -``` -.Example -PS C:\> New-JcSdkPolicyGroup -Name:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -Name String -Type String - - -.Example -PS C:\> New-JcSdkPolicyGroup -Body:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -Name String -Type String - - - -.Inputs -JumpCloud.SDK.V2.Models.IPolicyGroupData -.Outputs -JumpCloud.SDK.V2.Models.IPolicyGroup -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Name : Display name of a Policy Group. -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicyGroup.md -#> - Function New-JcSdkPolicyGroup +Function New-JcSdkPolicyGroup { [OutputType([JumpCloud.SDK.V2.Models.IPolicyGroup])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -184,5 +114,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkProviderAdministrator.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkProviderAdministrator.ps1 index 183fcc627..b5d3c9dd5 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkProviderAdministrator.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkProviderAdministrator.ps1 @@ -1,106 +1,4 @@ -<# -.Synopsis -This endpoint allows you to create a provider administrator. -You must be associated with the provider to use this route. -You must provide either `role` or `roleName`. -.Description -This endpoint allows you to create a provider administrator. -You must be associated with the provider to use this route. -You must provide either `role` or `roleName`. -.Example -PS C:\> New-JcSdkProviderAdministrator -ProviderId:() -Email:() -ApiKeyAllowed:() -BindNoOrgs:() -EnableMultiFactor:() -Firstname:() -Lastname:() -Role:() -RoleName:() - - - ----- ---------- -ApiKeyAllowed Boolean -ApiKeySet Boolean -Email String -EnableMultiFactor Boolean -Firstname String -Id String -Lastname String -OrganizationAccessTotal System.Nullable[float] OrganizationAccessTotal {get;set;} -Registered Boolean -Role String -RoleName String -Suspended Boolean - - -.Example -PS C:\> New-JcSdkProviderAdministrator -ProviderId:() -Body:() - - - ----- ---------- -ApiKeyAllowed Boolean -ApiKeySet Boolean -Email String -EnableMultiFactor Boolean -Firstname String -Id String -Lastname String -OrganizationAccessTotal System.Nullable[float] OrganizationAccessTotal {get;set;} -Registered Boolean -Role String -RoleName String -Suspended Boolean - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.IProviderAdminReq -.Outputs -JumpCloud.SDK.V2.Models.IAdministrator -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Email : - [ApiKeyAllowed ]: - [ApiKeyHashCreatedAt ]: - [ApiKeyHashExpireAt ]: - [ApiKeyHashPrefix ]: - [BindNoOrgs ]: - [EnableMultiFactor ]: - [Firstname ]: - [Lastname ]: - [Role ]: - [RoleName ]: - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkProviderAdministrator.md -#> - Function New-JcSdkProviderAdministrator +Function New-JcSdkProviderAdministrator { [OutputType([JumpCloud.SDK.V2.Models.IAdministrator])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -302,5 +200,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkSoftwareApp.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkSoftwareApp.ps1 index d0745cb41..5cc9f74f9 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkSoftwareApp.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkSoftwareApp.ps1 @@ -1,236 +1,4 @@ -<# -.Synopsis -This endpoint allows you to create a Software Application that will be managed by JumpCloud on associated JumpCloud systems. -The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. - -#### Sample Request -``` -$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '{ - \"displayName\": \"Adobe Reader\", - \"settings\": [{\"packageId\": \"adobereader\"}] -}' -``` -.Description -This endpoint allows you to create a Software Application that will be managed by JumpCloud on associated JumpCloud systems. -The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. - -#### Sample Request -``` -$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '{ - \"displayName\": \"Adobe Reader\", - \"settings\": [{\"packageId\": \"adobereader\"}] -}' -``` -.Example -PS C:\> New-JcSdkSoftwareApp -DisplayName:() -Id:() -Settings:() - - - ----- ---------- -DisplayName String -Id String -Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] -UploadUrl String - - -.Example -PS C:\> New-JcSdkSoftwareApp -Body:() - - - ----- ---------- -DisplayName String -Id String -Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] -UploadUrl String - - - -.Inputs -JumpCloud.SDK.V2.Models.ISoftwareApp -.Outputs -JumpCloud.SDK.V2.Models.ISoftwareAppCreate -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [CreatedAt ]: - [DisplayName ]: - [Id ]: - [Settings >]: - [AllowUpdateDelay ]: - [AppCatalogInstallableObjectId ]: ID of the app catalog installable that created this app. - [AppFileName ]: - [AppleVppAppConfiguration ]: Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'. - [AppleVppAssignedLicenses ]: - [AppleVppAvailableLicenses ]: - [AppleVppDetails ]: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. - [(Any) ]: This indicates any property can be added to this object. - [AppleVppIsConfigEnabled ]: Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''. - [AppleVppSupportedDeviceFamilies >]: The supported device families for this VPP Application. - [AppleVppTotalLicenses ]: - [Architectures >]: - [AssetKind ]: The manifest asset kind (ex: software). - [AssetSha256Size ]: The incremental size to use for summing the package as it is downloaded. - [AssetSha256Strings >]: The array of checksums, one each for the hash size up to the total size of the package. - [AutoUpdate ]: - [BundleId ]: - [CommandLineArguments ]: Command line arguments to use with the application. - [CreatedAt ]: - [Description ]: The software app description. - [DesiredState ]: State of Install or Uninstall - [DownloadUrl ]: - [EnterpriseObjectId ]: ID of the Enterprise with which this app is associated - [Format ]: - [GoogleAndroidAppPricing ]: Whether this app is free, free with in-app purchases, or paid. - [GoogleAndroidAppVersion ]: Latest version currently available for this app. - [GoogleAndroidAuthor ]: The name of the author of this app. - [GoogleAndroidAutoUpdateMode ]: Controls the auto-update mode for the app. - [GoogleAndroidCategory ]: The app category (e.g. COMMUNICATION, SOCIAL, etc.). - [GoogleAndroidContentRating ]: The content rating for this app. - [GoogleAndroidDisplayMode ]: The display mode of the web app. - [GoogleAndroidDistributionChannel ]: How and to whom the package is made available. - [GoogleAndroidFeatures >]: The array of android features for the app. - [GoogleAndroidFullDescription ]: Full app description, if available. - [GoogleAndroidIconUrl ]: A link to an image that can be used as an icon for the app. - [GoogleAndroidInstallType ]: The type of installation to perform for an app. - [GoogleAndroidManagedConfigurationTemplateId ]: The managed configurations template for the app. - [GoogleAndroidManagedProperties ]: Indicates whether this app has managed properties or not. - [GoogleAndroidMinSdkVersion ]: The minimum Android SDK necessary to run the app. - [GoogleAndroidName ]: The name of the app in the form enterprises/{enterprise}/applications/{packageName}. - [GoogleAndroidPermissionGrants >]: - [Id ]: An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR. - [Policy ]: The policy for granting the permission. - [GoogleAndroidRuntimePermission ]: The policy for granting permission requests to apps. - [GoogleAndroidStartUrl ]: The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps. - [GoogleAndroidType ]: Type of this android application. - [GoogleAndroidUpdateTime ]: The approximate time (within 7 days) the app was last published. - [GoogleAndroidVersionCode ]: The current version of the web app. - [IconUrl ]: URL to the icon for the app. - [Location ]: Repository where the app is located within the package manager - [LocationObjectId ]: ID of the repository where the app is located within the package manager - [MicrosoftStoreDoNotUpdate ]: Indicates whether the app can be updated or not. - [MicrosoftStoreNonRemovable ]: Indicates whether the app is removable by the users or not. - [MicrosoftStorePackageFamilyName ]: Package Family Name for the app from Microsoft App Store. - [ObjectId ]: - [PackageId ]: - [PackageKind ]: The package manifest kind (ex: software-package). - [PackageManager ]: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. - [PackageSubtitle ]: The package manifest subtitle. - [PackageVersion ]: The package manifest version. - [PackageVersionUpdatedAt ]: - [Scope ]: The installation scope of the software app. - [ShortVersion ]: - [StoredPackageObjectId ]: ID of the stored package this app uses to reference the stored install media. - [StoredPackageVersions >]: - [Metadata ]: Dictionary of - [(Any) ]: This indicates any property can be added to this object. - [Name ]: - [RejectedReason ]: - [Sha256Sum ]: - [Size ]: - [Status ]: - [Version ]: - [TeamId ]: - [UpdateTool ]: - [UpdateToolArguments ]: - [UpdatedAt ]: - [VersionlessDownloadUrl ]: - [UpdatedAt ]: - -SETTINGS : - [AllowUpdateDelay ]: - [AppCatalogInstallableObjectId ]: ID of the app catalog installable that created this app. - [AppFileName ]: - [AppleVppAppConfiguration ]: Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'. - [AppleVppAssignedLicenses ]: - [AppleVppAvailableLicenses ]: - [AppleVppDetails ]: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. - [(Any) ]: This indicates any property can be added to this object. - [AppleVppIsConfigEnabled ]: Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''. - [AppleVppSupportedDeviceFamilies >]: The supported device families for this VPP Application. - [AppleVppTotalLicenses ]: - [Architectures >]: - [AssetKind ]: The manifest asset kind (ex: software). - [AssetSha256Size ]: The incremental size to use for summing the package as it is downloaded. - [AssetSha256Strings >]: The array of checksums, one each for the hash size up to the total size of the package. - [AutoUpdate ]: - [BundleId ]: - [CommandLineArguments ]: Command line arguments to use with the application. - [CreatedAt ]: - [Description ]: The software app description. - [DesiredState ]: State of Install or Uninstall - [DownloadUrl ]: - [EnterpriseObjectId ]: ID of the Enterprise with which this app is associated - [Format ]: - [GoogleAndroidAppPricing ]: Whether this app is free, free with in-app purchases, or paid. - [GoogleAndroidAppVersion ]: Latest version currently available for this app. - [GoogleAndroidAuthor ]: The name of the author of this app. - [GoogleAndroidAutoUpdateMode ]: Controls the auto-update mode for the app. - [GoogleAndroidCategory ]: The app category (e.g. COMMUNICATION, SOCIAL, etc.). - [GoogleAndroidContentRating ]: The content rating for this app. - [GoogleAndroidDisplayMode ]: The display mode of the web app. - [GoogleAndroidDistributionChannel ]: How and to whom the package is made available. - [GoogleAndroidFeatures >]: The array of android features for the app. - [GoogleAndroidFullDescription ]: Full app description, if available. - [GoogleAndroidIconUrl ]: A link to an image that can be used as an icon for the app. - [GoogleAndroidInstallType ]: The type of installation to perform for an app. - [GoogleAndroidManagedConfigurationTemplateId ]: The managed configurations template for the app. - [GoogleAndroidManagedProperties ]: Indicates whether this app has managed properties or not. - [GoogleAndroidMinSdkVersion ]: The minimum Android SDK necessary to run the app. - [GoogleAndroidName ]: The name of the app in the form enterprises/{enterprise}/applications/{packageName}. - [GoogleAndroidPermissionGrants >]: - [Id ]: An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR. - [Policy ]: The policy for granting the permission. - [GoogleAndroidRuntimePermission ]: The policy for granting permission requests to apps. - [GoogleAndroidStartUrl ]: The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps. - [GoogleAndroidType ]: Type of this android application. - [GoogleAndroidUpdateTime ]: The approximate time (within 7 days) the app was last published. - [GoogleAndroidVersionCode ]: The current version of the web app. - [IconUrl ]: URL to the icon for the app. - [Location ]: Repository where the app is located within the package manager - [LocationObjectId ]: ID of the repository where the app is located within the package manager - [MicrosoftStoreDoNotUpdate ]: Indicates whether the app can be updated or not. - [MicrosoftStoreNonRemovable ]: Indicates whether the app is removable by the users or not. - [MicrosoftStorePackageFamilyName ]: Package Family Name for the app from Microsoft App Store. - [ObjectId ]: - [PackageId ]: - [PackageKind ]: The package manifest kind (ex: software-package). - [PackageManager ]: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. - [PackageSubtitle ]: The package manifest subtitle. - [PackageVersion ]: The package manifest version. - [PackageVersionUpdatedAt ]: - [Scope ]: The installation scope of the software app. - [ShortVersion ]: - [StoredPackageObjectId ]: ID of the stored package this app uses to reference the stored install media. - [StoredPackageVersions >]: - [Metadata ]: Dictionary of - [(Any) ]: This indicates any property can be added to this object. - [Name ]: - [RejectedReason ]: - [Sha256Sum ]: - [Size ]: - [Status ]: - [Version ]: - [TeamId ]: - [UpdateTool ]: - [UpdateToolArguments ]: - [UpdatedAt ]: - [VersionlessDownloadUrl ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSoftwareApp.md -#> - Function New-JcSdkSoftwareApp +Function New-JcSdkSoftwareApp { [OutputType([JumpCloud.SDK.V2.Models.ISoftwareAppCreate])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -371,5 +139,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkSystemGroup.ps1 index 31af9abee..412de5324 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkSystemGroup.ps1 @@ -1,109 +1,4 @@ -<# -.Synopsis -This endpoint allows you to create a new System Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"{Group_Name}\" - }' -``` -.Description -This endpoint allows you to create a new System Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"{Group_Name}\" - }' -``` -.Example -PS C:\> New-JcSdkSystemGroup -Name:() -Attributes:() -Description:() -Email:() -MemberQueryExemptions:() -MemberQueryFilters:() -MemberQueryType:() -MemberSuggestionsNotify:() -MembershipMethod:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -Type String - - -.Example -PS C:\> New-JcSdkSystemGroup -Body:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -Type String - - - -.Inputs -JumpCloud.SDK.V2.Models.ISystemGroupPost -.Outputs -JumpCloud.SDK.V2.Models.ISystemGroup -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Name : Display name of a System Group. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - [Description ]: Description of a System Group - [Email ]: Email address of a System Group - [MemberQueryExemptions >]: Array of GraphObjects exempted from the query - Id : The ObjectID of the graph object. - Type : The type of graph object. - [Attributes ]: The graph attributes. - [MemberQueryFilters >]: For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. - [MemberQuerySearchFilters ]: For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. - [MemberQueryType ]: - [MemberSuggestionsNotify ]: True if notification emails are to be sent for membership suggestions. - [MembershipMethod ]: The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED. Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices). Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. - -MEMBERQUERYEXEMPTIONS : - Id : The ObjectID of the graph object. - Type : The type of graph object. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSystemGroup.md -#> - Function New-JcSdkSystemGroup +Function New-JcSdkSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.ISystemGroup])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -277,5 +172,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkUserGroup.ps1 index dca73e860..5a82f7f35 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkUserGroup.ps1 @@ -1,125 +1,4 @@ -<# -.Synopsis -This endpoint allows you to create a new User Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"{Group_Name}\" - }' -``` -.Description -This endpoint allows you to create a new User Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"{Group_Name}\" - }' -``` -.Example -PS C:\> New-JcSdkUserGroup -Name:() -Attributes:() -Description:() -Email:() -MemberQueryExemptions:() -MemberQueryFilters:() -MemberQueryType:() -MemberSuggestionsNotify:() -MembershipMethod:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -SuggestionCountAdd Int -SuggestionCountRemove Int -SuggestionCountTotal Int -Type String - - -.Example -PS C:\> New-JcSdkUserGroup -Body:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -SuggestionCountAdd Int -SuggestionCountRemove Int -SuggestionCountTotal Int -Type String - - - -.Inputs -JumpCloud.SDK.V2.Models.IUserGroupPost -.Outputs -JumpCloud.SDK.V2.Models.IUserGroup -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Name : Display name of a User Group. - [Attributes ]: The graph attributes for a UserGroup. - [(Any) ]: This indicates any property can be added to this object. - [SudoEnabled ]: Enables sudo - [SudoWithoutPassword ]: Enable sudo without password (requires 'enabled' to be true) - [LdapGroups >]: - [Name ]: - [PosixGroups >]: - Id : - Name : - [RadiusReply >]: - Name : - Value : - [SambaEnabled ]: - [Description ]: Description of a User Group - [Email ]: Email address of a User Group - [MemberQueryExemptions >]: Array of GraphObjects exempted from the query - Id : The ObjectID of the graph object. - Type : The type of graph object. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - [MemberQueryFilters >]: For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. - [MemberQuerySearchFilters ]: For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. - [MemberQueryType ]: - [MemberSuggestionsNotify ]: True if notification emails are to be sent for membership suggestions. - [MembershipMethod ]: The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED. Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices). Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. - -MEMBERQUERYEXEMPTIONS : - Id : The ObjectID of the graph object. - Type : The type of graph object. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkUserGroup.md -#> - Function New-JcSdkUserGroup +Function New-JcSdkUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IUserGroup])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -293,5 +172,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkWorkday.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkWorkday.ps1 index 80d7818f1..b811d635a 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkWorkday.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkWorkday.ps1 @@ -1,114 +1,4 @@ -<# -.Synopsis -This endpoint allows you to create a new workday instance. - -You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. -Failure to provide these credentials will result in the request being rejected. - -Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. - -Currently, only one instance is allowed and it must be `Workday Import`. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Workday2\", - \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", - \"auth\": { - \"basic\": { - \"username\": \"someDeveloper\", - \"password\": \"notTheRealPassword\" - } - } - }' -``` -.Description -This endpoint allows you to create a new workday instance. - -You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. -Failure to provide these credentials will result in the request being rejected. - -Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. - -Currently, only one instance is allowed and it must be `Workday Import`. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Workday2\", - \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", - \"auth\": { - \"basic\": { - \"username\": \"someDeveloper\", - \"password\": \"notTheRealPassword\" - } - } - }' -``` -.Example -PS C:\> New-JcSdkWorkday -BasicPassword:() -BasicUsername:() -Name:() -OauthCode:() -ReportUrl:() - - - ----- ---------- -BasicExpiry String -BasicIsValid Boolean -BasicMessage String -Id String -LastImport String -Name String -OauthExpiry String -OauthIsValid Boolean -OauthMessage String -ReportUrl String - - -.Example -PS C:\> New-JcSdkWorkday -Body:() - - - ----- ---------- -BasicExpiry String -BasicIsValid Boolean -BasicMessage String -Id String -LastImport String -Name String -OauthExpiry String -OauthIsValid Boolean -OauthMessage String -ReportUrl String - - - -.Inputs -JumpCloud.SDK.V2.Models.IWorkdayInput -.Outputs -JumpCloud.SDK.V2.Models.IWorkdayOutput -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [BasicPassword ]: - [BasicUsername ]: - [Name ]: - [OauthCode ]: - [ReportUrl ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkWorkday.md -#> - Function New-JcSdkWorkday +Function New-JcSdkWorkday { [OutputType([JumpCloud.SDK.V2.Models.IWorkdayOutput])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -248,5 +138,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkActiveDirectory.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkActiveDirectory.ps1 index 4d7ab0f68..3abfcd191 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkActiveDirectory.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkActiveDirectory.ps1 @@ -1,79 +1,4 @@ -<# -.Synopsis -This endpoint allows you to delete an Active Directory Instance. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Description -This endpoint allows you to delete an Active Directory Instance. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Example -PS C:\> Remove-JcSdkActiveDirectory -Id:() - - - ----- ---------- -Domain String -Id String -PrimaryAgent String -UseCase String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IActiveDirectory -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectory.md -#> - Function Remove-JcSdkActiveDirectory +Function Remove-JcSdkActiveDirectory { [OutputType([JumpCloud.SDK.V2.Models.IActiveDirectory])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -189,5 +114,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkActiveDirectoryAgent.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkActiveDirectoryAgent.ps1 index 569abcf35..62d83d513 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkActiveDirectoryAgent.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkActiveDirectoryAgent.ps1 @@ -1,71 +1,4 @@ -<# -.Synopsis -This endpoint deletes an Active Directory agent. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint deletes an Active Directory agent. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Remove-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -AgentId:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectoryAgent.md -#> - Function Remove-JcSdkActiveDirectoryAgent +Function Remove-JcSdkActiveDirectoryAgent { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -193,5 +126,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAdministratorOrganization.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAdministratorOrganization.ps1 index fdd4e2cbf..9a4a66fda 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAdministratorOrganization.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAdministratorOrganization.ps1 @@ -1,55 +1,4 @@ -<# -.Synopsis -This endpoint removes the association link between an Administrator and an Organization. -.Description -This endpoint removes the association link between an Administrator and an Organization. -.Example -PS C:\> Remove-JcSdkAdministratorOrganization -AdministratorId:() -Id:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAdministratorOrganization.md -#> - Function Remove-JcSdkAdministratorOrganization +Function Remove-JcSdkAdministratorOrganization { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -177,5 +126,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAppleMdm.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAppleMdm.ps1 index a6aa45c82..f351534a9 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAppleMdm.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAppleMdm.ps1 @@ -1,112 +1,4 @@ -<# -.Synopsis -Removes an Apple MDM configuration. - -Warning: This is a destructive operation and will remove your Apple Push Certificates. -We will no longer be able to manage your devices and the only recovery option is to re-register all devices into MDM. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -Removes an Apple MDM configuration. - -Warning: This is a destructive operation and will remove your Apple Push Certificates. -We will no longer be able to manage your devices and the only recovery option is to re-register all devices into MDM. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Remove-JcSdkAppleMdm -Id:() - - - ----- ---------- -AllowMobileUserEnrollment Boolean -ApnsCertExpiry String -ApnsPushTopic String -AppleCertCreatorAppleId String -AppleCertSerialNumber String -DefaultIosUserEnrollmentDeviceGroupId String -DefaultSystemGroupId String -DepAccessTokenExpiry String -DepEnableZeroTouchEnrollment Boolean -DepServerTokenState String -DepSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -Id String -IoDefaultDeviceGroupObjectIds String -IoEnableZeroTouchEnrollment Boolean -IoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -IoSetupOptions String -IosWelcomeScreenButton String -IosWelcomeScreenParagraph String -IosWelcomeScreenTitle String -MacoDefaultDeviceGroupObjectIds String -MacoEnableZeroTouchEnrollment Boolean -MacoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -MacoSetupOptions String -MacosWelcomeScreenButton String -MacosWelcomeScreenParagraph String -MacosWelcomeScreenTitle String -Name String -Organization String -WelcomeScreenButton String -WelcomeScreenParagraph String -WelcomeScreenTitle String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IAppleMdm -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdm.md -#> - Function Remove-JcSdkAppleMdm +Function Remove-JcSdkAppleMdm { [OutputType([JumpCloud.SDK.V2.Models.IAppleMdm])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -222,5 +114,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAppleMdmDevice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAppleMdmDevice.ps1 index fd7d8c29d..709e2631d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAppleMdmDevice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAppleMdmDevice.ps1 @@ -1,99 +1,4 @@ -<# -.Synopsis -Remove a single Apple MDM device from MDM enrollment. - -#### Sample Request -``` - curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ - -H 'accept: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -Remove a single Apple MDM device from MDM enrollment. - -#### Sample Request -``` - curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ - -H 'accept: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Remove-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() - - - ----- ---------- -CreatedAt String -DepRegistered Boolean -DeviceInformationActivationLockAllowedWhileSupervised Boolean -DeviceInformationAvailableDeviceCapacity System.Nullable[float] DeviceInformationAvailableDeviceCapacity {get;set;} -DeviceInformationDeviceCapacity System.Nullable[float] DeviceInformationDeviceCapacity {get;set;} -DeviceInformationDeviceName String -DeviceInformationIccid String -DeviceInformationImei String -DeviceInformationIsSupervised Boolean -DeviceInformationModelName String -DeviceInformationSecondIccid String -DeviceInformationSecondImei String -DeviceInformationSecondSubscriberCarrierNetwork String -DeviceInformationSubscriberCarrierNetwork String -DeviceInformationWifiMac String -Enrolled Boolean -HasActivationLockBypassCodes Boolean -Id String -OSVersion String -SecurityInfoEnrolledViaDep Boolean -SecurityInfoIsActivationLockManageable Boolean -SecurityInfoIsUserEnrollment Boolean -SecurityInfoPasscodePresent Boolean -SecurityInfoUserApprovedEnrollment Boolean -SerialNumber String -Udid String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IAppleMdmDevice -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdmDevice.md -#> - Function Remove-JcSdkAppleMdmDevice +Function Remove-JcSdkAppleMdmDevice { [OutputType([JumpCloud.SDK.V2.Models.IAppleMdmDevice])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -215,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkApplicationLogo.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkApplicationLogo.ps1 index a4145bee8..b12430eca 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkApplicationLogo.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkApplicationLogo.ps1 @@ -1,55 +1,4 @@ -<# -.Synopsis -Deletes the specified image from an application -.Description -Deletes the specified image from an application -.Example -PS C:\> Remove-JcSdkApplicationLogo -ApplicationId:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApplicationLogo.md -#> - Function Remove-JcSdkApplicationLogo +Function Remove-JcSdkApplicationLogo { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -171,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkApprovalFlow.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkApprovalFlow.ps1 index d5ba3205e..df5dacee4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkApprovalFlow.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkApprovalFlow.ps1 @@ -1,51 +1,4 @@ -<# -.Synopsis -Endpoint for deleting accessworkflow by id -.Description -Endpoint for deleting accessworkflow by id -.Example -PS C:\> Remove-JcSdkApprovalFlow -ApprovalFlowId:() -.Example -{{ Add code here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IJumpcloudIngressoDeleteAccessWorkflowResponse -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApprovalFlow.md -#> - Function Remove-JcSdkApprovalFlow +Function Remove-JcSdkApprovalFlow { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoDeleteAccessWorkflowResponse])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -168,5 +121,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAuthenticationPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAuthenticationPolicy.ps1 index 0b7b3dbb1..ed620bf07 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAuthenticationPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAuthenticationPolicy.ps1 @@ -1,90 +1,4 @@ -<# -.Synopsis -Delete the specified authentication policy. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -Delete the specified authentication policy. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Remove-JcSdkAuthenticationPolicy -Id:() - - - ----- ---------- -Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions -Description String -Disabled Boolean -EffectAction String -Id String -MfaRequired Boolean -Name String -TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] -Type String -UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserGroupExclusions String -UserGroupInclusions String -UserInclusions String -UserVerificationRequirement String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IAuthnPolicy -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAuthenticationPolicy.md -#> - Function Remove-JcSdkAuthenticationPolicy +Function Remove-JcSdkAuthenticationPolicy { [OutputType([JumpCloud.SDK.V2.Models.IAuthnPolicy])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -200,5 +114,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkBulkUserState.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkBulkUserState.ps1 index 313d836a6..5775d970e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkBulkUserState.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkBulkUserState.ps1 @@ -1,69 +1,4 @@ -<# -.Synopsis -This endpoint deletes a scheduled statechange job. -#### Sample Request -``` -curl -X DELETE \"https://console.jumpcloud.com/api/v2/bulk/userstates/{ScheduledJob_ID}\" \\ - -H 'x-api-key: {API_KEY}' \\ - -H 'Content-Type: application/json' \\ - -H 'Accept: application/json' -``` -.Description -This endpoint deletes a scheduled statechange job. -#### Sample Request -``` -curl -X DELETE \"https://console.jumpcloud.com/api/v2/bulk/userstates/{ScheduledJob_ID}\" \\ - -H 'x-api-key: {API_KEY}' \\ - -H 'Content-Type: application/json' \\ - -H 'Accept: application/json' -``` -.Example -PS C:\> Remove-JcSdkBulkUserState -Id:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkBulkUserState.md -#> - Function Remove-JcSdkBulkUserState +Function Remove-JcSdkBulkUserState { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -185,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkCustomEmailConfiguration.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkCustomEmailConfiguration.ps1 index 809a6c615..6184a9f13 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkCustomEmailConfiguration.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkCustomEmailConfiguration.ps1 @@ -1,55 +1,4 @@ -<# -.Synopsis -Delete the custom email configuration for the specified custom email type -.Description -Delete the custom email configuration for the specified custom email type -.Example -PS C:\> Remove-JcSdkCustomEmailConfiguration -CustomEmailType:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkCustomEmailConfiguration.md -#> - Function Remove-JcSdkCustomEmailConfiguration +Function Remove-JcSdkCustomEmailConfiguration { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -171,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkDuoAccount.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkDuoAccount.ps1 index f9f3a67d6..744679f02 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkDuoAccount.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkDuoAccount.ps1 @@ -1,77 +1,4 @@ -<# -.Synopsis -Removes the specified Duo account, an error will be returned if the account has some Duo application used in a protected resource. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -Removes the specified Duo account, an error will be returned if the account has some Duo application used in a protected resource. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Remove-JcSdkDuoAccount -Id:() - - - ----- ---------- -Id String -Name String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IDuoAccount -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoAccount.md -#> - Function Remove-JcSdkDuoAccount +Function Remove-JcSdkDuoAccount { [OutputType([JumpCloud.SDK.V2.Models.IDuoAccount])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -187,5 +114,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkDuoApplication.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkDuoApplication.ps1 index 351225dda..49504e814 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkDuoApplication.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkDuoApplication.ps1 @@ -1,79 +1,4 @@ -<# -.Synopsis -Deletes the specified Duo application, an error will be returned if the application is used in a protected resource. - -#### Sample Request -``` - curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}'' -``` -.Description -Deletes the specified Duo application, an error will be returned if the application is used in a protected resource. - -#### Sample Request -``` - curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}'' -``` -.Example -PS C:\> Remove-JcSdkDuoApplication -AccountId:() -ApplicationId:() - - - ----- ---------- -ApiHost String -Id String -IntegrationKey String -Name String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IDuoApplication -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoApplication.md -#> - Function Remove-JcSdkDuoApplication +Function Remove-JcSdkDuoApplication { [OutputType([JumpCloud.SDK.V2.Models.IDuoApplication])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -195,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkGSuiteTranslationRule.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkGSuiteTranslationRule.ps1 index 2de7b1150..8879320a8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkGSuiteTranslationRule.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkGSuiteTranslationRule.ps1 @@ -1,75 +1,4 @@ -<# -.Synopsis -This endpoint allows you to delete a translation rule for a specific G Suite instance. -These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. - -#### Sample Request - -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Description -This endpoint allows you to delete a translation rule for a specific G Suite instance. -These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. - -#### Sample Request - -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Example -PS C:\> Remove-JcSdkGSuiteTranslationRule -GsuiteId:() -Id:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkGSuiteTranslationRule.md -#> - Function Remove-JcSdkGSuiteTranslationRule +Function Remove-JcSdkGSuiteTranslationRule { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -197,5 +126,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkIPList.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkIPList.ps1 index d36df2ecf..94114b07f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkIPList.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkIPList.ps1 @@ -1,79 +1,4 @@ -<# -.Synopsis -Delete a specific IP list. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -Delete a specific IP list. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Remove-JcSdkIPList -Id:() - - - ----- ---------- -Description String -Id String -Ips String -Name String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IIPList -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkIPList.md -#> - Function Remove-JcSdkIPList +Function Remove-JcSdkIPList { [OutputType([JumpCloud.SDK.V2.Models.IIPList])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -189,5 +114,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkLdapServerSambaDomain.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkLdapServerSambaDomain.ps1 index 3af650838..a0d46d257 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkLdapServerSambaDomain.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkLdapServerSambaDomain.ps1 @@ -1,71 +1,4 @@ -<# -.Synopsis -This endpoint allows you to delete a samba domain from an LDAP server. - -##### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -This endpoint allows you to delete a samba domain from an LDAP server. - -##### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Remove-JcSdkLdapServerSambaDomain -Id:() -LdapserverId:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.String -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkLdapServerSambaDomain.md -#> - Function Remove-JcSdkLdapServerSambaDomain +Function Remove-JcSdkLdapServerSambaDomain { [OutputType([System.String])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -193,5 +126,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkOffice365TranslationRule.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkOffice365TranslationRule.ps1 index cc1e86891..c5c0a8230 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkOffice365TranslationRule.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkOffice365TranslationRule.ps1 @@ -1,75 +1,4 @@ -<# -.Synopsis -This endpoint allows you to delete a translation rule for a specific Office 365 instance. -These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. - -#### Sample Request - -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Description -This endpoint allows you to delete a translation rule for a specific Office 365 instance. -These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. - -#### Sample Request - -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Example -PS C:\> Remove-JcSdkOffice365TranslationRule -Id:() -Office365Id:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkOffice365TranslationRule.md -#> - Function Remove-JcSdkOffice365TranslationRule +Function Remove-JcSdkOffice365TranslationRule { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -197,5 +126,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkPolicy.ps1 index e7b6dd86b..00d5b7f5f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkPolicy.ps1 @@ -1,73 +1,4 @@ -<# -.Synopsis -This endpoint allows you to delete a policy. - -#### Sample Request - -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/policies/5a837ecd232e110d4291e6b9 \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Description -This endpoint allows you to delete a policy. - -#### Sample Request - -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/policies/5a837ecd232e110d4291e6b9 \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` -.Example -PS C:\> Remove-JcSdkPolicy -Id:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicy.md -#> - Function Remove-JcSdkPolicy +Function Remove-JcSdkPolicy { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -189,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkPolicyGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkPolicyGroup.ps1 index 4ec70154c..ee3f872eb 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkPolicyGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkPolicyGroup.ps1 @@ -1,83 +1,4 @@ -<# -.Synopsis -This endpoint allows you to delete a Policy Group. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint allows you to delete a Policy Group. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Remove-JcSdkPolicyGroup -Id:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -Name String -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IPolicyGroup -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicyGroup.md -#> - Function Remove-JcSdkPolicyGroup +Function Remove-JcSdkPolicyGroup { [OutputType([JumpCloud.SDK.V2.Models.IPolicyGroup])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -199,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkProviderAdministrator.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkProviderAdministrator.ps1 index 52e46758a..a21c7d171 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkProviderAdministrator.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkProviderAdministrator.ps1 @@ -1,57 +1,4 @@ -<# -.Synopsis -This endpoint removes an Administrator associated with the Provider. -You must be associated with the provider to use this route. -.Description -This endpoint removes an Administrator associated with the Provider. -You must be associated with the provider to use this route. -.Example -PS C:\> Remove-JcSdkProviderAdministrator -Id:() -ProviderId:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkProviderAdministrator.md -#> - Function Remove-JcSdkProviderAdministrator +Function Remove-JcSdkProviderAdministrator { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -179,5 +126,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkSoftwareApp.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkSoftwareApp.ps1 index 836542dbd..ad08251ac 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkSoftwareApp.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkSoftwareApp.ps1 @@ -1,75 +1,4 @@ -<# -.Synopsis -Removes a Software Application configuration. - -Warning: This is a destructive operation and will unmanage the application on all affected systems. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -Removes a Software Application configuration. - -Warning: This is a destructive operation and will unmanage the application on all affected systems. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Remove-JcSdkSoftwareApp -Id:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSoftwareApp.md -#> - Function Remove-JcSdkSoftwareApp +Function Remove-JcSdkSoftwareApp { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -191,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkSystemGroup.ps1 index 17217fe5b..3baeda277 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkSystemGroup.ps1 @@ -1,88 +1,4 @@ -<# -.Synopsis -This endpoint allows you to delete a System Group. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint allows you to delete a System Group. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Remove-JcSdkSystemGroup -Id:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.ISystemGroup -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSystemGroup.md -#> - Function Remove-JcSdkSystemGroup +Function Remove-JcSdkSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.ISystemGroup])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -204,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkUserGroup.ps1 index c37533a2e..3ea81307b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkUserGroup.ps1 @@ -1,91 +1,4 @@ -<# -.Synopsis -This endpoint allows you to delete a User Group. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Description -This endpoint allows you to delete a User Group. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` -.Example -PS C:\> Remove-JcSdkUserGroup -Id:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -SuggestionCountAdd Int -SuggestionCountRemove Int -SuggestionCountTotal Int -Type String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IUserGroup -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserGroup.md -#> - Function Remove-JcSdkUserGroup +Function Remove-JcSdkUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IUserGroup])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -207,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkUserPushEndpoint.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkUserPushEndpoint.ps1 index 7dc67bb65..99b6f34c1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkUserPushEndpoint.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkUserPushEndpoint.ps1 @@ -1,70 +1,4 @@ -<# -.Synopsis -This endpoint will delete a push endpoint associated with a user. -.Description -This endpoint will delete a push endpoint associated with a user. -.Example -PS C:\> Remove-JcSdkUserPushEndpoint -PushEndpointId:() -UserId:() - - - ----- ---------- -DeviceAppVersion String -DeviceMake String -DeviceModel String -DeviceOS String -DeviceOSVersion String -DeviceUvEnabled Boolean -EnrollmentDate Datetime -Id String -LastUsedDate Datetime -Name String -State String - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IPushEndpointResponse -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserPushEndpoint.md -#> - Function Remove-JcSdkUserPushEndpoint +Function Remove-JcSdkUserPushEndpoint { [OutputType([JumpCloud.SDK.V2.Models.IPushEndpointResponse])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -186,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkWorkdayAuthorization.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkWorkdayAuthorization.ps1 index b8ac589ee..1e5daf761 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkWorkdayAuthorization.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkWorkdayAuthorization.ps1 @@ -1,71 +1,4 @@ -<# -.Synopsis -Removes any and all authorization methods from the workday instance - -##### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Description -Removes any and all authorization methods from the workday instance - -##### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` -.Example -PS C:\> Remove-JcSdkWorkdayAuthorization -WorkdayId:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkWorkdayAuthorization.md -#> - Function Remove-JcSdkWorkdayAuthorization +Function Remove-JcSdkWorkdayAuthorization { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -187,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Restart-JcSdkAppleMdmDevice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Restart-JcSdkAppleMdmDevice.ps1 index d48561791..6c7a421de 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Restart-JcSdkAppleMdmDevice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Restart-JcSdkAppleMdmDevice.ps1 @@ -1,78 +1,4 @@ -<# -.Synopsis -Restarts a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/restart \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{\"kextPaths\": [\"Path1\", \"Path2\"]}' -``` -.Description -Restarts a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/restart \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{\"kextPaths\": [\"Path1\", \"Path2\"]}' -``` -.Example -PS C:\> Restart-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Body:() - - -.Example -PS C:\> Restart-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -KextPaths:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.IPaths1Whnyt3ApplemdmsAppleMdmIdDevicesDeviceIdRestartPostRequestbodyContentApplicationJsonSchema -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [KextPaths >]: The string to pass when doing a restart and performing a RebuildKernelCache. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Restart-JcSdkAppleMdmDevice.md -#> - Function Restart-JcSdkAppleMdmDevice +Function Restart-JcSdkAppleMdmDevice { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='RestartExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -218,5 +144,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAccessRequest.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAccessRequest.ps1 index 2363be705..9305e95e9 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAccessRequest.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAccessRequest.ps1 @@ -1,61 +1,4 @@ -<# -.Synopsis -Endpoint that set the workflow access request by id -.Description -Endpoint that set the workflow access request by id -.Example -PS C:\> Set-JcSdkAccessRequest -Id:() -Admin:() -ApprovedDuration:() -InternalNote:() -OrganizationObjectIdInputFile:() -Remarks:() -Status:() -.Example -PS C:\> Set-JcSdkAccessRequest -Id:() -Body:() - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.IPaths17F25RsApprovalflowrequestIdPutRequestbodyContentApplicationJsonSchema -.Outputs -JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateWorkflowAccessRequestResponse -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [Admin ]: - [ApprovedDuration ]: - [InternalNote ]: - [OrganizationObjectId ]: - [Remarks ]: - [Status ]: - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequest.md -#> - Function Set-JcSdkAccessRequest +Function Set-JcSdkAccessRequest { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateWorkflowAccessRequestResponse])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -222,5 +165,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAccessRequestApproval.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAccessRequestApproval.ps1 index 364fdb821..f2d83c7eb 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAccessRequestApproval.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAccessRequestApproval.ps1 @@ -1,32 +1,4 @@ -<# -.Synopsis -Endpoint for user approval -.Description -Endpoint for user approval -.Example -PS C:\> Set-JcSdkAccessRequestApproval -ApprovedDuration:() -Id:() -OrganizationObjectIdInputFile:() -Remarks:() -Status:() -.Example -PS C:\> Set-JcSdkAccessRequestApproval -Body:() - -.Inputs -JumpCloud.SDK.V2.Models.IJumpcloudIngressoUserApprovalRequest -.Outputs -JumpCloud.SDK.V2.Models.IJumpcloudIngressoUserApprovalRequestResponse -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [ApprovedDuration ]: - [Id ]: - [OrganizationObjectId ]: - [Remarks ]: - [Status ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequestApproval.md -#> - Function Set-JcSdkAccessRequestApproval +Function Set-JcSdkAccessRequestApproval { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoUserApprovalRequestResponse])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -166,5 +138,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkActiveDirectoryAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkActiveDirectoryAssociation.ps1 index ffc5d92a4..517cf4348 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkActiveDirectoryAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkActiveDirectoryAssociation.ps1 @@ -1,94 +1,4 @@ -<# -.Synopsis -This endpoint allows you to manage the _direct_ associations of an Active Directory instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{AD_Instance_ID}/associations \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{User_ID}\" - }' -``` -.Description -This endpoint allows you to manage the _direct_ associations of an Active Directory instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{AD_Instance_ID}/associations \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{User_ID}\" - }' -``` -.Example -PS C:\> Set-JcSdkActiveDirectoryAssociation -ActivedirectoryId:() -Body:() - - -.Example -PS C:\> Set-JcSdkActiveDirectoryAssociation -ActivedirectoryId:() -Id:() -Op:() -Type:() -Attributes:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IGraphOperationActiveDirectoryAutoGenerated -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Id : The ObjectID of graph object being added or removed as an association. - Op : How to modify the graph connection. - Type : Targets which a "active_directory" can be associated to. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkActiveDirectoryAssociation.md -#> - Function Set-JcSdkActiveDirectoryAssociation +Function Set-JcSdkActiveDirectoryAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -249,5 +159,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAppleMdm.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAppleMdm.ps1 index 572a5dc16..8ddeb303f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAppleMdm.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAppleMdm.ps1 @@ -1,209 +1,4 @@ -<# -.Synopsis -Set an Apple MDM configuration. -This endpoint is used to supply JumpCloud with a signed certificate from Apple in order to finalize the setup and allow JumpCloud to manage your devices. -It may also be used to set the DEP Settings. - -#### Sample Request -``` - curl -X PUT https://console.jumpcloud.com/api/v2/applemdms/{ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"MDM name\", - \"appleSignedCert\": \"{CERTIFICATE}\", - \"encryptedDepServerToken\": \"{SERVER_TOKEN}\", - \"dep\": { - \"welcomeScreen\": { - \"title\": \"Welcome\", - \"paragraph\": \"In just a few steps, you will be working securely from your Mac.\", - \"button\": \"continue\", - }, - }, - }' -``` -.Description -Set an Apple MDM configuration. -This endpoint is used to supply JumpCloud with a signed certificate from Apple in order to finalize the setup and allow JumpCloud to manage your devices. -It may also be used to set the DEP Settings. - -#### Sample Request -``` - curl -X PUT https://console.jumpcloud.com/api/v2/applemdms/{ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"MDM name\", - \"appleSignedCert\": \"{CERTIFICATE}\", - \"encryptedDepServerToken\": \"{SERVER_TOKEN}\", - \"dep\": { - \"welcomeScreen\": { - \"title\": \"Welcome\", - \"paragraph\": \"In just a few steps, you will be working securely from your Mac.\", - \"button\": \"continue\", - }, - }, - }' -``` -.Example -PS C:\> Set-JcSdkAppleMdm -Id:() -Body:() - - - ----- ---------- -AllowMobileUserEnrollment Boolean -ApnsCertExpiry String -ApnsPushTopic String -AppleCertCreatorAppleId String -AppleCertSerialNumber String -DefaultIosUserEnrollmentDeviceGroupId String -DefaultSystemGroupId String -DepAccessTokenExpiry String -DepEnableZeroTouchEnrollment Boolean -DepServerTokenState String -DepSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -Id String -IoDefaultDeviceGroupObjectIds String -IoEnableZeroTouchEnrollment Boolean -IoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -IoSetupOptions String -IosWelcomeScreenButton String -IosWelcomeScreenParagraph String -IosWelcomeScreenTitle String -MacoDefaultDeviceGroupObjectIds String -MacoEnableZeroTouchEnrollment Boolean -MacoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -MacoSetupOptions String -MacosWelcomeScreenButton String -MacosWelcomeScreenParagraph String -MacosWelcomeScreenTitle String -Name String -Organization String -WelcomeScreenButton String -WelcomeScreenParagraph String -WelcomeScreenTitle String - - -.Example -PS C:\> Set-JcSdkAppleMdm -Id:() -AllowMobileUserEnrollment:() -AppleCertCreatorAppleId:() -AppleSignedCert:() -DefaultIosUserEnrollmentDeviceGroupId:() -DefaultSystemGroupId:() -DepEnableZeroTouchEnrollment:() -DepSetupAssistantOptions:() -EncryptedDepServerToken:() -IoDefaultDeviceGroupObjectIds:() -IoEnableZeroTouchEnrollment:() -IoSetupAssistantOptions:() -IoSetupOptions:() -IosWelcomeScreenButton:() -IosWelcomeScreenParagraph:() -IosWelcomeScreenTitle:() -MacoDefaultDeviceGroupObjectIds:() -MacoEnableZeroTouchEnrollment:() -MacoSetupAssistantOptions:() -MacoSetupOptions:() -MacosWelcomeScreenButton:() -MacosWelcomeScreenParagraph:() -MacosWelcomeScreenTitle:() -Name:() -WelcomeScreenButton:() -WelcomeScreenParagraph:() -WelcomeScreenTitle:() - - - ----- ---------- -AllowMobileUserEnrollment Boolean -ApnsCertExpiry String -ApnsPushTopic String -AppleCertCreatorAppleId String -AppleCertSerialNumber String -DefaultIosUserEnrollmentDeviceGroupId String -DefaultSystemGroupId String -DepAccessTokenExpiry String -DepEnableZeroTouchEnrollment Boolean -DepServerTokenState String -DepSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -Id String -IoDefaultDeviceGroupObjectIds String -IoEnableZeroTouchEnrollment Boolean -IoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -IoSetupOptions String -IosWelcomeScreenButton String -IosWelcomeScreenParagraph String -IosWelcomeScreenTitle String -MacoDefaultDeviceGroupObjectIds String -MacoEnableZeroTouchEnrollment Boolean -MacoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -MacoSetupOptions String -MacosWelcomeScreenButton String -MacosWelcomeScreenParagraph String -MacosWelcomeScreenTitle String -Name String -Organization String -WelcomeScreenButton String -WelcomeScreenParagraph String -WelcomeScreenTitle String - - - -.Inputs -JumpCloud.SDK.V2.Models.IAppleMdmPatch -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IAppleMdm -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [AllowMobileUserEnrollment ]: A toggle to allow mobile device enrollment for an organization. - [AppleCertCreatorAppleId ]: The Apple ID of the admin who created the Apple signed certificate. - [AppleSignedCert ]: A signed certificate obtained from Apple after providing Apple with the plist file provided on POST. - [DefaultIosUserEnrollmentDeviceGroupId ]: ObjectId uniquely identifying the MDM default iOS user enrollment device group. - [DefaultSystemGroupId ]: ObjectId uniquely identifying the MDM default System Group. - [DepEnableZeroTouchEnrollment ]: A toggle to determine if DEP registered devices should go through JumpCloud Zero Touch Enrollment. - [DepSetupAssistantOptions >]: - [Option ]: Options to skip screens during MacOS and iOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `actionButton` - Skips the Action Button configuration pane. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `cameraButton` - Skips the Camera Button configuration pane. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `enableLockdownMode` - Skips the Lockdown Mode pane. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `intelligence` - Skips the Intelligence pane. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `termsOfAddress` - Skips the Terms of Address pane. * `tos` - Skips terms and conditions. * `appStore` - Skips the App Store pane. * `deviceToDeviceMigration` - Skips Device to Device Migration pane. * `displayZoom` - Skips zoom setup. * `homeButton` - Skips the Meet the New Home Button screen on iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus and iPhone SE. * `imessageAndFacetime` - Skips the iMessage and FaceTime screen in iOS. * `messagingActivationUsingPhoneNumber` - Skips the iMessage pane. * `moveFromAndroid` - If the Restore pane is not skipped, removes the Move from Android option in the Restore pane on iOS.O * `passcode` - Hides and disables the passcode pane. * `restoreComplete` - Skips the Restore Completed pane. * `safety` - Skips the Safety pane. * `setupCellular` - Skips the add cellular plan pane. * `softwareUpdate` - Skips the mandatory software update screen in iOS. * `unlockWithWatch` - Skips Unlock Your Mac with your Apple Watch pane. * `updateComplete` - Skips the Software Update Complete pane. * `wallpaper` - Skips the Wallpaper setup. * `watchMigration` - Skips the screen for watch migration. * `welcome` - Skips the Get Started pane. * `additionalPrivacySettings` - Skips the Additional Privacy Settings pane. * `multitasking` - Skips the Multitasking pane. * `osShowcase` - Skips the OS Showcase pane. * `webContentFiltering` - Skips the Web Content Filtering pane. * `safetyAndHandling` - Skips the Safety and Handling pane. - [EncryptedDepServerToken ]: The S/MIME encoded DEP Server Token returned by Apple Business Manager when creating an MDM instance. - [IoDefaultDeviceGroupObjectIds >]: An array of ObjectIDs identifying the default device groups for this specific type (based on the OS family) of automated device enrollment. Currently, only a single DeviceGroupID is supported. - [IoEnableZeroTouchEnrollment ]: A toggle to determine if ADE registered devices should go through JumpCloud Zero Touch Enrollment. - [IoSetupAssistantOptions >]: A Setup Option wrapped as an object - [IoSetupOptions >]: A list of configured setup options for this enrollment. - [IosWelcomeScreenButton ]: Text to display on the button on the DEP Welcome Screen. - [IosWelcomeScreenParagraph ]: A message to display on the DEP Welcome Screen. - [IosWelcomeScreenTitle ]: The title to display on the DEP Welcome Screen. - [MacoDefaultDeviceGroupObjectIds >]: An array of ObjectIDs identifying the default device groups for this specific type (based on the OS family) of automated device enrollment. Currently, only a single DeviceGroupID is supported. - [MacoEnableZeroTouchEnrollment ]: A toggle to determine if ADE registered devices should go through JumpCloud Zero Touch Enrollment. - [MacoSetupAssistantOptions >]: A Setup Option wrapped as an object - [MacoSetupOptions >]: A list of configured setup options for this enrollment. - [MacosWelcomeScreenButton ]: Text to display on the button on the DEP Welcome Screen. - [MacosWelcomeScreenParagraph ]: A message to display on the DEP Welcome Screen. - [MacosWelcomeScreenTitle ]: The title to display on the DEP Welcome Screen. - [Name ]: A new name for the Apple MDM configuration. - [WelcomeScreenButton ]: Text to display on the button on the DEP Welcome Screen. - [WelcomeScreenParagraph ]: A message to display on the DEP Welcome Screen. - [WelcomeScreenTitle ]: The title to display on the DEP Welcome Screen. - -DEPSETUPASSISTANTOPTIONS : - [Option ]: Options to skip screens during MacOS and iOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `actionButton` - Skips the Action Button configuration pane. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `cameraButton` - Skips the Camera Button configuration pane. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `enableLockdownMode` - Skips the Lockdown Mode pane. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `intelligence` - Skips the Intelligence pane. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `termsOfAddress` - Skips the Terms of Address pane. * `tos` - Skips terms and conditions. * `appStore` - Skips the App Store pane. * `deviceToDeviceMigration` - Skips Device to Device Migration pane. * `displayZoom` - Skips zoom setup. * `homeButton` - Skips the Meet the New Home Button screen on iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus and iPhone SE. * `imessageAndFacetime` - Skips the iMessage and FaceTime screen in iOS. * `messagingActivationUsingPhoneNumber` - Skips the iMessage pane. * `moveFromAndroid` - If the Restore pane is not skipped, removes the Move from Android option in the Restore pane on iOS.O * `passcode` - Hides and disables the passcode pane. * `restoreComplete` - Skips the Restore Completed pane. * `safety` - Skips the Safety pane. * `setupCellular` - Skips the add cellular plan pane. * `softwareUpdate` - Skips the mandatory software update screen in iOS. * `unlockWithWatch` - Skips Unlock Your Mac with your Apple Watch pane. * `updateComplete` - Skips the Software Update Complete pane. * `wallpaper` - Skips the Wallpaper setup. * `watchMigration` - Skips the screen for watch migration. * `welcome` - Skips the Get Started pane. * `additionalPrivacySettings` - Skips the Additional Privacy Settings pane. * `multitasking` - Skips the Multitasking pane. * `osShowcase` - Skips the OS Showcase pane. * `webContentFiltering` - Skips the Web Content Filtering pane. * `safetyAndHandling` - Skips the Safety and Handling pane. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: - -IOSETUPASSISTANTOPTIONS : - [Option ]: Options to skip screens during MacOS and iOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `actionButton` - Skips the Action Button configuration pane. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `cameraButton` - Skips the Camera Button configuration pane. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `enableLockdownMode` - Skips the Lockdown Mode pane. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `intelligence` - Skips the Intelligence pane. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `termsOfAddress` - Skips the Terms of Address pane. * `tos` - Skips terms and conditions. * `appStore` - Skips the App Store pane. * `deviceToDeviceMigration` - Skips Device to Device Migration pane. * `displayZoom` - Skips zoom setup. * `homeButton` - Skips the Meet the New Home Button screen on iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus and iPhone SE. * `imessageAndFacetime` - Skips the iMessage and FaceTime screen in iOS. * `messagingActivationUsingPhoneNumber` - Skips the iMessage pane. * `moveFromAndroid` - If the Restore pane is not skipped, removes the Move from Android option in the Restore pane on iOS.O * `passcode` - Hides and disables the passcode pane. * `restoreComplete` - Skips the Restore Completed pane. * `safety` - Skips the Safety pane. * `setupCellular` - Skips the add cellular plan pane. * `softwareUpdate` - Skips the mandatory software update screen in iOS. * `unlockWithWatch` - Skips Unlock Your Mac with your Apple Watch pane. * `updateComplete` - Skips the Software Update Complete pane. * `wallpaper` - Skips the Wallpaper setup. * `watchMigration` - Skips the screen for watch migration. * `welcome` - Skips the Get Started pane. * `additionalPrivacySettings` - Skips the Additional Privacy Settings pane. * `multitasking` - Skips the Multitasking pane. * `osShowcase` - Skips the OS Showcase pane. * `webContentFiltering` - Skips the Web Content Filtering pane. * `safetyAndHandling` - Skips the Safety and Handling pane. - -MACOSETUPASSISTANTOPTIONS : - [Option ]: Options to skip screens during MacOS and iOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `actionButton` - Skips the Action Button configuration pane. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `cameraButton` - Skips the Camera Button configuration pane. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `enableLockdownMode` - Skips the Lockdown Mode pane. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `intelligence` - Skips the Intelligence pane. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `termsOfAddress` - Skips the Terms of Address pane. * `tos` - Skips terms and conditions. * `appStore` - Skips the App Store pane. * `deviceToDeviceMigration` - Skips Device to Device Migration pane. * `displayZoom` - Skips zoom setup. * `homeButton` - Skips the Meet the New Home Button screen on iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus and iPhone SE. * `imessageAndFacetime` - Skips the iMessage and FaceTime screen in iOS. * `messagingActivationUsingPhoneNumber` - Skips the iMessage pane. * `moveFromAndroid` - If the Restore pane is not skipped, removes the Move from Android option in the Restore pane on iOS.O * `passcode` - Hides and disables the passcode pane. * `restoreComplete` - Skips the Restore Completed pane. * `safety` - Skips the Safety pane. * `setupCellular` - Skips the add cellular plan pane. * `softwareUpdate` - Skips the mandatory software update screen in iOS. * `unlockWithWatch` - Skips Unlock Your Mac with your Apple Watch pane. * `updateComplete` - Skips the Software Update Complete pane. * `wallpaper` - Skips the Wallpaper setup. * `watchMigration` - Skips the screen for watch migration. * `welcome` - Skips the Get Started pane. * `additionalPrivacySettings` - Skips the Additional Privacy Settings pane. * `multitasking` - Skips the Multitasking pane. * `osShowcase` - Skips the OS Showcase pane. * `webContentFiltering` - Skips the Web Content Filtering pane. * `safetyAndHandling` - Skips the Safety and Handling pane. -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAppleMdm.md -#> - Function Set-JcSdkAppleMdm +Function Set-JcSdkAppleMdm { [OutputType([JumpCloud.SDK.V2.Models.IAppleMdm])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -519,5 +314,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApplicationAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApplicationAssociation.ps1 index a3adafcd3..b058a2830 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApplicationAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApplicationAssociation.ps1 @@ -1,92 +1,4 @@ -<# -.Synopsis -This endpoint allows you to manage the _direct_ associations of an Application. -A direct association can be a non-homogeneous relationship between 2 different objects, for example Application and User Groups. - -#### Sample Request -``` -curl -X POST 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations' \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user_group\", - \"id\": \"{Group_ID}\" - }' -``` -.Description -This endpoint allows you to manage the _direct_ associations of an Application. -A direct association can be a non-homogeneous relationship between 2 different objects, for example Application and User Groups. - -#### Sample Request -``` -curl -X POST 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations' \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user_group\", - \"id\": \"{Group_ID}\" - }' -``` -.Example -PS C:\> Set-JcSdkApplicationAssociation -ApplicationId:() -Body:() - - -.Example -PS C:\> Set-JcSdkApplicationAssociation -ApplicationId:() -Id:() -Op:() -Type:() -Attributes:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IGraphOperationApplicationAutoGenerated -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Id : The ObjectID of graph object being added or removed as an association. - Op : How to modify the graph connection. - Type : Targets which a "application" can be associated to. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApplicationAssociation.md -#> - Function Set-JcSdkApplicationAssociation +Function Set-JcSdkApplicationAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -247,5 +159,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApprovalFlow.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApprovalFlow.ps1 index 9a138da73..9309eeea4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApprovalFlow.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApprovalFlow.ps1 @@ -1,89 +1,4 @@ -<# -.Synopsis -Endpoint for updating a new access workflow -.Description -Endpoint for updating a new access workflow -.Example -PS C:\> Set-JcSdkApprovalFlow -ApprovalFlowId:() -ApprovalType:() -ApproverRequirement:() -ApproverResources:() -Description:() -FixedDuration:() -IconColor:() -IconUrl:() -MultiSelectDuration:() -Name:() -NonAdminApproval:() -OrganizationObjectIdInputFile:() -ResourceId:() -SlackConfig:() -SlackEnabled:() -Status:() -TimeBasedAccess:() -TtlConfig:() -VisibleTo:() -.Example -PS C:\> Set-JcSdkApprovalFlow -ApprovalFlowId:() -Body:() - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.IPaths14Hfh8UApprovalflowsApprovalflowidPutRequestbodyContentApplicationJsonSchema -.Outputs -JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowResponse -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -APPROVERRESOURCES : - [RequireAll ]: - [ResourceId ]: - [ResourceName ]: - [ResourceOrder ]: - [ResourceType ]: - -BODY : - [ApprovalType ]: - [ApproverRequirement ]: - [ApproverResources >]: - [RequireAll ]: - [ResourceId ]: - [ResourceName ]: - [ResourceOrder ]: - [ResourceType ]: - [Description ]: - [FixedDuration ]: - [IconColor ]: - [IconUrl ]: - [MultiSelectDuration >]: - [Name ]: - [NonAdminApproval ]: - [OrganizationObjectId ]: - [ResourceId ]: - [SlackConfig >]: - [SlackResourceId ]: - [SlackEnabled ]: - [Status ]: - [TimeBasedAccess ]: - [TtlConfig ]: - [VisibleTo >]: - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: - -SLACKCONFIG : - [SlackResourceId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlow.md -#> - Function Set-JcSdkApprovalFlow +Function Set-JcSdkApprovalFlow { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowResponse])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -338,5 +253,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApprovalFlowSetting.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApprovalFlowSetting.ps1 index a2825a8a5..27a9670ce 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApprovalFlowSetting.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApprovalFlowSetting.ps1 @@ -1,40 +1,4 @@ -<# -.Synopsis -Endpoint for updating a access workflow settings for an organization -.Description -Endpoint for updating a access workflow settings for an organization -.Example -PS C:\> Set-JcSdkApprovalFlowSetting -AdminApprovalEmail:() -ChannelEvents:() -ExposeApprovalProgress:() -OrganizationObjectIdInputFile:() -ResourceRequest:() -UserApprovalEmail:() -UserRequestEmail:() -.Example -PS C:\> Set-JcSdkApprovalFlowSetting -Body:() - -.Inputs -JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowSettingsRequest -.Outputs -JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowSettingsResponse -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [AdminApprovalEmail ]: - [ChannelEvents >]: - [ChannelObjectId ]: - [EventTypes >]: - [ExposeApprovalProgress ]: - [OrganizationObjectId ]: - [ResourceRequest ]: - [UserApprovalEmail ]: - [UserRequestEmail ]: - -CHANNELEVENTS : - [ChannelObjectId ]: - [EventTypes >]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlowSetting.md -#> - Function Set-JcSdkApprovalFlowSetting +Function Set-JcSdkApprovalFlowSetting { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowSettingsResponse])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -187,5 +151,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkCommandAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkCommandAssociation.ps1 index 040e76b77..81fd535ce 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkCommandAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkCommandAssociation.ps1 @@ -1,96 +1,4 @@ -<# -.Synopsis -This endpoint will allow you to manage the _direct_ associations of this Command. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. - - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system_group\", - \"id\": \"Group_ID\" - }' -``` -.Description -This endpoint will allow you to manage the _direct_ associations of this Command. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. - - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system_group\", - \"id\": \"Group_ID\" - }' -``` -.Example -PS C:\> Set-JcSdkCommandAssociation -CommandId:() -Body:() - - -.Example -PS C:\> Set-JcSdkCommandAssociation -CommandId:() -Id:() -Op:() -Type:() -Attributes:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IGraphOperationCommand -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Id : The ObjectID of graph object being added or removed as an association. - Op : How to modify the graph connection. - Type : Targets which a "command" can be associated to. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCommandAssociation.md -#> - Function Set-JcSdkCommandAssociation +Function Set-JcSdkCommandAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -251,5 +159,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkCustomEmailConfiguration.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkCustomEmailConfiguration.ps1 index 0df0d021a..9f6540a3d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkCustomEmailConfiguration.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkCustomEmailConfiguration.ps1 @@ -1,94 +1,4 @@ -<# -.Synopsis -Set the custom email configuration for the specified custom email type. - -This action is only available to paying customers. -.Description -Set the custom email configuration for the specified custom email type. - -This action is only available to paying customers. -.Example -PS C:\> Set-JcSdkCustomEmailConfiguration -CustomEmailType:() -CustomEmail:() - - - ----- ---------- -Body String -Button String -Header String -Id String -NextStepContactInfo String -Subject String -Title String -Type String - - -.Example -PS C:\> Set-JcSdkCustomEmailConfiguration -CustomEmailType:() -Subject:() -Type:() -Body:() -Button:() -Header:() -NextStepContactInfo:() -Title:() - - - ----- ---------- -Body String -Button String -Header String -Id String -NextStepContactInfo String -Subject String -Title String -Type String - - - -.Inputs -JumpCloud.SDK.V2.Models.ICustomEmail -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.ICustomEmail -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -CUSTOMEMAIL : - Subject : - Type : - [Body ]: - [Button ]: - [Header ]: - [NextStepContactInfo ]: - [Title ]: - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCustomEmailConfiguration.md -#> - Function Set-JcSdkCustomEmailConfiguration +Function Set-JcSdkCustomEmailConfiguration { [OutputType([JumpCloud.SDK.V2.Models.ICustomEmail])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -262,5 +172,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkDuoApplication.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkDuoApplication.ps1 index 7d25e1182..2d416aa93 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkDuoApplication.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkDuoApplication.ps1 @@ -1,107 +1,4 @@ -<# -.Synopsis -Set the specified Duo application. - -#### Sample Request -``` - curl -X PUT https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Application Name\", - \"apiHost\": \"api-1234.duosecurity.com\", - \"integrationKey\": \"1234\", - \"secretKey\": \"5678\" - }' -``` -.Description -Set the specified Duo application. - -#### Sample Request -``` - curl -X PUT https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Application Name\", - \"apiHost\": \"api-1234.duosecurity.com\", - \"integrationKey\": \"1234\", - \"secretKey\": \"5678\" - }' -``` -.Example -PS C:\> Set-JcSdkDuoApplication -AccountId:() -ApplicationId:() -Body:() - - - ----- ---------- -ApiHost String -Id String -IntegrationKey String -Name String - - -.Example -PS C:\> Set-JcSdkDuoApplication -AccountId:() -ApplicationId:() -ApiHost:() -IntegrationKey:() -Name:() -SecretKey:() - - - ----- ---------- -ApiHost String -Id String -IntegrationKey String -Name String - - - -.Inputs -JumpCloud.SDK.V2.Models.IDuoApplicationUpdateReq -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IDuoApplication -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - ApiHost : - IntegrationKey : - Name : - [SecretKey ]: - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkDuoApplication.md -#> - Function Set-JcSdkDuoApplication +Function Set-JcSdkDuoApplication { [OutputType([JumpCloud.SDK.V2.Models.IDuoApplication])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -261,5 +158,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkGSuiteAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkGSuiteAssociation.ps1 index bf65f5e2e..d717602d4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkGSuiteAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkGSuiteAssociation.ps1 @@ -1,96 +1,4 @@ -<# -.Synopsis -This endpoint returns the _direct_ associations of this G Suite instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user_group\", - \"id\": \"{Group_ID}\" - }' -``` -.Description -This endpoint returns the _direct_ associations of this G Suite instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user_group\", - \"id\": \"{Group_ID}\" - }' -``` -.Example -PS C:\> Set-JcSdkGSuiteAssociation -GsuiteId:() -Body:() - - -.Example -PS C:\> Set-JcSdkGSuiteAssociation -GsuiteId:() -Id:() -Op:() -Type:() -Attributes:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IGraphOperationGSuiteAutoGenerated -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Id : The ObjectID of graph object being added or removed as an association. - Op : How to modify the graph connection. - Type : Targets which a "g_suite" can be associated to. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkGSuiteAssociation.md -#> - Function Set-JcSdkGSuiteAssociation +Function Set-JcSdkGSuiteAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -251,5 +159,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkIPList.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkIPList.ps1 index f087b4b08..bab515f7d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkIPList.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkIPList.ps1 @@ -1,106 +1,4 @@ -<# -.Synopsis -Replace a specific IP list. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Sample IP List\", - \"ips\": [ - \"192.168.10.10\" - ] - }' -``` -.Description -Replace a specific IP list. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Sample IP List\", - \"ips\": [ - \"192.168.10.10\" - ] - }' -``` -.Example -PS C:\> Set-JcSdkIPList -Id:() -Body:() - - - ----- ---------- -Description String -Id String -Ips String -Name String - - -.Example -PS C:\> Set-JcSdkIPList -Id:() -Description:() -Ips:() -Name:() - - - ----- ---------- -Description String -Id String -Ips String -Name String - - - -.Inputs -JumpCloud.SDK.V2.Models.IIPListRequest -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IIPList -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [Description ]: - [Ips >]: - [Name ]: - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkIPList.md -#> - Function Set-JcSdkIPList +Function Set-JcSdkIPList { [OutputType([JumpCloud.SDK.V2.Models.IIPList])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -247,5 +145,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkLdapServerAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkLdapServerAssociation.ps1 index 0d07d0982..8c77fc273 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkLdapServerAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkLdapServerAssociation.ps1 @@ -1,94 +1,4 @@ -<# -.Synopsis -This endpoint allows you to manage the _direct_ associations of a LDAP Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{User_ID}\" - }' -``` -.Description -This endpoint allows you to manage the _direct_ associations of a LDAP Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{User_ID}\" - }' -``` -.Example -PS C:\> Set-JcSdkLdapServerAssociation -LdapserverId:() -Body:() - - -.Example -PS C:\> Set-JcSdkLdapServerAssociation -LdapserverId:() -Id:() -Op:() -Type:() -Attributes:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IGraphOperationLdapServerAutoGenerated -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Id : The ObjectID of graph object being added or removed as an association. - Op : How to modify the graph connection. - Type : Targets which a "ldap_server" can be associated to. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerAssociation.md -#> - Function Set-JcSdkLdapServerAssociation +Function Set-JcSdkLdapServerAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -249,5 +159,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkLdapServerSambaDomain.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkLdapServerSambaDomain.ps1 index 2ce466ec2..5c07d4786 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkLdapServerSambaDomain.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkLdapServerSambaDomain.ps1 @@ -1,99 +1,4 @@ -<# -.Synopsis -This endpoint allows you to set the samba domain information for an LDAP server. - -##### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"sid\":\"{SID_ID}\", - \"name\":\"{WORKGROUP_NAME}\" - }' -``` -.Description -This endpoint allows you to set the samba domain information for an LDAP server. - -##### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"sid\":\"{SID_ID}\", - \"name\":\"{WORKGROUP_NAME}\" - }' -``` -.Example -PS C:\> Set-JcSdkLdapServerSambaDomain -Id:() -LdapserverId:() -Body:() - - - ----- ---------- -Id String -Name String -Sid String - - -.Example -PS C:\> Set-JcSdkLdapServerSambaDomain -Id:() -LdapserverId:() -Name:() -Sid:() - - - ----- ---------- -Id String -Name String -Sid String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.ISambaDomain -.Outputs -JumpCloud.SDK.V2.Models.ISambaDomain -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Name : Name of this domain's WorkGroup - Sid : Security identifier of this domain - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerSambaDomain.md -#> - Function Set-JcSdkLdapServerSambaDomain +Function Set-JcSdkLdapServerSambaDomain { [OutputType([JumpCloud.SDK.V2.Models.ISambaDomain])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -239,5 +144,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkOffice365Association.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkOffice365Association.ps1 index 755ad9b37..8533372f8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkOffice365Association.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkOffice365Association.ps1 @@ -1,94 +1,4 @@ -<# -.Synopsis -This endpoint allows you to manage the _direct_ associations of a Office 365 instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user_group\", - \"id\": \"{Group_ID}\" - }' -``` -.Description -This endpoint allows you to manage the _direct_ associations of a Office 365 instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user_group\", - \"id\": \"{Group_ID}\" - }' -``` -.Example -PS C:\> Set-JcSdkOffice365Association -Office365Id:() -Body:() - - -.Example -PS C:\> Set-JcSdkOffice365Association -Office365Id:() -Id:() -Op:() -Type:() -Attributes:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IGraphOperationOffice365AutoGenerated -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Id : The ObjectID of graph object being added or removed as an association. - Op : How to modify the graph connection. - Type : Targets which a "office_365" can be associated to. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkOffice365Association.md -#> - Function Set-JcSdkOffice365Association +Function Set-JcSdkOffice365Association { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -249,5 +159,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicy.ps1 index e0f57cffa..175179e98 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicy.ps1 @@ -1,132 +1,4 @@ -<# -.Synopsis -This endpoint allows you to set a policy. -Given the amount of configurable parameters required to set a Policy, we suggest you use the JumpCloud Admin Console to set new policies. - - -##### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/policies/59fced45c9118022172547ff \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Policy_Parameters} - }' -``` -.Description -This endpoint allows you to set a policy. -Given the amount of configurable parameters required to set a Policy, we suggest you use the JumpCloud Admin Console to set new policies. - - -##### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/policies/59fced45c9118022172547ff \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Policy_Parameters} - }' -``` -.Example -PS C:\> Set-JcSdkPolicy -Id:() -Body:() - - - ----- ---------- -Id String -Name String -TemplateActivation String -TemplateAlert String -TemplateBehavior String -TemplateDeliveryTypes String -TemplateDescription String -TemplateDisplayName String -TemplateId String -TemplateName String -TemplateOSMetaFamily String -TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] -TemplateReference String -TemplateState String - - -.Example -PS C:\> Set-JcSdkPolicy -Id:() -Name:() -Notes:() -Values:() - - - ----- ---------- -Id String -Name String -TemplateActivation String -TemplateAlert String -TemplateBehavior String -TemplateDeliveryTypes String -TemplateDescription String -TemplateDisplayName String -TemplateId String -TemplateName String -TemplateOSMetaFamily String -TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] -TemplateReference String -TemplateState String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.IPolicyUpdateRequest -.Outputs -JumpCloud.SDK.V2.Models.IPolicy -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Name : The description for this specific Policy. - [Notes ]: The notes for this specific Policy. - [Values >]: - [ConfigFieldId ]: The ObjectId of the corresponding Policy Template configuration field. - [Sensitive ]: Defines if the value is sensitive or not. - [Value ]: The value for the configuration field for this Policy instance. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: - -VALUES : - [ConfigFieldId ]: The ObjectId of the corresponding Policy Template configuration field. - [Sensitive ]: Defines if the value is sensitive or not. - [Value ]: The value for the configuration field for this Policy instance. -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicy.md -#> - Function Set-JcSdkPolicy +Function Set-JcSdkPolicy { [OutputType([JumpCloud.SDK.V2.Models.IPolicy])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -273,5 +145,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyAssociation.ps1 index 049dc6333..a17efe2c1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyAssociation.ps1 @@ -1,94 +1,4 @@ -<# -.Synopsis -This endpoint allows you to manage the _direct_ associations of a Policy. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations/ \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system_group\", - \"id\": \"{Group_ID}\" - }' -``` -.Description -This endpoint allows you to manage the _direct_ associations of a Policy. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations/ \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system_group\", - \"id\": \"{Group_ID}\" - }' -``` -.Example -PS C:\> Set-JcSdkPolicyAssociation -PolicyId:() -Body:() - - -.Example -PS C:\> Set-JcSdkPolicyAssociation -PolicyId:() -Id:() -Op:() -Type:() -Attributes:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IGraphOperationPolicy -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Id : The ObjectID of graph object being added or removed as an association. - Op : How to modify the graph connection. - Type : Targets which a "policy" can be associated to. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyAssociation.md -#> - Function Set-JcSdkPolicyAssociation +Function Set-JcSdkPolicyAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -249,5 +159,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroup.ps1 index 87fe247ae..77566cb75 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroup.ps1 @@ -1,102 +1,4 @@ -<# -.Synopsis -This endpoint allows you to do a full set of the Policy Group. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/policygroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"group_set - }' -``` -.Description -This endpoint allows you to do a full set of the Policy Group. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/policygroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"group_set - }' -``` -.Example -PS C:\> Set-JcSdkPolicyGroup -Id:() -Body:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -Name String -Type String - - -.Example -PS C:\> Set-JcSdkPolicyGroup -Id:() -Name:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -Name String -Type String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.IPolicyGroupData -.Outputs -JumpCloud.SDK.V2.Models.IPolicyGroup -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Name : Display name of a Policy Group. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroup.md -#> - Function Set-JcSdkPolicyGroup +Function Set-JcSdkPolicyGroup { [OutputType([JumpCloud.SDK.V2.Models.IPolicyGroup])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -228,5 +130,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroupAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroupAssociation.ps1 index 35c8ec98f..f2b81a220 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroupAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroupAssociation.ps1 @@ -1,96 +1,4 @@ -<# -.Synopsis -This endpoint manages the _direct_ associations of this Policy Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system\", - \"id\": \"{SystemID}\" - }' -``` -.Description -This endpoint manages the _direct_ associations of this Policy Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system\", - \"id\": \"{SystemID}\" - }' -``` -.Example -PS C:\> Set-JcSdkPolicyGroupAssociation -GroupId:() -Body:() - - -.Example -PS C:\> Set-JcSdkPolicyGroupAssociation -GroupId:() -Id:() -Op:() -Type:() -Attributes:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IGraphOperationPolicyGroup -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Id : The ObjectID of graph object being added or removed as an association. - Op : How to modify the graph connection. - Type : Targets which a "policy_group" can be associated to. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupAssociation.md -#> - Function Set-JcSdkPolicyGroupAssociation +Function Set-JcSdkPolicyGroupAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -251,5 +159,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroupMember.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroupMember.ps1 index 4fec94da5..57f076b11 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroupMember.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroupMember.ps1 @@ -1,89 +1,4 @@ -<# -.Synopsis -This endpoint allows you to manage the Policy members of a Policy Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"policy\", - \"id\": \"{Policy_ID}\" - }' -``` -.Description -This endpoint allows you to manage the Policy members of a Policy Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"policy\", - \"id\": \"{Policy_ID}\" - }' -``` -.Example -PS C:\> Set-JcSdkPolicyGroupMember -GroupId:() -Body:() - - -.Example -PS C:\> Set-JcSdkPolicyGroupMember -GroupId:() -Id:() -Op:() -Attributes:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IGraphOperationPolicyGroupMember -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Id : The ObjectID of graph object being added or removed as an association. - Op : How to modify the graph connection. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupMember.md -#> - Function Set-JcSdkPolicyGroupMember +Function Set-JcSdkPolicyGroupMember { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -236,5 +151,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkRadiusServerAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkRadiusServerAssociation.ps1 index 4ef82432c..636d500cf 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkRadiusServerAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkRadiusServerAssociation.ps1 @@ -1,98 +1,4 @@ -<# -.Synopsis -This endpoint allows you to manage the _direct_ associations of a Radius Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ -\t -\"type\":\"user\", -\"id\":\"{USER_ID}\", -\"op\":\"add\" -\t -}' -``` -.Description -This endpoint allows you to manage the _direct_ associations of a Radius Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ -\t -\"type\":\"user\", -\"id\":\"{USER_ID}\", -\"op\":\"add\" -\t -}' -``` -.Example -PS C:\> Set-JcSdkRadiusServerAssociation -RadiusserverId:() -Body:() - - -.Example -PS C:\> Set-JcSdkRadiusServerAssociation -RadiusserverId:() -Id:() -Op:() -Type:() -Attributes:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IGraphOperationRadiusServerAutoGenerated -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Id : The ObjectID of graph object being added or removed as an association. - Op : How to modify the graph connection. - Type : Targets which a "radius_server" can be associated to. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkRadiusServerAssociation.md -#> - Function Set-JcSdkRadiusServerAssociation +Function Set-JcSdkRadiusServerAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -253,5 +159,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSoftwareApp.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSoftwareApp.ps1 index fb4fe63c7..440564e1a 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSoftwareApp.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSoftwareApp.ps1 @@ -1,350 +1,4 @@ -<# -.Synopsis -This endpoint set a specific Software Application configuration for the organization. -displayName can be changed alone if no settings are provided. -If a setting is provided, it should include all its information since this endpoint will set all the settings' fields. -The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. - -#### Sample Request - displayName only -``` - curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"displayName\": \"My Software App\" - }' -``` - -#### Sample Request - all attributes -``` - curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"displayName\": \"My Software App\", - \"settings\": [ - { - \"packageId\": \"123456\", - \"autoset : false, - \"allowUpdateDelay\": false, - \"packageManager\": \"APPLE_VPP\", - \"locationObjectId\": \"123456789012123456789012\", - \"location\": \"123456\", - \"desiredState\": \"Install\", - \"appleVpp\": { - \"appConfiguration\": \"MyKeyMy String\", - \"assignedLicenses\": 20, - \"availableLicenses\": 10, - \"details\": {}, - \"isConfigEnabled\": true, - \"supportedDeviceFamilies\": [ - \"IPAD\", - \"MAC\" - ], - \"totalLicenses\": 30 - }, - \"packageSubtitle\": \"My package subtitle\", - \"packageVersion\": \"1.2.3\", - \"packageKind\": \"software-package\", - \"assetKind\": \"software\", - \"assetSha256Size\": 256, - \"assetSha256Strings\": [ - \"a123b123c123d123\" - ], - \"description\": \"My app description\" - } - ] - }' -``` -.Description -This endpoint set a specific Software Application configuration for the organization. -displayName can be changed alone if no settings are provided. -If a setting is provided, it should include all its information since this endpoint will set all the settings' fields. -The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. - -#### Sample Request - displayName only -``` - curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"displayName\": \"My Software App\" - }' -``` - -#### Sample Request - all attributes -``` - curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"displayName\": \"My Software App\", - \"settings\": [ - { - \"packageId\": \"123456\", - \"autoset : false, - \"allowUpdateDelay\": false, - \"packageManager\": \"APPLE_VPP\", - \"locationObjectId\": \"123456789012123456789012\", - \"location\": \"123456\", - \"desiredState\": \"Install\", - \"appleVpp\": { - \"appConfiguration\": \"MyKeyMy String\", - \"assignedLicenses\": 20, - \"availableLicenses\": 10, - \"details\": {}, - \"isConfigEnabled\": true, - \"supportedDeviceFamilies\": [ - \"IPAD\", - \"MAC\" - ], - \"totalLicenses\": 30 - }, - \"packageSubtitle\": \"My package subtitle\", - \"packageVersion\": \"1.2.3\", - \"packageKind\": \"software-package\", - \"assetKind\": \"software\", - \"assetSha256Size\": 256, - \"assetSha256Strings\": [ - \"a123b123c123d123\" - ], - \"description\": \"My app description\" - } - ] - }' -``` -.Example -PS C:\> Set-JcSdkSoftwareApp -Id:() -Body:() - - - ----- ---------- -DisplayName String -Id String -Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] - - -.Example -PS C:\> Set-JcSdkSoftwareApp -Id:() -DisplayName:() -Id1:() -Settings:() - - - ----- ---------- -DisplayName String -Id String -Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.ISoftwareApp -.Outputs -JumpCloud.SDK.V2.Models.ISoftwareApp -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [CreatedAt ]: - [DisplayName ]: - [Id ]: - [Settings >]: - [AllowUpdateDelay ]: - [AppCatalogInstallableObjectId ]: ID of the app catalog installable that created this app. - [AppFileName ]: - [AppleVppAppConfiguration ]: Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'. - [AppleVppAssignedLicenses ]: - [AppleVppAvailableLicenses ]: - [AppleVppDetails ]: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. - [(Any) ]: This indicates any property can be added to this object. - [AppleVppIsConfigEnabled ]: Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''. - [AppleVppSupportedDeviceFamilies >]: The supported device families for this VPP Application. - [AppleVppTotalLicenses ]: - [Architectures >]: - [AssetKind ]: The manifest asset kind (ex: software). - [AssetSha256Size ]: The incremental size to use for summing the package as it is downloaded. - [AssetSha256Strings >]: The array of checksums, one each for the hash size up to the total size of the package. - [AutoUpdate ]: - [BundleId ]: - [CommandLineArguments ]: Command line arguments to use with the application. - [CreatedAt ]: - [Description ]: The software app description. - [DesiredState ]: State of Install or Uninstall - [DownloadUrl ]: - [EnterpriseObjectId ]: ID of the Enterprise with which this app is associated - [Format ]: - [GoogleAndroidAppPricing ]: Whether this app is free, free with in-app purchases, or paid. - [GoogleAndroidAppVersion ]: Latest version currently available for this app. - [GoogleAndroidAuthor ]: The name of the author of this app. - [GoogleAndroidAutoUpdateMode ]: Controls the auto-update mode for the app. - [GoogleAndroidCategory ]: The app category (e.g. COMMUNICATION, SOCIAL, etc.). - [GoogleAndroidContentRating ]: The content rating for this app. - [GoogleAndroidDisplayMode ]: The display mode of the web app. - [GoogleAndroidDistributionChannel ]: How and to whom the package is made available. - [GoogleAndroidFeatures >]: The array of android features for the app. - [GoogleAndroidFullDescription ]: Full app description, if available. - [GoogleAndroidIconUrl ]: A link to an image that can be used as an icon for the app. - [GoogleAndroidInstallType ]: The type of installation to perform for an app. - [GoogleAndroidManagedConfigurationTemplateId ]: The managed configurations template for the app. - [GoogleAndroidManagedProperties ]: Indicates whether this app has managed properties or not. - [GoogleAndroidMinSdkVersion ]: The minimum Android SDK necessary to run the app. - [GoogleAndroidName ]: The name of the app in the form enterprises/{enterprise}/applications/{packageName}. - [GoogleAndroidPermissionGrants >]: - [Id ]: An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR. - [Policy ]: The policy for granting the permission. - [GoogleAndroidRuntimePermission ]: The policy for granting permission requests to apps. - [GoogleAndroidStartUrl ]: The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps. - [GoogleAndroidType ]: Type of this android application. - [GoogleAndroidUpdateTime ]: The approximate time (within 7 days) the app was last published. - [GoogleAndroidVersionCode ]: The current version of the web app. - [IconUrl ]: URL to the icon for the app. - [Location ]: Repository where the app is located within the package manager - [LocationObjectId ]: ID of the repository where the app is located within the package manager - [MicrosoftStoreDoNotUpdate ]: Indicates whether the app can be updated or not. - [MicrosoftStoreNonRemovable ]: Indicates whether the app is removable by the users or not. - [MicrosoftStorePackageFamilyName ]: Package Family Name for the app from Microsoft App Store. - [ObjectId ]: - [PackageId ]: - [PackageKind ]: The package manifest kind (ex: software-package). - [PackageManager ]: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. - [PackageSubtitle ]: The package manifest subtitle. - [PackageVersion ]: The package manifest version. - [PackageVersionUpdatedAt ]: - [Scope ]: The installation scope of the software app. - [ShortVersion ]: - [StoredPackageObjectId ]: ID of the stored package this app uses to reference the stored install media. - [StoredPackageVersions >]: - [Metadata ]: Dictionary of - [(Any) ]: This indicates any property can be added to this object. - [Name ]: - [RejectedReason ]: - [Sha256Sum ]: - [Size ]: - [Status ]: - [Version ]: - [TeamId ]: - [UpdateTool ]: - [UpdateToolArguments ]: - [UpdatedAt ]: - [VersionlessDownloadUrl ]: - [UpdatedAt ]: - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: - -SETTINGS : - [AllowUpdateDelay ]: - [AppCatalogInstallableObjectId ]: ID of the app catalog installable that created this app. - [AppFileName ]: - [AppleVppAppConfiguration ]: Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'. - [AppleVppAssignedLicenses ]: - [AppleVppAvailableLicenses ]: - [AppleVppDetails ]: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. - [(Any) ]: This indicates any property can be added to this object. - [AppleVppIsConfigEnabled ]: Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''. - [AppleVppSupportedDeviceFamilies >]: The supported device families for this VPP Application. - [AppleVppTotalLicenses ]: - [Architectures >]: - [AssetKind ]: The manifest asset kind (ex: software). - [AssetSha256Size ]: The incremental size to use for summing the package as it is downloaded. - [AssetSha256Strings >]: The array of checksums, one each for the hash size up to the total size of the package. - [AutoUpdate ]: - [BundleId ]: - [CommandLineArguments ]: Command line arguments to use with the application. - [CreatedAt ]: - [Description ]: The software app description. - [DesiredState ]: State of Install or Uninstall - [DownloadUrl ]: - [EnterpriseObjectId ]: ID of the Enterprise with which this app is associated - [Format ]: - [GoogleAndroidAppPricing ]: Whether this app is free, free with in-app purchases, or paid. - [GoogleAndroidAppVersion ]: Latest version currently available for this app. - [GoogleAndroidAuthor ]: The name of the author of this app. - [GoogleAndroidAutoUpdateMode ]: Controls the auto-update mode for the app. - [GoogleAndroidCategory ]: The app category (e.g. COMMUNICATION, SOCIAL, etc.). - [GoogleAndroidContentRating ]: The content rating for this app. - [GoogleAndroidDisplayMode ]: The display mode of the web app. - [GoogleAndroidDistributionChannel ]: How and to whom the package is made available. - [GoogleAndroidFeatures >]: The array of android features for the app. - [GoogleAndroidFullDescription ]: Full app description, if available. - [GoogleAndroidIconUrl ]: A link to an image that can be used as an icon for the app. - [GoogleAndroidInstallType ]: The type of installation to perform for an app. - [GoogleAndroidManagedConfigurationTemplateId ]: The managed configurations template for the app. - [GoogleAndroidManagedProperties ]: Indicates whether this app has managed properties or not. - [GoogleAndroidMinSdkVersion ]: The minimum Android SDK necessary to run the app. - [GoogleAndroidName ]: The name of the app in the form enterprises/{enterprise}/applications/{packageName}. - [GoogleAndroidPermissionGrants >]: - [Id ]: An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR. - [Policy ]: The policy for granting the permission. - [GoogleAndroidRuntimePermission ]: The policy for granting permission requests to apps. - [GoogleAndroidStartUrl ]: The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps. - [GoogleAndroidType ]: Type of this android application. - [GoogleAndroidUpdateTime ]: The approximate time (within 7 days) the app was last published. - [GoogleAndroidVersionCode ]: The current version of the web app. - [IconUrl ]: URL to the icon for the app. - [Location ]: Repository where the app is located within the package manager - [LocationObjectId ]: ID of the repository where the app is located within the package manager - [MicrosoftStoreDoNotUpdate ]: Indicates whether the app can be updated or not. - [MicrosoftStoreNonRemovable ]: Indicates whether the app is removable by the users or not. - [MicrosoftStorePackageFamilyName ]: Package Family Name for the app from Microsoft App Store. - [ObjectId ]: - [PackageId ]: - [PackageKind ]: The package manifest kind (ex: software-package). - [PackageManager ]: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. - [PackageSubtitle ]: The package manifest subtitle. - [PackageVersion ]: The package manifest version. - [PackageVersionUpdatedAt ]: - [Scope ]: The installation scope of the software app. - [ShortVersion ]: - [StoredPackageObjectId ]: ID of the stored package this app uses to reference the stored install media. - [StoredPackageVersions >]: - [Metadata ]: Dictionary of - [(Any) ]: This indicates any property can be added to this object. - [Name ]: - [RejectedReason ]: - [Sha256Sum ]: - [Size ]: - [Status ]: - [Version ]: - [TeamId ]: - [UpdateTool ]: - [UpdateToolArguments ]: - [UpdatedAt ]: - [VersionlessDownloadUrl ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareApp.md -#> - Function Set-JcSdkSoftwareApp +Function Set-JcSdkSoftwareApp { [OutputType([JumpCloud.SDK.V2.Models.ISoftwareApp])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -505,5 +159,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSoftwareAppAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSoftwareAppAssociation.ps1 index 33014f363..f4d291c29 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSoftwareAppAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSoftwareAppAssociation.ps1 @@ -1,90 +1,4 @@ -<# -.Synopsis -This endpoint allows you to associate or disassociate a software application to a system or system group. - -#### Sample Request -``` -$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '{ - \"id\": \"\", - \"op\": \"add\", - \"type\": \"system\" - }' -``` -.Description -This endpoint allows you to associate or disassociate a software application to a system or system group. - -#### Sample Request -``` -$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '{ - \"id\": \"\", - \"op\": \"add\", - \"type\": \"system\" - }' -``` -.Example -PS C:\> Set-JcSdkSoftwareAppAssociation -SoftwareAppId:() -Body:() - - -.Example -PS C:\> Set-JcSdkSoftwareAppAssociation -SoftwareAppId:() -Id:() -Op:() -Type:() -Attributes:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IGraphOperationSoftwareApp -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Id : The ObjectID of graph object being added or removed as an association. - Op : How to modify the graph connection. - Type : Targets which a "software_app" can be associated to. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareAppAssociation.md -#> - Function Set-JcSdkSoftwareAppAssociation +Function Set-JcSdkSoftwareAppAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -245,5 +159,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemAssociation.ps1 index d0ecb41a9..73941bc9c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemAssociation.ps1 @@ -1,110 +1,4 @@ -<# -.Synopsis -This endpoint allows you to manage the _direct_ associations of a System. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"attributes\": { - \"sudo\": { - \"enabled\": true, - \"withoutPassword\": false - } - }, - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"UserID\" - }' -``` -.Description -This endpoint allows you to manage the _direct_ associations of a System. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"attributes\": { - \"sudo\": { - \"enabled\": true, - \"withoutPassword\": false - } - }, - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"UserID\" - }' -``` -.Example -PS C:\> Set-JcSdkSystemAssociation -SystemId:() -Body:() - - -.Example -PS C:\> Set-JcSdkSystemAssociation -SystemId:() -Id:() -Op:() -Type:() -Attributes:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IGraphOperationSystem -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Id : The ObjectID of graph object being added or removed as an association. - Op : How to modify the graph connection. - Type : Targets which a "system" can be associated to. - [Attributes ]: - [(Any) ]: This indicates any property can be added to this object. - [SudoEnabled ]: Enables sudo - [SudoWithoutPassword ]: Enable sudo without password (requires 'enabled' to be true) - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemAssociation.md -#> - Function Set-JcSdkSystemAssociation +Function Set-JcSdkSystemAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -277,5 +171,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroup.ps1 index 16010e76d..7ccd9c4ec 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroup.ps1 @@ -1,135 +1,4 @@ -<# -.Synopsis -This endpoint allows you to do a full set of the System Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Name_set - }' -``` -.Description -This endpoint allows you to do a full set of the System Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Name_set - }' -``` -.Example -PS C:\> Set-JcSdkSystemGroup -Id:() -Body:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -Type String - - -.Example -PS C:\> Set-JcSdkSystemGroup -Id:() -Name:() -Attributes:() -Description:() -Email:() -MemberQueryExemptions:() -MemberQueryFilters:() -MemberQueryType:() -MemberSuggestionsNotify:() -MembershipMethod:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -Type String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.ISystemGroupPut -.Outputs -JumpCloud.SDK.V2.Models.ISystemGroup -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Name : Display name of a System Group. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - [Description ]: Description of a System Group - [Email ]: Email address of a System Group - [MemberQueryExemptions >]: Array of GraphObjects exempted from the query - Id : The ObjectID of the graph object. - Type : The type of graph object. - [Attributes ]: The graph attributes. - [MemberQueryFilters >]: For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. - [MemberQuerySearchFilters ]: For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. - [MemberQueryType ]: - [MemberSuggestionsNotify ]: True if notification emails are to be sent for membership suggestions. - [MembershipMethod ]: The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED. Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices). Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: - -MEMBERQUERYEXEMPTIONS : - Id : The ObjectID of the graph object. - Type : The type of graph object. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroup.md -#> - Function Set-JcSdkSystemGroup +Function Set-JcSdkSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.ISystemGroup])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -328,5 +197,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroupAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroupAssociation.ps1 index 208cf2072..65939f829 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroupAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroupAssociation.ps1 @@ -1,96 +1,4 @@ -<# -.Synopsis -This endpoint allows you to manage the _direct_ associations of a System Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{UserID}\" - }' -``` -.Description -This endpoint allows you to manage the _direct_ associations of a System Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{UserID}\" - }' -``` -.Example -PS C:\> Set-JcSdkSystemGroupAssociation -GroupId:() -Body:() - - -.Example -PS C:\> Set-JcSdkSystemGroupAssociation -GroupId:() -Id:() -Op:() -Type:() -Attributes:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IGraphOperationSystemGroup -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Id : The ObjectID of graph object being added or removed as an association. - Op : How to modify the graph connection. - Type : Targets which a "system_group" can be associated to. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupAssociation.md -#> - Function Set-JcSdkSystemGroupAssociation +Function Set-JcSdkSystemGroupAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -251,5 +159,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroupMember.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroupMember.ps1 index 883be300d..34d459498 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroupMember.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroupMember.ps1 @@ -1,89 +1,4 @@ -<# -.Synopsis -This endpoint allows you to manage the system members of a System Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system\", - \"id\": \"{System_ID}\" - }' -``` -.Description -This endpoint allows you to manage the system members of a System Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system\", - \"id\": \"{System_ID}\" - }' -``` -.Example -PS C:\> Set-JcSdkSystemGroupMember -GroupId:() -Body:() - - -.Example -PS C:\> Set-JcSdkSystemGroupMember -GroupId:() -Id:() -Op:() -Attributes:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IGraphOperationSystemGroupMember -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Id : The ObjectID of graph object being added or removed as an association. - Op : How to modify the graph connection. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupMember.md -#> - Function Set-JcSdkSystemGroupMember +Function Set-JcSdkSystemGroupMember { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -248,5 +163,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserAssociation.ps1 index e732dd6e9..93b307129 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserAssociation.ps1 @@ -1,110 +1,4 @@ -<# -.Synopsis -This endpoint allows you to manage the _direct_ associations of a User. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"attributes\": { - \"sudo\": { - \"enabled\": true, - \"withoutPassword\": false - } - }, - \"op\": \"add\", - \"type\": \"system_group\", - \"id\": \"{GroupID}\" - }' -``` -.Description -This endpoint allows you to manage the _direct_ associations of a User. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"attributes\": { - \"sudo\": { - \"enabled\": true, - \"withoutPassword\": false - } - }, - \"op\": \"add\", - \"type\": \"system_group\", - \"id\": \"{GroupID}\" - }' -``` -.Example -PS C:\> Set-JcSdkUserAssociation -UserId:() -Body:() - - -.Example -PS C:\> Set-JcSdkUserAssociation -UserId:() -Id:() -Op:() -Type:() -Attributes:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IGraphOperationUser -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Id : The ObjectID of graph object being added or removed as an association. - Op : How to modify the graph connection. - Type : Targets which a "user" can be associated to. - [Attributes ]: - [(Any) ]: This indicates any property can be added to this object. - [SudoEnabled ]: Enables sudo - [SudoWithoutPassword ]: Enable sudo without password (requires 'enabled' to be true) - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserAssociation.md -#> - Function Set-JcSdkUserAssociation +Function Set-JcSdkUserAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -265,5 +159,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroup.ps1 index 77ab8252b..6a5c61a38 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroup.ps1 @@ -1,153 +1,4 @@ -<# -.Synopsis -This endpoint allows you to do a full set of the User Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"group_set - }' -``` -.Description -This endpoint allows you to do a full set of the User Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"group_set - }' -``` -.Example -PS C:\> Set-JcSdkUserGroup -Id:() -Body:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -SuggestionCountAdd Int -SuggestionCountRemove Int -SuggestionCountTotal Int -Type String - - -.Example -PS C:\> Set-JcSdkUserGroup -Id:() -Name:() -Attributes:() -Description:() -Email:() -MemberQueryExemptions:() -MemberQueryFilters:() -MemberQueryType:() -MemberSuggestionsNotify:() -MembershipMethod:() - - - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -SuggestionCountAdd Int -SuggestionCountRemove Int -SuggestionCountTotal Int -Type String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.IUserGroupPut -.Outputs -JumpCloud.SDK.V2.Models.IUserGroup -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Name : Display name of a User Group. - [Attributes ]: The graph attributes for a UserGroup. - [(Any) ]: This indicates any property can be added to this object. - [SudoEnabled ]: Enables sudo - [SudoWithoutPassword ]: Enable sudo without password (requires 'enabled' to be true) - [LdapGroups >]: - [Name ]: - [PosixGroups >]: - Id : - Name : - [RadiusReply >]: - Name : - Value : - [SambaEnabled ]: - [Description ]: Description of a User Group - [Email ]: Email address of a User Group - [MemberQueryExemptions >]: Array of GraphObjects exempted from the query - Id : The ObjectID of the graph object. - Type : The type of graph object. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - [MemberQueryFilters >]: For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. - [MemberQuerySearchFilters ]: For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. - [MemberQueryType ]: - [MemberSuggestionsNotify ]: True if notification emails are to be sent for membership suggestions. - [MembershipMethod ]: The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED. Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices). Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: - -MEMBERQUERYEXEMPTIONS : - Id : The ObjectID of the graph object. - Type : The type of graph object. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroup.md -#> - Function Set-JcSdkUserGroup +Function Set-JcSdkUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IUserGroup])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -346,5 +197,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroupAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroupAssociation.ps1 index 6a95db108..511bd5c43 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroupAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroupAssociation.ps1 @@ -1,96 +1,4 @@ -<# -.Synopsis -This endpoint manages the _direct_ associations of this User Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system\", - \"id\": \"{SystemID}\" - }' -``` -.Description -This endpoint manages the _direct_ associations of this User Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system\", - \"id\": \"{SystemID}\" - }' -``` -.Example -PS C:\> Set-JcSdkUserGroupAssociation -GroupId:() -Body:() - - -.Example -PS C:\> Set-JcSdkUserGroupAssociation -GroupId:() -Id:() -Op:() -Type:() -Attributes:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IGraphOperationUserGroup -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Id : The ObjectID of graph object being added or removed as an association. - Op : How to modify the graph connection. - Type : Targets which a "user_group" can be associated to. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupAssociation.md -#> - Function Set-JcSdkUserGroupAssociation +Function Set-JcSdkUserGroupAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -251,5 +159,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroupMember.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroupMember.ps1 index 9e9679f84..18e3ea200 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroupMember.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroupMember.ps1 @@ -1,89 +1,4 @@ -<# -.Synopsis -This endpoint allows you to manage the user members of a User Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{User_ID}\" - }' -``` -.Description -This endpoint allows you to manage the user members of a User Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{User_ID}\" - }' -``` -.Example -PS C:\> Set-JcSdkUserGroupMember -GroupId:() -Body:() - - -.Example -PS C:\> Set-JcSdkUserGroupMember -GroupId:() -Id:() -Op:() -Attributes:() - - - -.Inputs -JumpCloud.SDK.V2.Models.IGraphOperationUserGroupMember -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - Id : The ObjectID of graph object being added or removed as an association. - Op : How to modify the graph connection. - [Attributes ]: The graph attributes. - [(Any) ]: This indicates any property can be added to this object. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupMember.md -#> - Function Set-JcSdkUserGroupMember +Function Set-JcSdkUserGroupMember { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -236,5 +151,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkWorkday.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkWorkday.ps1 index 28935afac..497ff4c65 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkWorkday.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkWorkday.ps1 @@ -1,117 +1,4 @@ -<# -.Synopsis -This endpoint allows you to set the name and Custom Report URL for a Workday Instance. - -Currently, the name can not be changed from the default of `Workday Import`. - -##### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/workdays/{WorkdayID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ -\t\"reportUrl\":\"{Report_URL}\", -\t\"name\":\"{Name}\" -}\t' -``` -.Description -This endpoint allows you to set the name and Custom Report URL for a Workday Instance. - -Currently, the name can not be changed from the default of `Workday Import`. - -##### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/workdays/{WorkdayID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ -\t\"reportUrl\":\"{Report_URL}\", -\t\"name\":\"{Name}\" -}\t' -``` -.Example -PS C:\> Set-JcSdkWorkday -Id:() -Body:() - - - ----- ---------- -BasicExpiry String -BasicIsValid Boolean -BasicMessage String -Id String -LastImport String -Name String -OauthExpiry String -OauthIsValid Boolean -OauthMessage String -ReportUrl String - - -.Example -PS C:\> Set-JcSdkWorkday -Id:() -Name:() -ReportUrl:() - - - ----- ---------- -BasicExpiry String -BasicIsValid Boolean -BasicMessage String -Id String -LastImport String -Name String -OauthExpiry String -OauthIsValid Boolean -OauthMessage String -ReportUrl String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.IWorkdayFields -.Outputs -JumpCloud.SDK.V2.Models.IWorkdayOutput -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [Name ]: - [ReportUrl ]: - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkWorkday.md -#> - Function Set-JcSdkWorkday +Function Set-JcSdkWorkday { [OutputType([JumpCloud.SDK.V2.Models.IWorkdayOutput])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -250,5 +137,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Stop-JcSdkAppleMdmDevice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Stop-JcSdkAppleMdmDevice.ps1 index c93c1d05c..38271e6fa 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Stop-JcSdkAppleMdmDevice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Stop-JcSdkAppleMdmDevice.ps1 @@ -1,73 +1,4 @@ -<# -.Synopsis -Shuts down a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/shutdown \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` -.Description -Shuts down a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/shutdown \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` -.Example -PS C:\> Stop-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Stop-JcSdkAppleMdmDevice.md -#> - Function Stop-JcSdkAppleMdmDevice +Function Stop-JcSdkAppleMdmDevice { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Stop', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -195,5 +126,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Sync-JcSdkAppleMdmDevice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Sync-JcSdkAppleMdmDevice.ps1 index 731e0a197..5fa03a80c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Sync-JcSdkAppleMdmDevice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Sync-JcSdkAppleMdmDevice.ps1 @@ -1,73 +1,4 @@ -<# -.Synopsis -Refreshes the list of devices that a JumpCloud admin has added to their virtual MDM in Apple Business Manager - ABM so that they can be DEP enrolled with JumpCloud. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/refreshdepdevices \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` -.Description -Refreshes the list of devices that a JumpCloud admin has added to their virtual MDM in Apple Business Manager - ABM so that they can be DEP enrolled with JumpCloud. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/refreshdepdevices \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` -.Example -PS C:\> Sync-JcSdkAppleMdmDevice -AppleMdmId:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Sync-JcSdkAppleMdmDevice.md -#> - Function Sync-JcSdkAppleMdmDevice +Function Sync-JcSdkAppleMdmDevice { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Sync', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -189,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkAppleMdmDeviceLockInformation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkAppleMdmDeviceLockInformation.ps1 index 72d96f854..aa9c40c9f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkAppleMdmDeviceLockInformation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkAppleMdmDeviceLockInformation.ps1 @@ -1,75 +1,4 @@ -<# -.Synopsis -Refreshes the activation lock information for a device - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/refreshActivationLockInformation \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` -.Description -Refreshes the activation lock information for a device - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/refreshActivationLockInformation \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` -.Example -PS C:\> Update-JcSdkAppleMdmDeviceLockInformation -AppleMdmId:() -DeviceId:() - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -System.Boolean -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAppleMdmDeviceLockInformation.md -#> - Function Update-JcSdkAppleMdmDeviceLockInformation +Function Update-JcSdkAppleMdmDeviceLockInformation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Refresh', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -197,5 +126,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkAuthenticationPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkAuthenticationPolicy.ps1 index 821e90221..046025dab 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkAuthenticationPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkAuthenticationPolicy.ps1 @@ -1,160 +1,4 @@ -<# -.Synopsis -Patch the specified authentication policy. - -#### Sample Request -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ \"disabled\": false }' -``` -.Description -Patch the specified authentication policy. - -#### Sample Request -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ \"disabled\": false }' -``` -.Example -PS C:\> Update-JcSdkAuthenticationPolicy -Id:() -Body:() - - - ----- ---------- -Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions -Description String -Disabled Boolean -EffectAction String -Id String -MfaRequired Boolean -Name String -TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] -Type String -UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserGroupExclusions String -UserGroupInclusions String -UserInclusions String -UserVerificationRequirement String - - -.Example -PS C:\> Update-JcSdkAuthenticationPolicy -Id:() -Conditions:() -Description:() -Disabled:() -EffectAction:() -MfaRequired:() -Name:() -TargetResources:() -Type:() -UserAttributeExclusions:() -UserAttributeInclusions:() -UserGroupExclusions:() -UserGroupInclusions:() -UserInclusions:() -UserVerificationRequirement:() - - - ----- ---------- -Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions -Description String -Disabled Boolean -EffectAction String -Id String -MfaRequired Boolean -Name String -TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] -Type String -UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserGroupExclusions String -UserGroupInclusions String -UserInclusions String -UserVerificationRequirement String - - - -.Inputs -JumpCloud.SDK.V2.Models.IAuthnPolicy -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IAuthnPolicy -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [Conditions ]: Dictionary of - [(Any) ]: This indicates any property can be added to this object. - [CustomErrorMessage ]: The custom error message to be displayed when the policy is applied. - [CustomErrorMessageEnabled ]: Indicates whether the custom error message is enabled or not. - [Description ]: - [Disabled ]: - [EffectAction ]: - [MfaRequired ]: - [Name ]: - [ObligationMfaFactors >]: - [Type ]: - [PrimaryHelpText ]: The text to be displayed for the help link. - [PrimaryHelpUrl ]: The URL to be opened when the help link is clicked. - [SecondaryHelpText ]: The text to be displayed for the help link. - [SecondaryHelpUrl ]: The URL to be opened when the help link is clicked. - [TargetResources >]: - Type : - [Id ]: Object ID of the resource target. If undefined, then all resources of the given type are targeted. - [Type ]: AuthnPolicyType - [UserAttributeExclusions >]: - [Field ]: The only field that is currently supported is ldap_binding_user - [Operator ]: - [Value ]: Can be any value - string, number, boolean, array or object. - [UserAttributeInclusions >]: - [UserGroupExclusions >]: - [UserGroupInclusions >]: - [UserInclusions >]: - [UserVerificationRequirement ]: - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: - -OBLIGATIONMFAFACTORS : - [Type ]: - -TARGETRESOURCES : - Type : - [Id ]: Object ID of the resource target. If undefined, then all resources of the given type are targeted. - -USERATTRIBUTEEXCLUSIONS : - [Field ]: The only field that is currently supported is ldap_binding_user - [Operator ]: - [Value ]: Can be any value - string, number, boolean, array or object. - -USERATTRIBUTEINCLUSIONS : - [Field ]: The only field that is currently supported is ldap_binding_user - [Operator ]: - [Value ]: Can be any value - string, number, boolean, array or object. -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAuthenticationPolicy.md -#> - Function Update-JcSdkAuthenticationPolicy +Function Update-JcSdkAuthenticationPolicy { [OutputType([JumpCloud.SDK.V2.Models.IAuthnPolicy])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -435,5 +279,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkBulkUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkBulkUser.ps1 index 43deb7d0b..f2061eece 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkBulkUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkBulkUser.ps1 @@ -1,156 +1,4 @@ -<# -.Synopsis -The endpoint allows you to update a bulk job to asynchronously update users. -See [update a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_put) for full list of attributes. - -#### Sample Request -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '[ -\t{ -\t \"id\":\"5be9fb4ddb01290001e85109\", -\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", -\t\t\"department\":\"{UPDATED_DEPARTMENT}\", -\t\t\"attributes\":[ -\t\t\t{\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} -\t\t] -\t}, -\t{ -\t \"id\":\"5be9fb4ddb01290001e85109\", -\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", -\t\t\"costCenter\":\"{UPDATED_COST_CENTER}\", -\t\t\"phoneNumbers\":[ -\t\t\t{\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, -\t\t\t{\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} -\t\t] -\t} -] -``` -.Description -The endpoint allows you to update a bulk job to asynchronously update users. -See [update a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_put) for full list of attributes. - -#### Sample Request -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '[ -\t{ -\t \"id\":\"5be9fb4ddb01290001e85109\", -\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", -\t\t\"department\":\"{UPDATED_DEPARTMENT}\", -\t\t\"attributes\":[ -\t\t\t{\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} -\t\t] -\t}, -\t{ -\t \"id\":\"5be9fb4ddb01290001e85109\", -\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", -\t\t\"costCenter\":\"{UPDATED_COST_CENTER}\", -\t\t\"phoneNumbers\":[ -\t\t\t{\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, -\t\t\t{\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} -\t\t] -\t} -] -``` -.Example -PS C:\> Update-JcSdkBulkUser - - -.Example -PS C:\> {{ Add code here }} - -{{ Add output here }} - -.Inputs -System.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserUpdate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] -.Outputs -JumpCloud.SDK.V2.Models.IJobIdResult -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY >: - [AccountLocked ]: - [Addresses >]: type, poBox, extendedAddress, streetAddress, locality, region, postalCode, country - [Country ]: - [ExtendedAddress ]: - [Locality ]: - [PoBox ]: - [PostalCode ]: - [Region ]: - [StreetAddress ]: - [Type ]: - [AllowPublicKey ]: - [AlternateEmail ]: - [Attributes >]: - [Name ]: - [Value ]: - [Company ]: - [CostCenter ]: - [DelegatedAuthorityId ]: ObjectId of the target Active Directory connection - [DelegatedAuthorityName ]: Authority name - [Department ]: - [Description ]: - [DisableDeviceMaxLoginAttempts ]: - [Displayname ]: - [Email ]: - [EmployeeIdentifier ]: Must be unique per user. - [EmployeeType ]: - [EnableManagedUid ]: - [EnableUserPortalMultifactor ]: - [ExternalDn ]: - [ExternalPasswordExpirationDate ]: - [ExternalSourceType ]: - [ExternallyManaged ]: - [Firstname ]: - [Id ]: Object ID of the user being updated - [JobTitle ]: - [Lastname ]: - [LdapBindingUser ]: - [Location ]: - [ManagedAppleId ]: - [Manager ]: Relation with another systemuser to identify the last as a manager. - [MfaConfigured ]: - [MfaExclusion ]: - [MfaExclusionDays ]: - [MfaExclusionUntil ]: - [Middlename ]: - [Organization ]: Organization object id of the user - [Password ]: - [PasswordNeverExpires ]: - [PasswordlessSudo ]: - [PhoneNumbers >]: - [Number ]: - [Type ]: - [PublicKey ]: - [Relationships >]: - [Type ]: - [Value ]: - [RestrictedField ]: - [RestrictedFieldId ]: - [RestrictedFieldType ]: - [SambaServiceUser ]: - [SshKeys >]: - Name : The name of the SSH key. - PublicKey : The Public SSH key. - [State ]: - [Sudo ]: - [Suspended ]: - [UnixGuid ]: - [UnixUid ]: - [Username ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkBulkUser.md -#> - Function Update-JcSdkBulkUser +Function Update-JcSdkBulkUser { [OutputType([JumpCloud.SDK.V2.Models.IJobIdResult])] [CmdletBinding(DefaultParameterSetName='Update', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -272,5 +120,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkGSuite.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkGSuite.ps1 index 00adeadf7..0805ad972 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkGSuite.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkGSuite.ps1 @@ -1,164 +1,4 @@ -<# -.Synopsis -This endpoint allows updating some attributes of a G Suite. - -##### Sample Request - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"userLockoutAction\": \"suspend\", - \"userPasswordExpirationAction\": \"maintain\" - }' -``` -Sample Request, set a default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": { - \"id\": \"{domainObjectID}\" - } - }' -``` - -Sample Request, unset the default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": {} - }' -``` -.Description -This endpoint allows updating some attributes of a G Suite. - -##### Sample Request - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"userLockoutAction\": \"suspend\", - \"userPasswordExpirationAction\": \"maintain\" - }' -``` -Sample Request, set a default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": { - \"id\": \"{domainObjectID}\" - } - }' -``` - -Sample Request, unset the default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": {} - }' -``` -.Example -PS C:\> Update-JcSdkGSuite -Id:() -Body:() - - - ----- ---------- -DefaultDomainDomain String -DefaultDomainId String -GroupsEnabled Boolean -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - - -.Example -PS C:\> Update-JcSdkGSuite -Id:() -DefaultDomainId:() -GroupsEnabled:() -Name:() -UserLockoutAction:() -UserPasswordExpirationAction:() - - - ----- ---------- -DefaultDomainDomain String -DefaultDomainId String -GroupsEnabled Boolean -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - - - -.Inputs -JumpCloud.SDK.V2.Models.IGsuite -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IGsuite -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [DefaultDomainId ]: - [GroupsEnabled ]: - [ImportFilter ]: - [Name ]: - [OrganizationObjectId ]: OrganizationObjectId is the object id of the organization that the account belongs to. - [UserLockoutAction ]: - [UserPasswordExpirationAction ]: - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkGSuite.md -#> - Function Update-JcSdkGSuite +Function Update-JcSdkGSuite { [OutputType([JumpCloud.SDK.V2.Models.IGsuite])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -332,5 +172,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkIPList.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkIPList.ps1 index 00ac46fe5..f84060bce 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkIPList.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkIPList.ps1 @@ -1,96 +1,4 @@ -<# -.Synopsis -Update a specific IP list. - -#### Sample Request -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{\"name\": \"New IP List Name\"}' -``` -.Description -Update a specific IP list. - -#### Sample Request -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{\"name\": \"New IP List Name\"}' -``` -.Example -PS C:\> Update-JcSdkIPList -Id:() -Body:() - - - ----- ---------- -Description String -Id String -Ips String -Name String - - -.Example -PS C:\> Update-JcSdkIPList -Id:() -Description:() -Ips:() -Name:() - - - ----- ---------- -Description String -Id String -Ips String -Name String - - - -.Inputs -JumpCloud.SDK.V2.Models.IIPListRequest -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Outputs -JumpCloud.SDK.V2.Models.IIPList -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [Description ]: - [Ips >]: - [Name ]: - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkIPList.md -#> - Function Update-JcSdkIPList +Function Update-JcSdkIPList { [OutputType([JumpCloud.SDK.V2.Models.IIPList])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -237,5 +145,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkLdapServer.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkLdapServer.ps1 index fc1db0fbf..f88c7d806 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkLdapServer.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkLdapServer.ps1 @@ -1,104 +1,4 @@ -<# -.Synopsis -This endpoint allows updating some attributes of an LDAP server. - -Sample Request - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"userLockoutAction\": \"remove\", - \"userPasswordExpirationAction\": \"disable\" - }' -``` -.Description -This endpoint allows updating some attributes of an LDAP server. - -Sample Request - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"userLockoutAction\": \"remove\", - \"userPasswordExpirationAction\": \"disable\" - }' -``` -.Example -PS C:\> Update-JcSdkLdapServer -Id:() -Body:() - - - ----- ---------- -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - - -.Example -PS C:\> Update-JcSdkLdapServer -Id:() -Id1:() -UserLockoutAction:() -UserPasswordExpirationAction:() - - - ----- ---------- -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.IPaths1Ka5IlhLdapserversIdPatchRequestbodyContentApplicationJsonSchema -.Outputs -JumpCloud.SDK.V2.Models.IPaths1Dvt4UsLdapserversIdPatchResponses200ContentApplicationJsonSchema -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [Id ]: - [UserLockoutAction ]: LDAP Server Action - [UserPasswordExpirationAction ]: LDAP Server Action - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkLdapServer.md -#> - Function Update-JcSdkLdapServer +Function Update-JcSdkLdapServer { [OutputType([JumpCloud.SDK.V2.Models.IPaths1Dvt4UsLdapserversIdPatchResponses200ContentApplicationJsonSchema])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -244,5 +144,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkOffice365.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkOffice365.ps1 index ef72cb478..5d25f7849 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkOffice365.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkOffice365.ps1 @@ -1,168 +1,4 @@ -<# -.Synopsis -This endpoint allows updating some attributes of an Office 365 instance. - -##### - -Sample Request - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"userLockoutAction\": \"maintain\", - \"userPasswordExpirationAction\": \"suspend\", - }' -``` - -Sample Request, set a default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": { - \"id\": \"{domainObjectID}\" - } - }' -``` - -Sample Request, unset the default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": {} - }' -``` -.Description -This endpoint allows updating some attributes of an Office 365 instance. - -##### - -Sample Request - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"userLockoutAction\": \"maintain\", - \"userPasswordExpirationAction\": \"suspend\", - }' -``` - -Sample Request, set a default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": { - \"id\": \"{domainObjectID}\" - } - }' -``` - -Sample Request, unset the default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": {} - }' -``` -.Example -PS C:\> Update-JcSdkOffice365 -Office365Id:() -Body:() - - - ----- ---------- -DefaultDomainDomain String -DefaultDomainId String -GroupsEnabled Boolean -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - - -.Example -PS C:\> Update-JcSdkOffice365 -Office365Id:() -DefaultDomainId:() -GroupsEnabled:() -Name:() -UserLockoutAction:() -UserPasswordExpirationAction:() - - - ----- ---------- -DefaultDomainDomain String -DefaultDomainId String -GroupsEnabled Boolean -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.IOffice365 -.Outputs -JumpCloud.SDK.V2.Models.IOffice365 -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [DefaultDomainId ]: - [GroupsEnabled ]: - [Name ]: - [UserLockoutAction ]: - [UserPasswordExpirationAction ]: - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkOffice365.md -#> - Function Update-JcSdkOffice365 +Function Update-JcSdkOffice365 { [OutputType([JumpCloud.SDK.V2.Models.IOffice365])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -322,5 +158,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkUserPushEndpoint.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkUserPushEndpoint.ps1 index b339b722a..442b7cab8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkUserPushEndpoint.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkUserPushEndpoint.ps1 @@ -1,91 +1,4 @@ -<# -.Synopsis -This endpoint will update a push endpoint associated with a user. -.Description -This endpoint will update a push endpoint associated with a user. -.Example -PS C:\> Update-JcSdkUserPushEndpoint -PushEndpointId:() -UserId:() -Body:() - - - ----- ---------- -DeviceAppVersion String -DeviceMake String -DeviceModel String -DeviceOS String -DeviceOSVersion String -DeviceUvEnabled Boolean -EnrollmentDate Datetime -Id String -LastUsedDate Datetime -Name String -State String - - -.Example -PS C:\> Update-JcSdkUserPushEndpoint -PushEndpointId:() -UserId:() -Name:() -State:() - - - ----- ---------- -DeviceAppVersion String -DeviceMake String -DeviceModel String -DeviceOS String -DeviceOSVersion String -DeviceUvEnabled Boolean -EnrollmentDate Datetime -Id String -LastUsedDate Datetime -Name String -State String - - - -.Inputs -JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -.Inputs -JumpCloud.SDK.V2.Models.IPathsO4Si39UsersUserIdPushendpointsPushEndpointIdPatchRequestbodyContentApplicationJsonSchema -.Outputs -JumpCloud.SDK.V2.Models.IPushEndpointResponse -.Notes -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -BODY : - [Name ]: - [State ]: - -INPUTOBJECT : - [AccountId ]: - [ActivedirectoryId ]: - [AdministratorId ]: - [AgentId ]: - [AppleMdmId ]: - [ApplicationId ]: ObjectID of the Application. - [ApprovalFlowId ]: - [CommandId ]: ObjectID of the Command. - [CustomEmailType ]: - [DeviceId ]: - [GroupId ]: ObjectID of the Policy Group. - [GsuiteId ]: ObjectID of the G Suite instance. - [Id ]: ObjectID of this Active Directory instance. - [JobId ]: - [LdapserverId ]: ObjectID of the LDAP Server. - [Office365Id ]: ObjectID of the Office 365 instance. - [PolicyId ]: ObjectID of the Policy. - [ProviderId ]: - [PushEndpointId ]: - [RadiusserverId ]: ObjectID of the Radius Server. - [SoftwareAppId ]: ObjectID of the Software App. - [SystemId ]: ObjectID of the System. - [UserId ]: ObjectID of the User. - [WorkdayId ]: -.Link -https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkUserPushEndpoint.md -#> - Function Update-JcSdkUserPushEndpoint +Function Update-JcSdkUserPushEndpoint { [OutputType([JumpCloud.SDK.V2.Models.IPushEndpointResponse])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -231,5 +144,3 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/Jum Return $Results } } - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDevice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDevice.md deleted file mode 100644 index 55baa82ad..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDevice.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDevice.md -schema: 2.0.0 ---- - -# Clear-JcSdkAppleMdmDevice - -## SYNOPSIS -Erases a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/erase \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -## SYNTAX - -### ClearExpanded (Default) -``` -Clear-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId [-Pin ] - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Clear -``` -Clear-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId - -Body - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### ClearViaIdentity -``` -Clear-JcSdkAppleMdmDevice -ConsoleHost -InputObject - -Body - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### ClearViaIdentityExpanded -``` -Clear-JcSdkAppleMdmDevice -ConsoleHost -InputObject [-Pin ] - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Erases a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/erase \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Clear-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Pin:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Clear-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Body:() -``` - - - -## PARAMETERS - -### -AppleMdmId -. - -```yaml -Type: System.String -Parameter Sets: Clear, ClearExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IPaths1FfbqfwApplemdmsAppleMdmIdDevicesDeviceIdErasePostRequestbodyContentApplicationJsonSchema -Parameter Sets: Clear, ClearViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeviceId -. - -```yaml -Type: System.String -Parameter Sets: Clear, ClearExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: ClearViaIdentity, ClearViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pin -6-digit PIN, required for MacOS, to erase the device - -```yaml -Type: System.String -Parameter Sets: ClearExpanded, ClearViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.IPaths1FfbqfwApplemdmsAppleMdmIdDevicesDeviceIdErasePostRequestbodyContentApplicationJsonSchema - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: . - - `[Pin ]`: 6-digit PIN, required for MacOS, to erase the device - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDeviceActivationLock.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDeviceActivationLock.md deleted file mode 100644 index 88ae08aae..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDeviceActivationLock.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDeviceActivationLock.md -schema: 2.0.0 ---- - -# Clear-JcSdkAppleMdmDeviceActivationLock - -## SYNOPSIS -Clears the activation lock on the specified device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/clearActivationLock \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -## SYNTAX - -### Clear (Default) -``` -Clear-JcSdkAppleMdmDeviceActivationLock -ConsoleHost -AppleMdmId -DeviceId - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### ClearViaIdentity -``` -Clear-JcSdkAppleMdmDeviceActivationLock -ConsoleHost -InputObject [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Clears the activation lock on the specified device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/clearActivationLock \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Clear-JcSdkAppleMdmDeviceActivationLock -AppleMdmId:() -DeviceId:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -AppleMdmId -. - -```yaml -Type: System.String -Parameter Sets: Clear -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeviceId -. - -```yaml -Type: System.String -Parameter Sets: Clear -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: ClearViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequest.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequest.md deleted file mode 100644 index 48770bdb5..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequest.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequest.md -schema: 2.0.0 ---- - -# Get-JcSdkAccessRequest - -## SYNOPSIS -Endpoint that returns the workflow access request by id - -## SYNTAX - -### List (Default) -``` -Get-JcSdkAccessRequest -ConsoleHost [-Fields >] [-Filter >] - [-OrganizationObjectId ] [-Sort ] [] -``` - -### Get -``` -Get-JcSdkAccessRequest -ConsoleHost -Id [-OrganizationObjectId ] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkAccessRequest -ConsoleHost -InputObject - [-OrganizationObjectId ] [] -``` - -## DESCRIPTION -Endpoint that returns the workflow access request by id - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkAccessRequest -Id:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkAccessRequest -Fields:() -Filter:() -Sort:() -``` - - - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields -. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OrganizationObjectId -. - -```yaml -Type: System.Byte[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort -. - -```yaml -Type: System.String -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAllWorkflowAccessRequestResponse - -### JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetWorkflowAccessRequestResponse - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequestProgress.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequestProgress.md deleted file mode 100644 index b9a96f65e..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequestProgress.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequestProgress.md -schema: 2.0.0 ---- - -# Get-JcSdkAccessRequestProgress - -## SYNOPSIS -Endpoint for getting the approval progress of a access request - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkAccessRequestProgress -ConsoleHost -Id [-OrganizationObjectId ] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkAccessRequestProgress -ConsoleHost -InputObject - [-OrganizationObjectId ] [] -``` - -## DESCRIPTION -Endpoint for getting the approval progress of a access request - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkAccessRequestProgress -Id:() -``` - - - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OrganizationObjectId -. - -```yaml -Type: System.Byte[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAccessRequestApprovalProgressResponse - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectory.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectory.md deleted file mode 100644 index 574898ecf..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectory.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectory.md -schema: 2.0.0 ---- - -# Get-JcSdkActiveDirectory - -## SYNOPSIS -This endpoint returns a specific Active Directory. - -#### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## SYNTAX - -### List (Default) -``` -Get-JcSdkActiveDirectory -ConsoleHost [-Fields >] [-Filter >] - [-Sort >] [] -``` - -### Get -``` -Get-JcSdkActiveDirectory -ConsoleHost -Id [] -``` - -### GetViaIdentity -``` -Get-JcSdkActiveDirectory -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -This endpoint returns a specific Active Directory. - -#### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkActiveDirectory -Fields:() -Filter:() -Sort:() -``` - ----- ---------- -Domain String -Id String -PrimaryAgent String -UseCase String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkActiveDirectory -Id:() -``` - ----- ---------- -Domain String -Id String -PrimaryAgent String -UseCase String - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields -The comma separated fields included in the returned records. -If omitted, the default list of fields will be returned. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -ObjectID of this Active Directory instance. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IActiveDirectory - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAgent.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAgent.md deleted file mode 100644 index b4aa51550..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAgent.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAgent.md -schema: 2.0.0 ---- - -# Get-JcSdkActiveDirectoryAgent - -## SYNOPSIS -This endpoint returns an Active Directory agent. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### List (Default) -``` -Get-JcSdkActiveDirectoryAgent -ConsoleHost -ActivedirectoryId [-Sort >] - [] -``` - -### Get -``` -Get-JcSdkActiveDirectoryAgent -ConsoleHost -ActivedirectoryId -AgentId - [] -``` - -### GetViaIdentity -``` -Get-JcSdkActiveDirectoryAgent -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -This endpoint returns an Active Directory agent. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -Sort:() -``` - ----- ---------- -ContactAt String -Hostname String -Id String -SourceIP String -State String -Version String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -AgentId:() -``` - ----- ---------- -ContactAt String -Hostname String -Id String -SourceIP String -State String -Version String - -## PARAMETERS - -### -ActivedirectoryId -. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgentId -. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IActiveDirectoryAgentList - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAssociation.md deleted file mode 100644 index 11f92c40c..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAssociation.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAssociation.md -schema: 2.0.0 ---- - -# Get-JcSdkActiveDirectoryAssociation - -## SYNOPSIS -This endpoint returns the direct associations of this Active Directory instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. - - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/associations?targets=user \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkActiveDirectoryAssociation -ConsoleHost -ActivedirectoryId -Targets - [] -``` - -### GetViaIdentity -``` -Get-JcSdkActiveDirectoryAssociation -ConsoleHost -InputObject - -Targets [] -``` - -## DESCRIPTION -This endpoint returns the direct associations of this Active Directory instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. - - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/associations?targets=user \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkActiveDirectoryAssociation -ActivedirectoryId:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ActivedirectoryId -. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Targets -Targets which a "active_directory" can be associated to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphConnection - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUser.md deleted file mode 100644 index 01394a05e..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUser.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUser.md -schema: 2.0.0 ---- - -# Get-JcSdkActiveDirectoryTraverseUser - -## SYNOPSIS -This endpoint will return all Users bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Active Directory instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Active Directory instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/users \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkActiveDirectoryTraverseUser -ConsoleHost -ActivedirectoryId - [-Filter >] [] -``` - -### GetViaIdentity -``` -Get-JcSdkActiveDirectoryTraverseUser -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Users bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Active Directory instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Active Directory instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/users \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkActiveDirectoryTraverseUser -ActivedirectoryId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ActivedirectoryId -ObjectID of the Active Directory instance. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUserGroup.md deleted file mode 100644 index 61c832173..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUserGroup.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUserGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkActiveDirectoryTraverseUserGroup - -## SYNOPSIS -This endpoint will return all Users Groups bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Active Directory instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Active Directory instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/usergroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkActiveDirectoryTraverseUserGroup -ConsoleHost -ActivedirectoryId - [-Filter >] [] -``` - -### GetViaIdentity -``` -Get-JcSdkActiveDirectoryTraverseUserGroup -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Users Groups bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Active Directory instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Active Directory instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/usergroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkActiveDirectoryTraverseUserGroup -ActivedirectoryId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ActivedirectoryId -ObjectID of the Active Directory instance. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganization.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganization.md deleted file mode 100644 index 4bcad3da6..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganization.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganization.md -schema: 2.0.0 ---- - -# Get-JcSdkAdministratorOrganization - -## SYNOPSIS -This endpoint returns the association links between an Administrator and Organizations. - -## SYNTAX - -``` -Get-JcSdkAdministratorOrganization -ConsoleHost -Id [] -``` - -## DESCRIPTION -This endpoint returns the association links between an Administrator and Organizations. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkAdministratorOrganization -``` - ----- ---------- -Administrator String -Organization String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganizationLink.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganizationLink.md deleted file mode 100644 index 9c4982de4..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganizationLink.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganizationLink.md -schema: 2.0.0 ---- - -# Get-JcSdkAdministratorOrganizationLink - -## SYNOPSIS -This endpoint returns the association links between an Organization and Administrators. - -## SYNTAX - -``` -Get-JcSdkAdministratorOrganizationLink -ConsoleHost -Id [] -``` - -## DESCRIPTION -This endpoint returns the association links between an Organization and Administrators. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkAdministratorOrganizationLink -``` - ----- ---------- -Administrator String -Organization String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdm.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdm.md deleted file mode 100644 index a8f1ab26c..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdm.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdm.md -schema: 2.0.0 ---- - -# Get-JcSdkAppleMdm - -## SYNOPSIS -Get a list of all Apple MDM configurations. -An empty topic indicates that a signed certificate from Apple has not been provided to the PUT endpoint yet. - -Note: currently only one MDM configuration per organization is supported. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/applemdms \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -``` -Get-JcSdkAppleMdm -ConsoleHost [-Filter >] [] -``` - -## DESCRIPTION -Get a list of all Apple MDM configurations. -An empty topic indicates that a signed certificate from Apple has not been provided to the PUT endpoint yet. - -Note: currently only one MDM configuration per organization is supported. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/applemdms \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkAppleMdm -``` - -Get Apple MDM Server information within a JumpCloud Tenant - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IAppleMdm - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmDevice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmDevice.md deleted file mode 100644 index 481eb8920..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmDevice.md +++ /dev/null @@ -1,283 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmDevice.md -schema: 2.0.0 ---- - -# Get-JcSdkAppleMdmDevice - -## SYNOPSIS -Gets a single Apple MDM device. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ - -H 'accept: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### List (Default) -``` -Get-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId [-Filter >] - [-Sort >] [-XTotalCount ] [] -``` - -### Get -``` -Get-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId [] -``` - -### GetViaIdentity -``` -Get-JcSdkAppleMdmDevice -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -Gets a single Apple MDM device. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ - -H 'accept: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkAppleMdmDevice -AppleMdmId:() -Filter:() -Sort:() -XTotalCount:() -``` - ----- ---------- -CreatedAt String -DepRegistered Boolean -DeviceInformationActivationLockAllowedWhileSupervised Boolean -DeviceInformationAvailableDeviceCapacity System.Nullable[float] DeviceInformationAvailableDeviceCapacity {get;set;} -DeviceInformationDeviceCapacity System.Nullable[float] DeviceInformationDeviceCapacity {get;set;} -DeviceInformationDeviceName String -DeviceInformationIccid String -DeviceInformationImei String -DeviceInformationIsSupervised Boolean -DeviceInformationModelName String -DeviceInformationSecondIccid String -DeviceInformationSecondImei String -DeviceInformationSecondSubscriberCarrierNetwork String -DeviceInformationSubscriberCarrierNetwork String -DeviceInformationWifiMac String -Enrolled Boolean -HasActivationLockBypassCodes Boolean -Id String -OSVersion String -SecurityInfoEnrolledViaDep Boolean -SecurityInfoIsActivationLockManageable Boolean -SecurityInfoIsUserEnrollment Boolean -SecurityInfoPasscodePresent Boolean -SecurityInfoUserApprovedEnrollment Boolean -SerialNumber String -Udid String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -``` - ----- ---------- -CreatedAt String -DepRegistered Boolean -DeviceInformationActivationLockAllowedWhileSupervised Boolean -DeviceInformationAvailableDeviceCapacity System.Nullable[float] DeviceInformationAvailableDeviceCapacity {get;set;} -DeviceInformationDeviceCapacity System.Nullable[float] DeviceInformationDeviceCapacity {get;set;} -DeviceInformationDeviceName String -DeviceInformationIccid String -DeviceInformationImei String -DeviceInformationIsSupervised Boolean -DeviceInformationModelName String -DeviceInformationSecondIccid String -DeviceInformationSecondImei String -DeviceInformationSecondSubscriberCarrierNetwork String -DeviceInformationSubscriberCarrierNetwork String -DeviceInformationWifiMac String -Enrolled Boolean -HasActivationLockBypassCodes Boolean -Id String -OSVersion String -SecurityInfoEnrolledViaDep Boolean -SecurityInfoIsActivationLockManageable Boolean -SecurityInfoIsUserEnrollment Boolean -SecurityInfoPasscodePresent Boolean -SecurityInfoUserApprovedEnrollment Boolean -SerialNumber String -Udid String - -## PARAMETERS - -### -AppleMdmId -. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeviceId -. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -XTotalCount -. - -```yaml -Type: System.Int32 -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IAppleMdmDevice - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmEnrollmentProfile.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmEnrollmentProfile.md deleted file mode 100644 index 91079d518..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmEnrollmentProfile.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmEnrollmentProfile.md -schema: 2.0.0 ---- - -# Get-JcSdkAppleMdmEnrollmentProfile - -## SYNOPSIS -Get a list of enrollment profiles for an apple mdm. - -Note: currently only one enrollment profile is supported. - -#### Sample Request -``` - curl https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/enrollmentprofiles \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -``` -Get-JcSdkAppleMdmEnrollmentProfile -ConsoleHost -AppleMdmId [] -``` - -## DESCRIPTION -Get a list of enrollment profiles for an apple mdm. - -Note: currently only one enrollment profile is supported. - -#### Sample Request -``` - curl https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/enrollmentprofiles \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkAppleMdmEnrollmentProfile -AppleMdmId 5ecfd88e63336c651d4f4n59 -``` - -Get a list of enrollment profiles for an apple mdm - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkAppleMdmEnrollmentProfile -AppleMdmId 5ecfd88e63336c651d4f4n59 -Id 5ecfd88e63336c651d4f4n60 -``` - -Get an enrollment profile by Id - -## PARAMETERS - -### -AppleMdmId -. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IAppleMdm - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationAssociation.md deleted file mode 100644 index 2f483a775..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationAssociation.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationAssociation.md -schema: 2.0.0 ---- - -# Get-JcSdkApplicationAssociation - -## SYNOPSIS -This endpoint will return the _direct_ associations of an Application. -A direct association can be a non-homogeneous relationship between 2 different objects, for example Applications and User Groups. - - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations?targets=user_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkApplicationAssociation -ConsoleHost -ApplicationId -Targets - [] -``` - -### GetViaIdentity -``` -Get-JcSdkApplicationAssociation -ConsoleHost -InputObject -Targets - [] -``` - -## DESCRIPTION -This endpoint will return the _direct_ associations of an Application. -A direct association can be a non-homogeneous relationship between 2 different objects, for example Applications and User Groups. - - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations?targets=user_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkApplicationAssociation -ApplicationId:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ApplicationId -ObjectID of the Application. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Targets -Targets which a "active_directory" can be associated to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphConnection - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUser.md deleted file mode 100644 index 8f116cf04..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUser.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUser.md -schema: 2.0.0 ---- - -# Get-JcSdkApplicationTraverseUser - -## SYNOPSIS -This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkApplicationTraverseUser -ConsoleHost -ApplicationId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkApplicationTraverseUser -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkApplicationTraverseUser -ApplicationId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ApplicationId -ObjectID of the Application. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUserGroup.md deleted file mode 100644 index d1e12c051..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUserGroup.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUserGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkApplicationTraverseUserGroup - -## SYNOPSIS -This endpoint will return all Users Groups bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Application to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Application. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/usergroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkApplicationTraverseUserGroup -ConsoleHost -ApplicationId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkApplicationTraverseUserGroup -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Users Groups bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Application to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Application. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/usergroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkApplicationTraverseUserGroup -ApplicationId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ApplicationId -ObjectID of the Application. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlow.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlow.md deleted file mode 100644 index c31218af4..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlow.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlow.md -schema: 2.0.0 ---- - -# Get-JcSdkApprovalFlow - -## SYNOPSIS -Endpoint for getting workflow by id - -## SYNTAX - -### List (Default) -``` -Get-JcSdkApprovalFlow -ConsoleHost [-Fields >] [-Filter >] - [-OrganizationObjectId ] [-Sort ] [] -``` - -### Get -``` -Get-JcSdkApprovalFlow -ConsoleHost -ApprovalFlowId [-OrganizationObjectId ] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkApprovalFlow -ConsoleHost -InputObject - [-OrganizationObjectId ] [] -``` - -## DESCRIPTION -Endpoint for getting workflow by id - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkApprovalFlow -ApprovalFlowId:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkApprovalFlow -Fields:() -Filter:() -Sort:() -``` - - - -## PARAMETERS - -### -ApprovalFlowId -. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields -. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OrganizationObjectId -. - -```yaml -Type: System.Byte[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort -. - -```yaml -Type: System.String -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IJumpcloudIngressoAccessWorkflow - -### JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAllAccessWorkFlowsResponse - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlowSetting.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlowSetting.md deleted file mode 100644 index bd330af92..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlowSetting.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlowSetting.md -schema: 2.0.0 ---- - -# Get-JcSdkApprovalFlowSetting - -## SYNOPSIS -Endpoint for getting workflow settings for an organisation - -## SYNTAX - -``` -Get-JcSdkApprovalFlowSetting -ConsoleHost [-OrganizationObjectId ] [] -``` - -## DESCRIPTION -Endpoint for getting workflow settings for an organisation - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkApprovalFlowSetting -``` - - - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationObjectId -. - -```yaml -Type: System.Byte[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IJumpcloudIngressoAccessWorkflowSettings - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAuthenticationPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAuthenticationPolicy.md deleted file mode 100644 index 614a2831b..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAuthenticationPolicy.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAuthenticationPolicy.md -schema: 2.0.0 ---- - -# Get-JcSdkAuthenticationPolicy - -## SYNOPSIS -Return a specific authentication policy. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### List (Default) -``` -Get-JcSdkAuthenticationPolicy -ConsoleHost [-Filter >] [-Sort >] - [-XTotalCount ] [] -``` - -### Get -``` -Get-JcSdkAuthenticationPolicy -ConsoleHost -Id [] -``` - -### GetViaIdentity -``` -Get-JcSdkAuthenticationPolicy -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -Return a specific authentication policy. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkAuthenticationPolicy -Filter:() -Sort:() -XTotalCount:() -``` - ----- ---------- -Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions -Description String -Disabled Boolean -EffectAction String -Id String -MfaRequired Boolean -Name String -TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] -Type String -UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserGroupExclusions String -UserGroupInclusions String -UserInclusions String -UserVerificationRequirement String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkAuthenticationPolicy -Id:() -``` - ----- ---------- -Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions -Description String -Disabled Boolean -EffectAction String -Id String -MfaRequired Boolean -Name String -TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] -Type String -UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserGroupExclusions String -UserGroupInclusions String -UserInclusions String -UserVerificationRequirement String - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Unique identifier of the authentication policy - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -XTotalCount -. - -```yaml -Type: System.Int32 -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IAuthnPolicy - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUserState.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUserState.md deleted file mode 100644 index d46a79054..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUserState.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUserState.md -schema: 2.0.0 ---- - -# Get-JcSdkBulkUserState - -## SYNOPSIS -The endpoint allows you to list scheduled statechange jobs. -#### Sample Request -``` -curl -X GET \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ - -H 'x-api-key: {API_KEY}' \\ - -H 'Content-Type: application/json' \\ - -H 'Accept: application/json' -``` - -## SYNTAX - -``` -Get-JcSdkBulkUserState -ConsoleHost [-Filter >] [-Userid ] [] -``` - -## DESCRIPTION -The endpoint allows you to list scheduled statechange jobs. -#### Sample Request -``` -curl -X GET \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ - -H 'x-api-key: {API_KEY}' \\ - -H 'Content-Type: application/json' \\ - -H 'Accept: application/json' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkBulkUserState -``` - ----- ---------- -ScheduledDate String -ScheduledJobId String -State String -SystemUserId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Userid -The systemuser id to filter by. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IScheduledUserstateResult - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUsersResult.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUsersResult.md deleted file mode 100644 index 432be9818..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUsersResult.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUsersResult.md -schema: 2.0.0 ---- - -# Get-JcSdkBulkUsersResult - -## SYNOPSIS -This endpoint will return the results of particular user import or get job request. - -#### Sample Request -``` -curl -X GET \\ - https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkBulkUsersResult -ConsoleHost -JobId [] -``` - -### GetViaIdentity -``` -Get-JcSdkBulkUsersResult -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -This endpoint will return the results of particular user import or get job request. - -#### Sample Request -``` -curl -X GET \\ - https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkBulkUsersResult -JobId:() -``` - ----- ---------- -CreatedAt String -Id String -Meta JumpCloud.SDK.V2.Models.JobWorkresultMeta -PersistedFields JumpCloud.SDK.V2.Models.JobWorkresultPersistedFields -Status String -StatusMsg String -UpdatedAt String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -JobId -. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IJobWorkresult - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandAssociation.md deleted file mode 100644 index c414ed439..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandAssociation.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandAssociation.md -schema: 2.0.0 ---- - -# Get-JcSdkCommandAssociation - -## SYNOPSIS -This endpoint will return the _direct_ associations of this Command. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations?targets=system_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkCommandAssociation -ConsoleHost -CommandId -Targets [] -``` - -### GetViaIdentity -``` -Get-JcSdkCommandAssociation -ConsoleHost -InputObject -Targets - [] -``` - -## DESCRIPTION -This endpoint will return the _direct_ associations of this Command. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations?targets=system_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkCommandAssociation -CommandId:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -CommandId -ObjectID of the Command. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Targets -Targets which a "active_directory" can be associated to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphConnection - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystem.md deleted file mode 100644 index a193a324d..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystem.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystem.md -schema: 2.0.0 ---- - -# Get-JcSdkCommandTraverseSystem - -## SYNOPSIS -This endpoint will return all Systems bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Command to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Command. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systems \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkCommandTraverseSystem -ConsoleHost -CommandId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkCommandTraverseSystem -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Systems bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Command to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Command. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systems \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkCommandTraverseSystem -CommandId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -CommandId -ObjectID of the Command. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystemGroup.md deleted file mode 100644 index 3addeecd3..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystemGroup.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystemGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkCommandTraverseSystemGroup - -## SYNOPSIS -This endpoint will return all System Groups bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Command to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Command. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systemgroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkCommandTraverseSystemGroup -ConsoleHost -CommandId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkCommandTraverseSystemGroup -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all System Groups bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Command to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Command. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systemgroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkCommandTraverseSystemGroup -CommandId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -CommandId -ObjectID of the Command. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailConfiguration.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailConfiguration.md deleted file mode 100644 index 352dd2992..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailConfiguration.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailConfiguration.md -schema: 2.0.0 ---- - -# Get-JcSdkCustomEmailConfiguration - -## SYNOPSIS -Get the custom email configuration for the specified custom email type - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkCustomEmailConfiguration -ConsoleHost -CustomEmailType [] -``` - -### GetViaIdentity -``` -Get-JcSdkCustomEmailConfiguration -ConsoleHost -InputObject - [] -``` - -## DESCRIPTION -Get the custom email configuration for the specified custom email type - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkCustomEmailConfiguration -CustomEmailType:() -``` - ----- ---------- -Body String -Button String -Header String -Id String -NextStepContactInfo String -Subject String -Title String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomEmailType -. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ICustomEmail - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailTemplate.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailTemplate.md deleted file mode 100644 index 4d76a640b..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailTemplate.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailTemplate.md -schema: 2.0.0 ---- - -# Get-JcSdkCustomEmailTemplate - -## SYNOPSIS -Get the list of custom email templates - -## SYNTAX - -``` -Get-JcSdkCustomEmailTemplate -ConsoleHost [] -``` - -## DESCRIPTION -Get the list of custom email templates - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkCustomEmailTemplate -``` - ----- ---------- -Description String -DisplayName String -Fields JumpCloud.SDK.V2.Models.CustomEmailTemplateField[] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ICustomEmailTemplate - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDirectory.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDirectory.md deleted file mode 100644 index c084cf681..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDirectory.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDirectory.md -schema: 2.0.0 ---- - -# Get-JcSdkDirectory - -## SYNOPSIS -This endpoint returns all active directories (LDAP, O365 Suite, G-Suite). - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/directories \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -``` -Get-JcSdkDirectory -ConsoleHost [-Fields >] [-Sort >] [] -``` - -## DESCRIPTION -This endpoint returns all active directories (LDAP, O365 Suite, G-Suite). - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/directories \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkDirectory -``` - ----- ---------- -DefaultDomainDomain String -DefaultDomainId String -Id String -Name String -OAuthStatus JumpCloud.SDK.V2.Models.DirectoryOAuthStatus -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields -The comma separated fields included in the returned records. -If omitted, the default list of fields will be returned. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IDirectory - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoAccount.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoAccount.md deleted file mode 100644 index d2dc9f049..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoAccount.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoAccount.md -schema: 2.0.0 ---- - -# Get-JcSdkDuoAccount - -## SYNOPSIS -This endpoint returns a specific Duo account. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### List (Default) -``` -Get-JcSdkDuoAccount -ConsoleHost [] -``` - -### Get -``` -Get-JcSdkDuoAccount -ConsoleHost -Id [] -``` - -### GetViaIdentity -``` -Get-JcSdkDuoAccount -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -This endpoint returns a specific Duo account. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkDuoAccount -``` - ----- ---------- -Id String -Name String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkDuoAccount -Id:() -``` - ----- ---------- -Id String -Name String - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -ObjectID of the Duo Account - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IDuoAccount - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoApplication.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoApplication.md deleted file mode 100644 index 2546fba24..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoApplication.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoApplication.md -schema: 2.0.0 ---- - -# Get-JcSdkDuoApplication - -## SYNOPSIS -This endpoint returns a specific Duo application that is associated with the specified Duo account. - -#### Sample Request -``` - curl https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### List (Default) -``` -Get-JcSdkDuoApplication -ConsoleHost -AccountId [] -``` - -### Get -``` -Get-JcSdkDuoApplication -ConsoleHost -AccountId -ApplicationId [] -``` - -### GetViaIdentity -``` -Get-JcSdkDuoApplication -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -This endpoint returns a specific Duo application that is associated with the specified Duo account. - -#### Sample Request -``` - curl https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkDuoApplication -AccountId:() -``` - ----- ---------- -ApiHost String -Id String -IntegrationKey String -Name String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkDuoApplication -AccountId:() -ApplicationId:() -``` - ----- ---------- -ApiHost String -Id String -IntegrationKey String -Name String - -## PARAMETERS - -### -AccountId -. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationId -. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IDuoApplication - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuite.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuite.md deleted file mode 100644 index 64f8ebf2a..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuite.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuite.md -schema: 2.0.0 ---- - -# Get-JcSdkGSuite - -## SYNOPSIS -This endpoint returns a specific G Suite. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkGSuite -ConsoleHost -Id [] -``` - -### GetViaIdentity -``` -Get-JcSdkGSuite -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -This endpoint returns a specific G Suite. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkGSuite -Id:() -``` - ----- ---------- -DefaultDomainDomain String -DefaultDomainId String -GroupsEnabled Boolean -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Unique identifier of the GSuite. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGsuite - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteAssociation.md deleted file mode 100644 index 7d6c976be..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteAssociation.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteAssociation.md -schema: 2.0.0 ---- - -# Get-JcSdkGSuiteAssociation - -## SYNOPSIS -This endpoint returns the _direct_ associations of this G Suite instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. - - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations?targets=user_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkGSuiteAssociation -ConsoleHost -GsuiteId -Targets [] -``` - -### GetViaIdentity -``` -Get-JcSdkGSuiteAssociation -ConsoleHost -InputObject -Targets - [] -``` - -## DESCRIPTION -This endpoint returns the _direct_ associations of this G Suite instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. - - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations?targets=user_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkGSuiteAssociation -GsuiteId:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GsuiteId -ObjectID of the G Suite instance. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Targets -Targets which a "active_directory" can be associated to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphConnection - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTranslationRule.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTranslationRule.md deleted file mode 100644 index 0a694a41a..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTranslationRule.md +++ /dev/null @@ -1,244 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTranslationRule.md -schema: 2.0.0 ---- - -# Get-JcSdkGSuiteTranslationRule - -## SYNOPSIS -This endpoint returns a specific translation rule for a specific G Suite instance. -These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. - -###### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## SYNTAX - -### List (Default) -``` -Get-JcSdkGSuiteTranslationRule -ConsoleHost -GsuiteId [-Fields >] - [-Filter >] [-Sort >] [] -``` - -### Get -``` -Get-JcSdkGSuiteTranslationRule -ConsoleHost -GsuiteId -Id [] -``` - -### GetViaIdentity -``` -Get-JcSdkGSuiteTranslationRule -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -This endpoint returns a specific translation rule for a specific G Suite instance. -These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. - -###### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkGSuiteTranslationRule -GsuiteId:() -Fields:() -Filter:() -Sort:() -``` - ----- ---------- -BuiltIn String -Direction String -Id String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkGSuiteTranslationRule -GsuiteId:() -Id:() -``` - ----- ---------- -BuiltIn String -Direction String -Id String - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields -The comma separated fields included in the returned records. -If omitted, the default list of fields will be returned. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GsuiteId -. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGSuiteTranslationRule - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUser.md deleted file mode 100644 index b48ad5cab..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUser.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUser.md -schema: 2.0.0 ---- - -# Get-JcSdkGSuiteTraverseUser - -## SYNOPSIS -This endpoint will return all Users bound to a G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this G Suite instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this G Suite instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/users \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkGSuiteTraverseUser -ConsoleHost -GsuiteId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkGSuiteTraverseUser -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Users bound to a G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this G Suite instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this G Suite instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/users \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkGSuiteTraverseUser -GsuiteId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GsuiteId -ObjectID of the G Suite instance. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUserGroup.md deleted file mode 100644 index 2d6823e1b..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUserGroup.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUserGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkGSuiteTraverseUserGroup - -## SYNOPSIS -This endpoint will return all User Groups bound to an G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this G Suite instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this G Suite instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSuite_ID}/usergroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkGSuiteTraverseUserGroup -ConsoleHost -GsuiteId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkGSuiteTraverseUserGroup -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all User Groups bound to an G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this G Suite instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this G Suite instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSuite_ID}/usergroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkGSuiteTraverseUserGroup -GsuiteId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GsuiteId -ObjectID of the G Suite instance. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteUsersToImport.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteUsersToImport.md deleted file mode 100644 index 40c43803c..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteUsersToImport.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteUsersToImport.md -schema: 2.0.0 ---- - -# Get-JcSdkGSuiteUsersToImport - -## SYNOPSIS -Lists G Suite users available for import. - -## SYNTAX - -``` -Get-JcSdkGSuiteUsersToImport -ConsoleHost -GsuiteId [-OrderBy ] [-Query ] - [-SortOrder ] [] -``` - -## DESCRIPTION -Lists G Suite users available for import. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkGSuiteUsersToImport -``` - ----- ---------- -NextPageToken String -Users JumpCloud.SDK.V2.Models.Get200ApplicationJsonPropertiesItemsItem[] - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GsuiteId -. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrderBy -Google Directory API sort field parameter. -See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Query -Google Directory API search parameter. -See https://developers.google.com/admin-sdk/directory/v1/guides/search-users. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortOrder -Google Directory API sort direction parameter. -See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPathsC7Pl4LGsuitesGsuiteIdImportUsersGetResponses200ContentApplicationJsonSchema - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGroup.md deleted file mode 100644 index 2acfe79a9..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGroup.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkGroup - -## SYNOPSIS -This endpoint returns all Groups that exist in your organization. - -#### Available filter fields: - - `name` - - `disabled` - - `type` - - `memberQueryErrorFlags` - -#### Sample Request - -``` - curl -X GET \\ - https://console.jumpcloud.com/api/v2/groups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -``` -Get-JcSdkGroup -ConsoleHost [-Fields >] [-Filter >] [-Sort >] - [-XUnfilteredTotalCount ] [] -``` - -## DESCRIPTION -This endpoint returns all Groups that exist in your organization. - -#### Available filter fields: - - `name` - - `disabled` - - `type` - - `memberQueryErrorFlags` - -#### Sample Request - -``` - curl -X GET \\ - https://console.jumpcloud.com/api/v2/groups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkGroup -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -Name String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields -The comma separated fields included in the returned records. -If omitted, the default list of fields will be returned. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -XUnfilteredTotalCount -If provided in the request with any non-empty value, this header will be returned on the response populated with the total count of objects without filters taken into account - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGroup - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGsuiteUsersToImportFormatted.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGsuiteUsersToImportFormatted.md deleted file mode 100644 index 6e6bb818a..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGsuiteUsersToImportFormatted.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGsuiteUsersToImportFormatted.md -schema: 2.0.0 ---- - -# Get-JcSdkGsuiteUsersToImportFormatted - -## SYNOPSIS -Lists available G Suite users for import, translated to the Jumpcloud user schema. - -## SYNTAX - -``` -Get-JcSdkGsuiteUsersToImportFormatted -ConsoleHost -GsuiteId [-AllowEmptyFields] - [-OrderBy ] [-Query ] [-SortOrder ] [] -``` - -## DESCRIPTION -Lists available G Suite users for import, translated to the Jumpcloud user schema. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkGsuiteUsersToImportFormatted -``` - ----- ---------- -NextPageToken String -Users JumpCloud.SDK.V2.Models.User[] - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -AllowEmptyFields -[EXPERIMENTAL] Allow empty fields of the user object to be sent in the response - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GsuiteId -. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrderBy -Google Directory API sort field parameter. -See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Query -Google Directory API search parameter. -See https://developers.google.com/admin-sdk/directory/v1/guides/search-users. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortOrder -Google Directory API sort direction parameter. -See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPathsKa8FhwGsuitesGsuiteIdImportJumpcloudusersGetResponses200ContentApplicationJsonSchema - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkIPList.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkIPList.md deleted file mode 100644 index 0f6bd01d1..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkIPList.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkIPList.md -schema: 2.0.0 ---- - -# Get-JcSdkIPList - -## SYNOPSIS -Return a specific IP list. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### List (Default) -``` -Get-JcSdkIPList -ConsoleHost [-Filter >] [-Sort >] [-XTotalCount ] - [] -``` - -### Get -``` -Get-JcSdkIPList -ConsoleHost -Id [] -``` - -### GetViaIdentity -``` -Get-JcSdkIPList -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -Return a specific IP list. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkIPList -Filter:() -Sort:() -XTotalCount:() -``` - ----- ---------- -Description String -Id String -Ips String -Name String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkIPList -Id:() -``` - ----- ---------- -Description String -Id String -Ips String -Name String - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -XTotalCount -. - -```yaml -Type: System.Int32 -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IIPList - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServer.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServer.md deleted file mode 100644 index 16ea5b351..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServer.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServer.md -schema: 2.0.0 ---- - -# Get-JcSdkLdapServer - -## SYNOPSIS -This endpoint returns a specific LDAP server. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### List (Default) -``` -Get-JcSdkLdapServer -ConsoleHost [-Fields >] [-Filter >] - [-Sort >] [] -``` - -### Get -``` -Get-JcSdkLdapServer -ConsoleHost -Id [] -``` - -### GetViaIdentity -``` -Get-JcSdkLdapServer -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -This endpoint returns a specific LDAP server. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkLdapServer -Fields:() -Filter:() -Sort:() -``` - ----- ---------- -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkLdapServer -Id:() -``` - ----- ---------- -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields -The comma separated fields included in the returned records. -If omitted, the default list of fields will be returned. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Unique identifier of the LDAP server. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ILdapServer - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerAssociation.md deleted file mode 100644 index cff658a15..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerAssociation.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerAssociation.md -schema: 2.0.0 ---- - -# Get-JcSdkLdapServerAssociation - -## SYNOPSIS -This endpoint returns the _direct_ associations of this LDAP Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. - -#### Sample Request - -``` - curl -X GET 'https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations?targets=user_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkLdapServerAssociation -ConsoleHost -LdapserverId -Targets - [] -``` - -### GetViaIdentity -``` -Get-JcSdkLdapServerAssociation -ConsoleHost -InputObject -Targets - [] -``` - -## DESCRIPTION -This endpoint returns the _direct_ associations of this LDAP Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. - -#### Sample Request - -``` - curl -X GET 'https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations?targets=user_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkLdapServerAssociation -LdapserverId:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LdapserverId -ObjectID of the LDAP Server. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Targets -Targets which a "active_directory" can be associated to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphConnection - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerSambaDomain.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerSambaDomain.md deleted file mode 100644 index 2c36106ed..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerSambaDomain.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerSambaDomain.md -schema: 2.0.0 ---- - -# Get-JcSdkLdapServerSambaDomain - -## SYNOPSIS -This endpoint returns a specific samba domain for an LDAP server. - -##### Sample Request -``` -curl -X GET \\ - https://console.jumpcloud.com/api/v2/ldapservers/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## SYNTAX - -### List (Default) -``` -Get-JcSdkLdapServerSambaDomain -ConsoleHost -LdapserverId [-Fields >] - [-Filter >] [-Sort >] [] -``` - -### Get -``` -Get-JcSdkLdapServerSambaDomain -ConsoleHost -Id -LdapserverId [] -``` - -### GetViaIdentity -``` -Get-JcSdkLdapServerSambaDomain -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -This endpoint returns a specific samba domain for an LDAP server. - -##### Sample Request -``` -curl -X GET \\ - https://console.jumpcloud.com/api/v2/ldapservers/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkLdapServerSambaDomain -LdapserverId:() -Fields:() -Filter:() -Sort:() -``` - ----- ---------- -Id String -Name String -Sid String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkLdapServerSambaDomain -LdapserverId:() -Id:() -``` - ----- ---------- -Id String -Name String -Sid String - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields -The comma separated fields included in the returned records. -If omitted, the default list of fields will be returned. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Unique identifier of the samba domain. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LdapserverId -Unique identifier of the LDAP server. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISambaDomain - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUser.md deleted file mode 100644 index 57fd589cc..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUser.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUser.md -schema: 2.0.0 ---- - -# Get-JcSdkLdapServerTraverseUser - -## SYNOPSIS -This endpoint will return all Users bound to an LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this LDAP server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this LDAP server instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkLdapServerTraverseUser -ConsoleHost -LdapserverId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkLdapServerTraverseUser -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Users bound to an LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this LDAP server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this LDAP server instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkLdapServerTraverseUser -LdapserverId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LdapserverId -ObjectID of the LDAP Server. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUserGroup.md deleted file mode 100644 index 58a7607e1..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUserGroup.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUserGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkLdapServerTraverseUserGroup - -## SYNOPSIS -This endpoint will return all Users Groups bound to a LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this LDAP server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this LDAP server instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkLdapServerTraverseUserGroup -ConsoleHost -LdapserverId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkLdapServerTraverseUserGroup -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Users Groups bound to a LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this LDAP server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this LDAP server instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkLdapServerTraverseUserGroup -LdapserverId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LdapserverId -ObjectID of the LDAP Server. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkNextScheduledBulkUserState.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkNextScheduledBulkUserState.md deleted file mode 100644 index 2f14a2b4b..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkNextScheduledBulkUserState.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkNextScheduledBulkUserState.md -schema: 2.0.0 ---- - -# Get-JcSdkNextScheduledBulkUserState - -## SYNOPSIS -This endpoint is used to lookup the next upcoming scheduled state change for each user in the -given list. -The users parameter is limited to 100 items per request. -The results are also limited -to 100 items. -This endpoint returns a max of 1 event per state per user. -For example, if a user -has 3 ACTIVATED events scheduled it will return the next upcoming activation event. -However, if a -user also has a SUSPENDED event scheduled along with the ACTIVATED events it will return the next -upcoming activation event _and_ the next upcoming suspension event. - -## SYNTAX - -``` -Get-JcSdkNextScheduledBulkUserState -ConsoleHost -Users > [] -``` - -## DESCRIPTION -This endpoint is used to lookup the next upcoming scheduled state change for each user in the -given list. -The users parameter is limited to 100 items per request. -The results are also limited -to 100 items. -This endpoint returns a max of 1 event per state per user. -For example, if a user -has 3 ACTIVATED events scheduled it will return the next upcoming activation event. -However, if a -user also has a SUSPENDED event scheduled along with the ACTIVATED events it will return the next -upcoming activation event _and_ the next upcoming suspension event. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkNextScheduledBulkUserState -``` - ----- ---------- -EventsCount Int -Results JumpCloud.SDK.V2.Models.ScheduledUserstateResult[] - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Users -A list of system user IDs, limited to 100 items. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPathsUbbqf1BulkUserstatesEventlistNextGetResponses200ContentApplicationJsonSchema - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365.md deleted file mode 100644 index 6f2b67492..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365.md -schema: 2.0.0 ---- - -# Get-JcSdkOffice365 - -## SYNOPSIS -This endpoint returns a specific Office 365 instance. - -##### - -Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkOffice365 -ConsoleHost -Office365Id [] -``` - -### GetViaIdentity -``` -Get-JcSdkOffice365 -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -This endpoint returns a specific Office 365 instance. - -##### - -Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkOffice365 -Office365Id:() -``` - ----- ---------- -DefaultDomainDomain String -DefaultDomainId String -GroupsEnabled Boolean -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Office365Id -ObjectID of the Office 365 instance. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IOffice365 - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365Association.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365Association.md deleted file mode 100644 index e2904378f..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365Association.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365Association.md -schema: 2.0.0 ---- - -# Get-JcSdkOffice365Association - -## SYNOPSIS -This endpoint returns _direct_ associations of an Office 365 instance. - - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations?targets=user_group' \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkOffice365Association -ConsoleHost -Office365Id -Targets - [] -``` - -### GetViaIdentity -``` -Get-JcSdkOffice365Association -ConsoleHost -InputObject -Targets - [] -``` - -## DESCRIPTION -This endpoint returns _direct_ associations of an Office 365 instance. - - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations?targets=user_group' \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkOffice365Association -Office365Id:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Office365Id -ObjectID of the Office 365 instance. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Targets -Targets which a "active_directory" can be associated to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphConnection - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TranslationRule.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TranslationRule.md deleted file mode 100644 index 0d596d0f9..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TranslationRule.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TranslationRule.md -schema: 2.0.0 ---- - -# Get-JcSdkOffice365TranslationRule - -## SYNOPSIS -This endpoint returns a specific translation rule for a specific Office 365 instance. -These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. - -###### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## SYNTAX - -### List (Default) -``` -Get-JcSdkOffice365TranslationRule -ConsoleHost -Office365Id [-Fields >] - [-Filter >] [-Sort >] [] -``` - -### Get -``` -Get-JcSdkOffice365TranslationRule -ConsoleHost -Id -Office365Id - [] -``` - -### GetViaIdentity -``` -Get-JcSdkOffice365TranslationRule -ConsoleHost -InputObject - [] -``` - -## DESCRIPTION -This endpoint returns a specific translation rule for a specific Office 365 instance. -These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. - -###### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkOffice365TranslationRule -Office365Id:() -Fields:() -Filter:() -Sort:() -``` - ----- ---------- -BuiltIn String -Direction String -Id String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkOffice365TranslationRule -Office365Id:() -Id:() -``` - ----- ---------- -BuiltIn String -Direction String -Id String - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields -The comma separated fields included in the returned records. -If omitted, the default list of fields will be returned. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Office365Id -. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IOffice365TranslationRule - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUser.md deleted file mode 100644 index 4bc02677a..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUser.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUser.md -schema: 2.0.0 ---- - -# Get-JcSdkOffice365TraverseUser - -## SYNOPSIS -This endpoint will return all Users bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Office 365 instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Office 365 instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkOffice365TraverseUser -ConsoleHost -Office365Id [-Filter >] - [-SyncStatus] [] -``` - -### GetViaIdentity -``` -Get-JcSdkOffice365TraverseUser -ConsoleHost -InputObject - [-Filter >] [-SyncStatus] [] -``` - -## DESCRIPTION -This endpoint will return all Users bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Office 365 instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Office 365 instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkOffice365TraverseUser -Office365Id:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Office365Id -ObjectID of the Office 365 suite. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncStatus -Include sync status for users - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUserGroup.md deleted file mode 100644 index c8cf648a0..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUserGroup.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUserGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkOffice365TraverseUserGroup - -## SYNOPSIS -This endpoint will return all Users Groups bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Office 365 instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Office 365 instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkOffice365TraverseUserGroup -ConsoleHost -Office365Id [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkOffice365TraverseUserGroup -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Users Groups bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Office 365 instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Office 365 instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkOffice365TraverseUserGroup -Office365Id:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Office365Id -ObjectID of the Office 365 suite. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365UsersToImport.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365UsersToImport.md deleted file mode 100644 index 552109d8c..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365UsersToImport.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365UsersToImport.md -schema: 2.0.0 ---- - -# Get-JcSdkOffice365UsersToImport - -## SYNOPSIS -Lists Office 365 users available for import. - -## SYNTAX - -``` -Get-JcSdkOffice365UsersToImport -ConsoleHost -Office365Id [-Count] [-Filter ] - [-Orderby ] [-Search ] [-ConsistencyLevel ] [] -``` - -## DESCRIPTION -Lists Office 365 users available for import. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkOffice365UsersToImport -``` - ----- ---------- -SkipToken String -Top Int -Users JumpCloud.SDK.V2.Models.Paths1Hu9JikOffice365SOffice365IdImportUsersGetResponses200ContentApplicationJsonSchemaPropertiesUsersItem… - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsistencyLevel -Defines the consistency header for O365 requests. -See https://docs.microsoft.com/en-us/graph/api/user-list?view=graph-rest-1.0&tabs=http#request-headers - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Count -Office 365 API count parameter. -See https://docs.microsoft.com/en-us/graph/api/user-list?view=graph-rest-1.0&tabs=http#optional-query-parameters. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Office 365 API filter parameter. -See https://docs.microsoft.com/en-us/graph/api/user-list?view=graph-rest-1.0&tabs=http#optional-query-parameters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Office365Id -. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Orderby -Office 365 API orderby parameter. -See https://docs.microsoft.com/en-us/graph/api/user-list?view=graph-rest-1.0&tabs=http#optional-query-parameters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Search -Office 365 API search parameter. -See https://docs.microsoft.com/en-us/graph/api/user-list?view=graph-rest-1.0&tabs=http#optional-query-parameters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPaths1J0ThkrOffice365SOffice365IdImportUsersGetResponses200ContentApplicationJsonSchema - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOrganizationPolicyResult.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOrganizationPolicyResult.md deleted file mode 100644 index c1229448b..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOrganizationPolicyResult.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOrganizationPolicyResult.md -schema: 2.0.0 ---- - -# Get-JcSdkOrganizationPolicyResult - -## SYNOPSIS -This endpoint returns all policy results for an organization. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## SYNTAX - -``` -Get-JcSdkOrganizationPolicyResult -ConsoleHost [-Fields >] [-Filter >] - [-Sort >] [] -``` - -## DESCRIPTION -This endpoint returns all policy results for an organization. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkOrganizationPolicyResult -``` - ----- ---------- -Detail String -EndedAt Datetime -ExitStatus System.Nullable[long] ExitStatus {get;set;} -Id String -PolicyId String -StartedAt Datetime -State String -StdErr String -StdOut String -Success Boolean -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields -The comma separated fields included in the returned records. -If omitted, the default list of fields will be returned. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPolicyResult - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicy.md deleted file mode 100644 index 0b903f6e5..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicy.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicy.md -schema: 2.0.0 ---- - -# Get-JcSdkPolicy - -## SYNOPSIS -This endpoint returns a specific policy. - -###### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/policies/{PolicyID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## SYNTAX - -### List (Default) -``` -Get-JcSdkPolicy -ConsoleHost [-Fields >] [-Filter >] [-Sort >] - [] -``` - -### Get -``` -Get-JcSdkPolicy -ConsoleHost -Id [] -``` - -### GetViaIdentity -``` -Get-JcSdkPolicy -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -This endpoint returns a specific policy. - -###### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/policies/{PolicyID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkPolicy -Fields:() -Filter:() -Sort:() -``` - ----- ---------- -Id String -Name String -TemplateActivation String -TemplateAlert String -TemplateBehavior String -TemplateDeliveryTypes String -TemplateDescription String -TemplateDisplayName String -TemplateId String -TemplateName String -TemplateOSMetaFamily String -TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] -TemplateReference String -TemplateState String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkPolicy -Id:() -``` - ----- ---------- -Id String -Name String -TemplateActivation String -TemplateAlert String -TemplateBehavior String -TemplateDeliveryTypes String -TemplateDescription String -TemplateDisplayName String -TemplateId String -TemplateName String -TemplateOSMetaFamily String -TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] -TemplateReference String -TemplateState String - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields -The comma separated fields included in the returned records. -If omitted, the default list of fields will be returned. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -ObjectID of the Policy object. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPolicy - -### JumpCloud.SDK.V2.Models.IPolicyWithDetails - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyAssociation.md deleted file mode 100644 index b219d63fc..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyAssociation.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyAssociation.md -schema: 2.0.0 ---- - -# Get-JcSdkPolicyAssociation - -## SYNOPSIS -This endpoint returns the _direct_ associations of a Policy. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations?targets=system_group \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkPolicyAssociation -ConsoleHost -PolicyId -Targets [] -``` - -### GetViaIdentity -``` -Get-JcSdkPolicyAssociation -ConsoleHost -InputObject -Targets - [] -``` - -## DESCRIPTION -This endpoint returns the _direct_ associations of a Policy. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations?targets=system_group \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkPolicyAssociation -PolicyId:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PolicyId -ObjectID of the Policy. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Targets -Targets which a "active_directory" can be associated to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphConnection - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroup.md deleted file mode 100644 index df3c8ff3e..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroup.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkPolicyGroup - -## SYNOPSIS -This endpoint returns the details of a Policy Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### List (Default) -``` -Get-JcSdkPolicyGroup -ConsoleHost [-Fields >] [-Filter >] - [-Sort >] [] -``` - -### Get -``` -Get-JcSdkPolicyGroup -ConsoleHost -Id [] -``` - -### GetViaIdentity -``` -Get-JcSdkPolicyGroup -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -This endpoint returns the details of a Policy Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkPolicyGroup -Fields:() -Filter:() -Sort:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -Name String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkPolicyGroup -Id:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -Name String -Type String - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields -The comma separated fields included in the returned records. -If omitted, the default list of fields will be returned. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -ObjectID of the Policy Group. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPolicyGroup - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupAssociation.md deleted file mode 100644 index d64e50f4e..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupAssociation.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupAssociation.md -schema: 2.0.0 ---- - -# Get-JcSdkPolicyGroupAssociation - -## SYNOPSIS -This endpoint returns the _direct_ associations of this Policy Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations?targets=system \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -``` -Get-JcSdkPolicyGroupAssociation -ConsoleHost -GroupId -Targets [] -``` - -## DESCRIPTION -This endpoint returns the _direct_ associations of this Policy Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations?targets=system \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkPolicyGroupAssociation -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the Policy Group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Targets -Targets which a "active_directory" can be associated to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphConnection - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMember.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMember.md deleted file mode 100644 index bc19f040c..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMember.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMember.md -schema: 2.0.0 ---- - -# Get-JcSdkPolicyGroupMember - -## SYNOPSIS -This endpoint returns all the Policy Groups a Policy is a member of. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/memberof \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkPolicyGroupMember -ConsoleHost -PolicyId [-Filter >] - [-Sort >] [-Authorization ] [-Date ] [] -``` - -### GetViaIdentity -``` -Get-JcSdkPolicyGroupMember -ConsoleHost -InputObject [-Filter >] - [-Sort >] [-Authorization ] [-Date ] [] -``` - -### List -``` -Get-JcSdkPolicyGroupMember -ConsoleHost -GroupId [] -``` - -## DESCRIPTION -This endpoint returns all the Policy Groups a Policy is a member of. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/memberof \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkPolicyGroupMember -PolicyId:() -Filter:() -Sort:() -Authorization:() -Date:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkPolicyGroupMember -GroupId:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -## PARAMETERS - -### -Authorization -Authorization header for the System Context API - -```yaml -Type: System.String -Parameter Sets: Get, GetViaIdentity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Date -Current date header for the System Context API - -```yaml -Type: System.String -Parameter Sets: Get, GetViaIdentity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: Get, GetViaIdentity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the Policy Group. - -```yaml -Type: System.String -Parameter Sets: List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PolicyId -ObjectID of the Policy. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: Get, GetViaIdentity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphConnection - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - From 5a73a4ff28359a3c3718f046398ffdf814d0976c Mon Sep 17 00:00:00 2001 From: Joe Workman Date: Mon, 11 May 2026 08:56:46 -0600 Subject: [PATCH 03/11] generate --- .../generated/Clear-JcSdkAppleMdmDevice.ps1 | 78 +++- ...lear-JcSdkAppleMdmDeviceActivationLock.ps1 | 73 +++- .../generated/Get-JcSdkAccessRequest.ps1 | 53 ++- .../Get-JcSdkAccessRequestProgress.ps1 | 49 ++- .../generated/Get-JcSdkActiveDirectory.ps1 | 89 ++++- .../Get-JcSdkActiveDirectoryAgent.ps1 | 91 ++++- .../Get-JcSdkActiveDirectoryAssociation.ps1 | 88 ++++- .../Get-JcSdkActiveDirectoryTraverseUser.ps1 | 95 ++++- ...-JcSdkActiveDirectoryTraverseUserGroup.ps1 | 95 ++++- .../Get-JcSdkAdministratorOrganization.ps1 | 29 +- ...Get-JcSdkAdministratorOrganizationLink.ps1 | 29 +- .../custom/generated/Get-JcSdkAppleMdm.ps1 | 41 +- .../generated/Get-JcSdkAppleMdmDevice.ps1 | 129 ++++++- .../Get-JcSdkAppleMdmEnrollmentProfile.ps1 | 43 ++- .../Get-JcSdkApplicationAssociation.ps1 | 86 ++++- .../Get-JcSdkApplicationTraverseUser.ps1 | 95 ++++- .../Get-JcSdkApplicationTraverseUserGroup.ps1 | 95 ++++- .../generated/Get-JcSdkApprovalFlow.ps1 | 53 ++- .../Get-JcSdkApprovalFlowSetting.ps1 | 17 +- .../Get-JcSdkAuthenticationPolicy.ps1 | 109 +++++- .../generated/Get-JcSdkBulkUserState.ps1 | 45 ++- .../generated/Get-JcSdkBulkUsersResult.ps1 | 84 ++++- .../generated/Get-JcSdkCommandAssociation.ps1 | 88 ++++- .../Get-JcSdkCommandTraverseSystem.ps1 | 95 ++++- .../Get-JcSdkCommandTraverseSystemGroup.ps1 | 95 ++++- .../Get-JcSdkCustomEmailConfiguration.ps1 | 67 +++- .../Get-JcSdkCustomEmailTemplate.ps1 | 31 +- .../custom/generated/Get-JcSdkDirectory.ps1 | 49 ++- .../custom/generated/Get-JcSdkDuoAccount.ps1 | 83 ++++- .../generated/Get-JcSdkDuoApplication.ps1 | 87 ++++- .../custom/generated/Get-JcSdkGSuite.ps1 | 84 ++++- .../generated/Get-JcSdkGSuiteAssociation.ps1 | 88 ++++- .../Get-JcSdkGSuiteTranslationRule.ps1 | 89 ++++- .../generated/Get-JcSdkGSuiteTraverseUser.ps1 | 95 ++++- .../Get-JcSdkGSuiteTraverseUserGroup.ps1 | 95 ++++- .../Get-JcSdkGSuiteUsersToImport.ps1 | 29 +- .../custom/generated/Get-JcSdkGroup.ps1 | 65 +++- .../Get-JcSdkGsuiteUsersToImportFormatted.ps1 | 29 +- .../custom/generated/Get-JcSdkIPList.ps1 | 87 ++++- .../custom/generated/Get-JcSdkLdapServer.ps1 | 89 ++++- .../Get-JcSdkLdapServerAssociation.ps1 | 88 ++++- .../Get-JcSdkLdapServerSambaDomain.ps1 | 87 ++++- .../Get-JcSdkLdapServerTraverseUser.ps1 | 95 ++++- .../Get-JcSdkLdapServerTraverseUserGroup.ps1 | 95 ++++- .../Get-JcSdkNextScheduledBulkUserState.ps1 | 49 ++- .../custom/generated/Get-JcSdkOffice365.ps1 | 90 ++++- .../Get-JcSdkOffice365Association.ps1 | 90 ++++- .../Get-JcSdkOffice365TranslationRule.ps1 | 89 ++++- .../Get-JcSdkOffice365TraverseUser.ps1 | 95 ++++- .../Get-JcSdkOffice365TraverseUserGroup.ps1 | 95 ++++- .../Get-JcSdkOffice365UsersToImport.ps1 | 30 +- .../Get-JcSdkOrganizationPolicyResult.ps1 | 56 ++- .../custom/generated/Get-JcSdkPolicy.ps1 | 111 +++++- .../generated/Get-JcSdkPolicyAssociation.ps1 | 86 ++++- .../custom/generated/Get-JcSdkPolicyGroup.ps1 | 91 ++++- .../Get-JcSdkPolicyGroupAssociation.ps1 | 56 ++- .../generated/Get-JcSdkPolicyGroupMember.ps1 | 97 ++++- .../Get-JcSdkPolicyGroupMembership.ps1 | 79 +++- .../Get-JcSdkPolicyGroupTraverseSystem.ps1 | 95 ++++- ...et-JcSdkPolicyGroupTraverseSystemGroup.ps1 | 95 ++++- .../generated/Get-JcSdkPolicyResult.ps1 | 101 ++++- .../generated/Get-JcSdkPolicyStatus.ps1 | 56 ++- .../generated/Get-JcSdkPolicyTemplate.ps1 | 105 +++++- .../Get-JcSdkPolicyTraverseSystem.ps1 | 95 ++++- .../Get-JcSdkPolicyTraverseSystemGroup.ps1 | 95 ++++- .../Get-JcSdkProviderAdministrator.ps1 | 31 +- .../Get-JcSdkProviderOrganization.ps1 | 31 +- .../generated/Get-JcSdkProvidersInvoice.ps1 | 63 +++- .../Get-JcSdkRadiusServerAssociation.ps1 | 86 ++++- .../Get-JcSdkRadiusServerTraverseUser.ps1 | 97 ++++- ...Get-JcSdkRadiusServerTraverseUserGroup.ps1 | 95 ++++- .../custom/generated/Get-JcSdkSoftwareApp.ps1 | 87 ++++- .../Get-JcSdkSoftwareAppAssociation.ps1 | 86 ++++- .../generated/Get-JcSdkSoftwareAppStatus.ps1 | 83 ++++- .../Get-JcSdkSoftwareAppTraverseSystem.ps1 | 95 ++++- ...et-JcSdkSoftwareAppTraverseSystemGroup.ps1 | 95 ++++- .../generated/Get-JcSdkSubscription.ps1 | 51 ++- .../generated/Get-JcSdkSystemAssociation.ps1 | 90 ++++- .../generated/Get-JcSdkSystemFdeKey.ps1 | 55 ++- .../custom/generated/Get-JcSdkSystemGroup.ps1 | 101 ++++- .../Get-JcSdkSystemGroupAssociation.ps1 | 88 ++++- .../generated/Get-JcSdkSystemGroupMember.ps1 | 84 ++++- .../Get-JcSdkSystemGroupMembership.ps1 | 81 +++- .../Get-JcSdkSystemGroupTraverseCommand.ps1 | 104 +++++- .../Get-JcSdkSystemGroupTraversePolicy.ps1 | 99 ++++- ...et-JcSdkSystemGroupTraversePolicyGroup.ps1 | 97 ++++- .../Get-JcSdkSystemGroupTraverseUser.ps1 | 95 ++++- .../Get-JcSdkSystemGroupTraverseUserGroup.ps1 | 97 ++++- .../generated/Get-JcSdkSystemInsightAlf.ps1 | 36 +- .../Get-JcSdkSystemInsightAlfException.ps1 | 31 +- .../Get-JcSdkSystemInsightAlfExplicitAuth.ps1 | 30 +- .../generated/Get-JcSdkSystemInsightApp.ps1 | 54 ++- .../Get-JcSdkSystemInsightAppCompatShim.ps1 | 35 +- .../Get-JcSdkSystemInsightAuthorizedKey.ps1 | 33 +- ...cSdkSystemInsightAzureInstanceMetadata.ps1 | 45 ++- ...Get-JcSdkSystemInsightAzureInstanceTag.ps1 | 32 +- .../Get-JcSdkSystemInsightBattery.ps1 | 47 ++- .../Get-JcSdkSystemInsightBitlockerInfo.ps1 | 35 +- .../Get-JcSdkSystemInsightBrowserPlugin.ps1 | 39 +- .../Get-JcSdkSystemInsightCertificate.ps1 | 49 ++- .../Get-JcSdkSystemInsightChassisInfo.ps1 | 42 ++- .../Get-JcSdkSystemInsightChromeExtension.ps1 | 40 +- .../Get-JcSdkSystemInsightConnectivity.ps1 | 38 +- .../generated/Get-JcSdkSystemInsightCrash.ps1 | 45 ++- .../Get-JcSdkSystemInsightCupDestination.ps1 | 31 +- .../Get-JcSdkSystemInsightDiskEncryption.ps1 | 36 +- .../Get-JcSdkSystemInsightDiskInfo.ps1 | 40 +- .../Get-JcSdkSystemInsightDnsResolver.ps1 | 34 +- .../Get-JcSdkSystemInsightEtcHost.ps1 | 31 +- .../Get-JcSdkSystemInsightFirefoxAddon.ps1 | 43 ++- .../generated/Get-JcSdkSystemInsightGroup.ps1 | 34 +- .../Get-JcSdkSystemInsightIeExtension.ps1 | 33 +- ...Get-JcSdkSystemInsightInterfaceAddress.ps1 | 36 +- .../Get-JcSdkSystemInsightInterfaceDetail.ps1 | 63 +++- .../Get-JcSdkSystemInsightKernelInfo.ps1 | 33 +- .../Get-JcSdkSystemInsightLaunchd.ps1 | 50 ++- .../Get-JcSdkSystemInsightLinuxPackage.ps1 | 47 ++- .../Get-JcSdkSystemInsightLoggedinUser.ps1 | 35 +- .../Get-JcSdkSystemInsightLogicalDrive.ps1 | 35 +- .../Get-JcSdkSystemInsightManagedPolicy.ps1 | 35 +- .../generated/Get-JcSdkSystemInsightMount.ps1 | 40 +- .../Get-JcSdkSystemInsightOSVersion.ps1 | 39 +- .../generated/Get-JcSdkSystemInsightPatch.ps1 | 37 +- .../Get-JcSdkSystemInsightProgram.ps1 | 44 ++- .../Get-JcSdkSystemInsightPythonPackage.ps1 | 35 +- .../Get-JcSdkSystemInsightSafariExtension.ps1 | 39 +- .../Get-JcSdkSystemInsightScheduledTask.ps1 | 38 +- .../Get-JcSdkSystemInsightSecureboot.ps1 | 31 +- .../Get-JcSdkSystemInsightService.ps1 | 40 +- .../Get-JcSdkSystemInsightShadow.ps1 | 39 +- .../Get-JcSdkSystemInsightSharedFolder.ps1 | 31 +- .../Get-JcSdkSystemInsightSharedResource.ps1 | 37 +- ...et-JcSdkSystemInsightSharingPreference.ps1 | 39 +- .../Get-JcSdkSystemInsightSipConfig.ps1 | 32 +- .../Get-JcSdkSystemInsightStartupItem.ps1 | 35 +- .../Get-JcSdkSystemInsightSystemControl.ps1 | 36 +- .../Get-JcSdkSystemInsightSystemInfo.ps1 | 44 ++- .../Get-JcSdkSystemInsightTpmInfo.ps1 | 38 +- .../Get-JcSdkSystemInsightUptime.ps1 | 34 +- .../Get-JcSdkSystemInsightUsbDevice.ps1 | 41 +- .../generated/Get-JcSdkSystemInsightUser.ps1 | 45 ++- .../Get-JcSdkSystemInsightUserAssist.ps1 | 33 +- .../Get-JcSdkSystemInsightUserGroup.ps1 | 31 +- .../Get-JcSdkSystemInsightUserSshKey.ps1 | 32 +- .../Get-JcSdkSystemInsightWifiNetwork.ps1 | 41 +- .../Get-JcSdkSystemInsightWifiStatus.ps1 | 42 ++- ...cSdkSystemInsightWindowsSecurityCenter.ps1 | 36 +- ...SdkSystemInsightWindowsSecurityProduct.ps1 | 35 +- .../generated/Get-JcSdkSystemMember.ps1 | 81 +++- .../generated/Get-JcSdkSystemPolicyStatus.ps1 | 58 ++- .../Get-JcSdkSystemTraverseCommand.ps1 | 106 +++++- .../Get-JcSdkSystemTraversePolicy.ps1 | 103 +++++- .../Get-JcSdkSystemTraversePolicyGroup.ps1 | 97 ++++- .../generated/Get-JcSdkSystemTraverseUser.ps1 | 97 ++++- .../Get-JcSdkSystemTraverseUserGroup.ps1 | 97 ++++- .../generated/Get-JcSdkUserAssociation.ps1 | 90 ++++- .../custom/generated/Get-JcSdkUserGroup.ps1 | 107 +++++- .../Get-JcSdkUserGroupAssociation.ps1 | 88 ++++- .../generated/Get-JcSdkUserGroupMember.ps1 | 82 +++- .../Get-JcSdkUserGroupMembership.ps1 | 79 +++- ...-JcSdkUserGroupTraverseActiveDirectory.ps1 | 91 ++++- .../Get-JcSdkUserGroupTraverseApplication.ps1 | 95 ++++- .../Get-JcSdkUserGroupTraverseDirectory.ps1 | 97 ++++- .../Get-JcSdkUserGroupTraverseGSuite.ps1 | 97 ++++- .../Get-JcSdkUserGroupTraverseLdapServer.ps1 | 95 ++++- .../Get-JcSdkUserGroupTraverseOffice365.ps1 | 95 ++++- ...Get-JcSdkUserGroupTraverseRadiusServer.ps1 | 97 ++++- .../Get-JcSdkUserGroupTraverseSystem.ps1 | 95 ++++- .../Get-JcSdkUserGroupTraverseSystemGroup.ps1 | 95 ++++- .../custom/generated/Get-JcSdkUserMember.ps1 | 79 +++- .../generated/Get-JcSdkUserPushEndpoint.ps1 | 85 ++++- .../Get-JcSdkUserTraverseActiveDirectory.ps1 | 95 ++++- .../Get-JcSdkUserTraverseApplication.ps1 | 95 ++++- .../Get-JcSdkUserTraverseDirectory.ps1 | 95 ++++- .../generated/Get-JcSdkUserTraverseGSuite.ps1 | 95 ++++- .../Get-JcSdkUserTraverseLdapServer.ps1 | 95 ++++- .../Get-JcSdkUserTraverseOffice365.ps1 | 95 ++++- .../Get-JcSdkUserTraverseRadiusServer.ps1 | 95 ++++- .../generated/Get-JcSdkUserTraverseSystem.ps1 | 95 ++++- .../Get-JcSdkUserTraverseSystemGroup.ps1 | 95 ++++- .../custom/generated/Get-JcSdkWorkday.ps1 | 101 ++++- .../generated/Get-JcSdkWorkdayWorker.ps1 | 86 ++++- .../custom/generated/Grant-JcSdkWorkday.ps1 | 110 +++++- .../custom/generated/Import-JcSdkScim.ps1 | 61 ++- .../custom/generated/Import-JcSdkWorkday.ps1 | 167 ++++++++- .../generated/Import-JcSdkWorkdayResult.ps1 | 82 +++- .../Invoke-JcSdkReclaimSoftwareAppLicense.ps1 | 79 +++- .../generated/Lock-JcSdkAppleMdmDevice.ps1 | 78 +++- .../generated/New-JcSdkActiveDirectory.ps1 | 76 +++- .../New-JcSdkActiveDirectoryAgent.ps1 | 102 ++++- .../New-JcSdkAdministratorOrganization.ps1 | 72 +++- .../generated/New-JcSdkApprovalFlow.ps1 | 61 ++- .../New-JcSdkAuthenticationPolicy.ps1 | 168 ++++++++- .../custom/generated/New-JcSdkBulkUser.ps1 | 193 +++++++++- .../generated/New-JcSdkBulkUserState.ps1 | 76 +++- .../New-JcSdkCustomEmailConfiguration.ps1 | 66 +++- .../custom/generated/New-JcSdkDuoAccount.ps1 | 51 ++- .../generated/New-JcSdkDuoApplication.ps1 | 107 +++++- .../New-JcSdkGSuiteTranslationRule.ps1 | 99 ++++- .../custom/generated/New-JcSdkIPList.ps1 | 82 +++- .../New-JcSdkLdapServerSambaDomain.ps1 | 99 ++++- .../New-JcSdkOffice365TranslationRule.ps1 | 99 ++++- .../custom/generated/New-JcSdkPolicy.ps1 | 109 +++++- .../custom/generated/New-JcSdkPolicyGroup.ps1 | 74 +++- .../New-JcSdkProviderAdministrator.ps1 | 106 +++++- .../custom/generated/New-JcSdkSoftwareApp.ps1 | 236 +++++++++++- .../custom/generated/New-JcSdkSystemGroup.ps1 | 109 +++++- .../custom/generated/New-JcSdkUserGroup.ps1 | 125 ++++++- .../custom/generated/New-JcSdkWorkday.ps1 | 114 +++++- .../generated/Remove-JcSdkActiveDirectory.ps1 | 79 +++- .../Remove-JcSdkActiveDirectoryAgent.ps1 | 71 +++- .../Remove-JcSdkAdministratorOrganization.ps1 | 55 ++- .../custom/generated/Remove-JcSdkAppleMdm.ps1 | 112 +++++- .../generated/Remove-JcSdkAppleMdmDevice.ps1 | 99 ++++- .../generated/Remove-JcSdkApplicationLogo.ps1 | 55 ++- .../generated/Remove-JcSdkApprovalFlow.ps1 | 51 ++- .../Remove-JcSdkAuthenticationPolicy.ps1 | 90 ++++- .../generated/Remove-JcSdkBulkUserState.ps1 | 69 +++- .../Remove-JcSdkCustomEmailConfiguration.ps1 | 55 ++- .../generated/Remove-JcSdkDuoAccount.ps1 | 77 +++- .../generated/Remove-JcSdkDuoApplication.ps1 | 79 +++- .../Remove-JcSdkGSuiteTranslationRule.ps1 | 75 +++- .../custom/generated/Remove-JcSdkIPList.ps1 | 79 +++- .../Remove-JcSdkLdapServerSambaDomain.ps1 | 71 +++- .../Remove-JcSdkOffice365TranslationRule.ps1 | 75 +++- .../custom/generated/Remove-JcSdkPolicy.ps1 | 73 +++- .../generated/Remove-JcSdkPolicyGroup.ps1 | 83 ++++- .../Remove-JcSdkProviderAdministrator.ps1 | 57 ++- .../generated/Remove-JcSdkSoftwareApp.ps1 | 75 +++- .../generated/Remove-JcSdkSystemGroup.ps1 | 88 ++++- .../generated/Remove-JcSdkUserGroup.ps1 | 91 ++++- .../Remove-JcSdkUserPushEndpoint.ps1 | 70 +++- .../Remove-JcSdkWorkdayAuthorization.ps1 | 71 +++- .../generated/Restart-JcSdkAppleMdmDevice.ps1 | 78 +++- .../generated/Set-JcSdkAccessRequest.ps1 | 61 ++- .../Set-JcSdkAccessRequestApproval.ps1 | 32 +- .../Set-JcSdkActiveDirectoryAssociation.ps1 | 94 ++++- .../custom/generated/Set-JcSdkAppleMdm.ps1 | 209 ++++++++++- .../Set-JcSdkApplicationAssociation.ps1 | 92 ++++- .../generated/Set-JcSdkApprovalFlow.ps1 | 89 ++++- .../Set-JcSdkApprovalFlowSetting.ps1 | 40 +- .../generated/Set-JcSdkCommandAssociation.ps1 | 96 ++++- .../Set-JcSdkCustomEmailConfiguration.ps1 | 94 ++++- .../generated/Set-JcSdkDuoApplication.ps1 | 107 +++++- .../generated/Set-JcSdkGSuiteAssociation.ps1 | 96 ++++- .../custom/generated/Set-JcSdkIPList.ps1 | 106 +++++- .../Set-JcSdkLdapServerAssociation.ps1 | 94 ++++- .../Set-JcSdkLdapServerSambaDomain.ps1 | 99 ++++- .../Set-JcSdkOffice365Association.ps1 | 94 ++++- .../custom/generated/Set-JcSdkPolicy.ps1 | 132 ++++++- .../generated/Set-JcSdkPolicyAssociation.ps1 | 94 ++++- .../custom/generated/Set-JcSdkPolicyGroup.ps1 | 102 ++++- .../Set-JcSdkPolicyGroupAssociation.ps1 | 96 ++++- .../generated/Set-JcSdkPolicyGroupMember.ps1 | 89 ++++- .../Set-JcSdkRadiusServerAssociation.ps1 | 98 ++++- .../custom/generated/Set-JcSdkSoftwareApp.ps1 | 350 +++++++++++++++++- .../Set-JcSdkSoftwareAppAssociation.ps1 | 90 ++++- .../generated/Set-JcSdkSystemAssociation.ps1 | 110 +++++- .../custom/generated/Set-JcSdkSystemGroup.ps1 | 135 ++++++- .../Set-JcSdkSystemGroupAssociation.ps1 | 96 ++++- .../generated/Set-JcSdkSystemGroupMember.ps1 | 89 ++++- .../generated/Set-JcSdkUserAssociation.ps1 | 110 +++++- .../custom/generated/Set-JcSdkUserGroup.ps1 | 153 +++++++- .../Set-JcSdkUserGroupAssociation.ps1 | 96 ++++- .../generated/Set-JcSdkUserGroupMember.ps1 | 89 ++++- .../custom/generated/Set-JcSdkWorkday.ps1 | 117 +++++- .../generated/Stop-JcSdkAppleMdmDevice.ps1 | 73 +++- .../generated/Sync-JcSdkAppleMdmDevice.ps1 | 73 +++- ...ate-JcSdkAppleMdmDeviceLockInformation.ps1 | 75 +++- .../Update-JcSdkAuthenticationPolicy.ps1 | 160 +++++++- .../custom/generated/Update-JcSdkBulkUser.ps1 | 156 +++++++- .../custom/generated/Update-JcSdkGSuite.ps1 | 164 +++++++- .../custom/generated/Update-JcSdkIPList.ps1 | 96 ++++- .../generated/Update-JcSdkLdapServer.ps1 | 104 +++++- .../generated/Update-JcSdkOffice365.ps1 | 168 ++++++++- .../Update-JcSdkUserPushEndpoint.ps1 | 91 ++++- .../exports/Get-JcSdkPolicyGroupMembership.md | 45 +-- .../Get-JcSdkPolicyGroupTraverseSystem.md | 56 +-- ...Get-JcSdkPolicyGroupTraverseSystemGroup.md | 56 +-- .../docs/exports/Get-JcSdkPolicyResult.md | 52 +-- .../docs/exports/Get-JcSdkPolicyStatus.md | 48 +-- .../docs/exports/Get-JcSdkPolicyTemplate.md | 50 +-- .../exports/Get-JcSdkPolicyTraverseSystem.md | 56 +-- .../Get-JcSdkPolicyTraverseSystemGroup.md | 56 +-- .../exports/Get-JcSdkProviderAdministrator.md | 41 +- .../exports/Get-JcSdkProviderOrganization.md | 41 +- .../docs/exports/Get-JcSdkProvidersInvoice.md | 35 +- .../Get-JcSdkRadiusServerAssociation.md | 31 +- .../Get-JcSdkRadiusServerTraverseUser.md | 58 +-- .../Get-JcSdkRadiusServerTraverseUserGroup.md | 56 +-- .../docs/exports/Get-JcSdkSoftwareApp.md | 47 +-- .../Get-JcSdkSoftwareAppAssociation.md | 31 +- .../exports/Get-JcSdkSoftwareAppStatus.md | 45 +-- .../Get-JcSdkSoftwareAppTraverseSystem.md | 56 +-- ...Get-JcSdkSoftwareAppTraverseSystemGroup.md | 56 +-- .../docs/exports/Get-JcSdkSubscription.md | 21 +- .../exports/Get-JcSdkSystemAssociation.md | 39 +- .../docs/exports/Get-JcSdkSystemFdeKey.md | 13 +- .../docs/exports/Get-JcSdkSystemGroup.md | 50 +-- .../Get-JcSdkSystemGroupAssociation.md | 33 +- .../exports/Get-JcSdkSystemGroupMember.md | 27 +- .../exports/Get-JcSdkSystemGroupMembership.md | 47 +-- .../Get-JcSdkSystemGroupTraverseCommand.md | 58 +-- .../Get-JcSdkSystemGroupTraversePolicy.md | 60 +-- ...Get-JcSdkSystemGroupTraversePolicyGroup.md | 58 +-- .../Get-JcSdkSystemGroupTraverseUser.md | 56 +-- .../Get-JcSdkSystemGroupTraverseUserGroup.md | 58 +-- .../docs/exports/Get-JcSdkSystemInsightAlf.md | 27 +- .../Get-JcSdkSystemInsightAlfException.md | 27 +- .../Get-JcSdkSystemInsightAlfExplicitAuth.md | 27 +- .../docs/exports/Get-JcSdkSystemInsightApp.md | 29 +- .../Get-JcSdkSystemInsightAppCompatShim.md | 27 +- .../Get-JcSdkSystemInsightAuthorizedKey.md | 27 +- ...JcSdkSystemInsightAzureInstanceMetadata.md | 27 +- .../Get-JcSdkSystemInsightAzureInstanceTag.md | 27 +- .../exports/Get-JcSdkSystemInsightBattery.md | 27 +- .../Get-JcSdkSystemInsightBitlockerInfo.md | 27 +- .../Get-JcSdkSystemInsightBrowserPlugin.md | 27 +- .../Get-JcSdkSystemInsightCertificate.md | 27 +- .../Get-JcSdkSystemInsightChassisInfo.md | 27 +- .../Get-JcSdkSystemInsightChromeExtension.md | 27 +- .../Get-JcSdkSystemInsightConnectivity.md | 27 +- .../exports/Get-JcSdkSystemInsightCrash.md | 27 +- .../Get-JcSdkSystemInsightCupDestination.md | 27 +- .../Get-JcSdkSystemInsightDiskEncryption.md | 27 +- .../exports/Get-JcSdkSystemInsightDiskInfo.md | 27 +- .../Get-JcSdkSystemInsightDnsResolver.md | 27 +- .../exports/Get-JcSdkSystemInsightEtcHost.md | 27 +- .../Get-JcSdkSystemInsightFirefoxAddon.md | 27 +- .../exports/Get-JcSdkSystemInsightGroup.md | 27 +- .../Get-JcSdkSystemInsightIeExtension.md | 27 +- .../Get-JcSdkSystemInsightInterfaceAddress.md | 27 +- .../Get-JcSdkSystemInsightInterfaceDetail.md | 27 +- .../Get-JcSdkSystemInsightKernelInfo.md | 27 +- .../exports/Get-JcSdkSystemInsightLaunchd.md | 27 +- .../Get-JcSdkSystemInsightLinuxPackage.md | 31 +- .../Get-JcSdkSystemInsightLoggedinUser.md | 27 +- .../Get-JcSdkSystemInsightLogicalDrive.md | 27 +- .../Get-JcSdkSystemInsightManagedPolicy.md | 27 +- .../exports/Get-JcSdkSystemInsightMount.md | 27 +- .../Get-JcSdkSystemInsightOSVersion.md | 27 +- .../exports/Get-JcSdkSystemInsightPatch.md | 27 +- .../exports/Get-JcSdkSystemInsightProgram.md | 29 +- .../Get-JcSdkSystemInsightPythonPackage.md | 27 +- .../Get-JcSdkSystemInsightSafariExtension.md | 27 +- .../Get-JcSdkSystemInsightScheduledTask.md | 27 +- .../Get-JcSdkSystemInsightSecureboot.md | 27 +- .../exports/Get-JcSdkSystemInsightService.md | 27 +- .../exports/Get-JcSdkSystemInsightShadow.md | 27 +- .../Get-JcSdkSystemInsightSharedFolder.md | 27 +- .../Get-JcSdkSystemInsightSharedResource.md | 27 +- ...Get-JcSdkSystemInsightSharingPreference.md | 27 +- .../Get-JcSdkSystemInsightSipConfig.md | 27 +- .../Get-JcSdkSystemInsightStartupItem.md | 27 +- .../Get-JcSdkSystemInsightSystemControl.md | 27 +- .../Get-JcSdkSystemInsightSystemInfo.md | 27 +- .../exports/Get-JcSdkSystemInsightTpmInfo.md | 27 +- .../exports/Get-JcSdkSystemInsightUptime.md | 27 +- .../Get-JcSdkSystemInsightUsbDevice.md | 27 +- .../exports/Get-JcSdkSystemInsightUser.md | 27 +- .../Get-JcSdkSystemInsightUserAssist.md | 27 +- .../Get-JcSdkSystemInsightUserGroup.md | 27 +- .../Get-JcSdkSystemInsightUserSshKey.md | 27 +- .../Get-JcSdkSystemInsightWifiNetwork.md | 27 +- .../Get-JcSdkSystemInsightWifiStatus.md | 27 +- 365 files changed, 21909 insertions(+), 2751 deletions(-) diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Clear-JcSdkAppleMdmDevice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Clear-JcSdkAppleMdmDevice.ps1 index 9683ed4c3..ac8c36063 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Clear-JcSdkAppleMdmDevice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Clear-JcSdkAppleMdmDevice.ps1 @@ -1,4 +1,78 @@ -Function Clear-JcSdkAppleMdmDevice +<# +.Synopsis +Erases a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/erase \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` +.Description +Erases a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/erase \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` +.Example +PS C:\> Clear-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Pin:() + + +.Example +PS C:\> Clear-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Body:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.IPaths1FfbqfwApplemdmsAppleMdmIdDevicesDeviceIdErasePostRequestbodyContentApplicationJsonSchema +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [Pin ]: 6-digit PIN, required for MacOS, to erase the device + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDevice.md +#> + Function Clear-JcSdkAppleMdmDevice { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='ClearExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -143,3 +217,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Clear-JcSdkAppleMdmDeviceActivationLock.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Clear-JcSdkAppleMdmDeviceActivationLock.ps1 index 4715b0c04..9f170e174 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Clear-JcSdkAppleMdmDeviceActivationLock.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Clear-JcSdkAppleMdmDeviceActivationLock.ps1 @@ -1,4 +1,73 @@ -Function Clear-JcSdkAppleMdmDeviceActivationLock +<# +.Synopsis +Clears the activation lock on the specified device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/clearActivationLock \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` +.Description +Clears the activation lock on the specified device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/clearActivationLock \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` +.Example +PS C:\> Clear-JcSdkAppleMdmDeviceActivationLock -AppleMdmId:() -DeviceId:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDeviceActivationLock.md +#> + Function Clear-JcSdkAppleMdmDeviceActivationLock { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Clear', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -126,3 +195,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAccessRequest.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAccessRequest.ps1 index cae43aa4f..6910c66c0 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAccessRequest.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAccessRequest.ps1 @@ -1,4 +1,53 @@ -Function Get-JcSdkAccessRequest +<# +.Synopsis +Endpoint that returns the workflow access request by id +.Description +Endpoint that returns the workflow access request by id +.Example +PS C:\> Get-JcSdkAccessRequest -Id:() +.Example +PS C:\> Get-JcSdkAccessRequest -Fields:() -Filter:() -Sort:() + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAllWorkflowAccessRequestResponse +.Outputs +JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetWorkflowAccessRequestResponse +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequest.md +#> + Function Get-JcSdkAccessRequest { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetWorkflowAccessRequestResponse], [JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAllWorkflowAccessRequestResponse])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -204,3 +253,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAccessRequestProgress.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAccessRequestProgress.ps1 index 6c34a9d37..f842de8ed 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAccessRequestProgress.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAccessRequestProgress.ps1 @@ -1,4 +1,49 @@ -Function Get-JcSdkAccessRequestProgress +<# +.Synopsis +Endpoint for getting the approval progress of a access request +.Description +Endpoint for getting the approval progress of a access request +.Example +PS C:\> Get-JcSdkAccessRequestProgress -Id:() + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAccessRequestApprovalProgressResponse +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequestProgress.md +#> + Function Get-JcSdkAccessRequestProgress { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAccessRequestApprovalProgressResponse])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -127,3 +172,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectory.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectory.ps1 index 97f4dbc36..531df2324 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectory.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectory.ps1 @@ -1,4 +1,89 @@ -Function Get-JcSdkActiveDirectory +<# +.Synopsis +This endpoint returns a specific Active Directory. + +#### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Description +This endpoint returns a specific Active Directory. + +#### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Example +PS C:\> Get-JcSdkActiveDirectory -Fields:() -Filter:() -Sort:() + + + +---- ---------- +Domain String +Id String +PrimaryAgent String +UseCase String + + +.Example +PS C:\> Get-JcSdkActiveDirectory -Id:() + + + +---- ---------- +Domain String +Id String +PrimaryAgent String +UseCase String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IActiveDirectory +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectory.md +#> + Function Get-JcSdkActiveDirectory { [OutputType([JumpCloud.SDK.V2.Models.IActiveDirectory])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -214,3 +299,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryAgent.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryAgent.ps1 index 731594a4e..7727b4369 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryAgent.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryAgent.ps1 @@ -1,4 +1,91 @@ -Function Get-JcSdkActiveDirectoryAgent +<# +.Synopsis +This endpoint returns an Active Directory agent. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns an Active Directory agent. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -Sort:() + + + +---- ---------- +ContactAt String +Hostname String +Id String +SourceIP String +State String +Version String + + +.Example +PS C:\> Get-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -AgentId:() + + + +---- ---------- +ContactAt String +Hostname String +Id String +SourceIP String +State String +Version String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IActiveDirectoryAgentList +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAgent.md +#> + Function Get-JcSdkActiveDirectoryAgent { [OutputType([JumpCloud.SDK.V2.Models.IActiveDirectoryAgentList])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -191,3 +278,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryAssociation.ps1 index d353988df..cef3273bd 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryAssociation.ps1 @@ -1,4 +1,88 @@ -Function Get-JcSdkActiveDirectoryAssociation +<# +.Synopsis +This endpoint returns the direct associations of this Active Directory instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. + + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/associations?targets=user \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns the direct associations of this Active Directory instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. + + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/associations?targets=user \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkActiveDirectoryAssociation -ActivedirectoryId:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphConnection +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAssociation.md +#> + Function Get-JcSdkActiveDirectoryAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -182,3 +266,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryTraverseUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryTraverseUser.ps1 index cc332b5c9..6f78e9a45 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryTraverseUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryTraverseUser.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkActiveDirectoryTraverseUser +<# +.Synopsis +This endpoint will return all Users bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Active Directory instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Active Directory instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/users \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Users bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Active Directory instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Active Directory instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/users \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkActiveDirectoryTraverseUser -ActivedirectoryId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUser.md +#> + Function Get-JcSdkActiveDirectoryTraverseUser { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryTraverseUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryTraverseUserGroup.ps1 index 83dda1371..ec9dc41c8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryTraverseUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkActiveDirectoryTraverseUserGroup.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkActiveDirectoryTraverseUserGroup +<# +.Synopsis +This endpoint will return all Users Groups bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Active Directory instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Active Directory instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/usergroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Users Groups bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Active Directory instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Active Directory instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/usergroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkActiveDirectoryTraverseUserGroup -ActivedirectoryId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUserGroup.md +#> + Function Get-JcSdkActiveDirectoryTraverseUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAdministratorOrganization.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAdministratorOrganization.ps1 index e5b3c5df5..c26854694 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAdministratorOrganization.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAdministratorOrganization.ps1 @@ -1,4 +1,29 @@ -Function Get-JcSdkAdministratorOrganization +<# +.Synopsis +This endpoint returns the association links between an Administrator and Organizations. +.Description +This endpoint returns the association links between an Administrator and Organizations. +.Example +PS C:\> Get-JcSdkAdministratorOrganization + + + +---- ---------- +Administrator String +Organization String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganization.md +#> + Function Get-JcSdkAdministratorOrganization { [OutputType([JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -169,3 +194,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAdministratorOrganizationLink.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAdministratorOrganizationLink.ps1 index 7a86e0ddf..d6a1c85d1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAdministratorOrganizationLink.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAdministratorOrganizationLink.ps1 @@ -1,4 +1,29 @@ -Function Get-JcSdkAdministratorOrganizationLink +<# +.Synopsis +This endpoint returns the association links between an Organization and Administrators. +.Description +This endpoint returns the association links between an Organization and Administrators. +.Example +PS C:\> Get-JcSdkAdministratorOrganizationLink + + + +---- ---------- +Administrator String +Organization String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganizationLink.md +#> + Function Get-JcSdkAdministratorOrganizationLink { [OutputType([JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -169,3 +194,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdm.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdm.ps1 index db21f7546..a08360833 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdm.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdm.ps1 @@ -1,4 +1,41 @@ -Function Get-JcSdkAppleMdm +<# +.Synopsis +Get a list of all Apple MDM configurations. +An empty topic indicates that a signed certificate from Apple has not been provided to the PUT endpoint yet. + +Note: currently only one MDM configuration per organization is supported. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/applemdms \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +Get a list of all Apple MDM configurations. +An empty topic indicates that a signed certificate from Apple has not been provided to the PUT endpoint yet. + +Note: currently only one MDM configuration per organization is supported. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/applemdms \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkAppleMdm + +Get Apple MDM Server information within a JumpCloud Tenant + +.Outputs +JumpCloud.SDK.V2.Models.IAppleMdm +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdm.md +#> + Function Get-JcSdkAppleMdm { [OutputType([JumpCloud.SDK.V2.Models.IAppleMdm])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -184,3 +221,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdmDevice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdmDevice.ps1 index 7b41f094c..2a6244314 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdmDevice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdmDevice.ps1 @@ -1,4 +1,129 @@ -Function Get-JcSdkAppleMdmDevice +<# +.Synopsis +Gets a single Apple MDM device. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ + -H 'accept: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +Gets a single Apple MDM device. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ + -H 'accept: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkAppleMdmDevice -AppleMdmId:() -Filter:() -Sort:() -XTotalCount:() + + + +---- ---------- +CreatedAt String +DepRegistered Boolean +DeviceInformationActivationLockAllowedWhileSupervised Boolean +DeviceInformationAvailableDeviceCapacity System.Nullable[float] DeviceInformationAvailableDeviceCapacity {get;set;} +DeviceInformationDeviceCapacity System.Nullable[float] DeviceInformationDeviceCapacity {get;set;} +DeviceInformationDeviceName String +DeviceInformationIccid String +DeviceInformationImei String +DeviceInformationIsSupervised Boolean +DeviceInformationModelName String +DeviceInformationSecondIccid String +DeviceInformationSecondImei String +DeviceInformationSecondSubscriberCarrierNetwork String +DeviceInformationSubscriberCarrierNetwork String +DeviceInformationWifiMac String +Enrolled Boolean +HasActivationLockBypassCodes Boolean +Id String +OSVersion String +SecurityInfoEnrolledViaDep Boolean +SecurityInfoIsActivationLockManageable Boolean +SecurityInfoIsUserEnrollment Boolean +SecurityInfoPasscodePresent Boolean +SecurityInfoUserApprovedEnrollment Boolean +SerialNumber String +Udid String + + +.Example +PS C:\> Get-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() + + + +---- ---------- +CreatedAt String +DepRegistered Boolean +DeviceInformationActivationLockAllowedWhileSupervised Boolean +DeviceInformationAvailableDeviceCapacity System.Nullable[float] DeviceInformationAvailableDeviceCapacity {get;set;} +DeviceInformationDeviceCapacity System.Nullable[float] DeviceInformationDeviceCapacity {get;set;} +DeviceInformationDeviceName String +DeviceInformationIccid String +DeviceInformationImei String +DeviceInformationIsSupervised Boolean +DeviceInformationModelName String +DeviceInformationSecondIccid String +DeviceInformationSecondImei String +DeviceInformationSecondSubscriberCarrierNetwork String +DeviceInformationSubscriberCarrierNetwork String +DeviceInformationWifiMac String +Enrolled Boolean +HasActivationLockBypassCodes Boolean +Id String +OSVersion String +SecurityInfoEnrolledViaDep Boolean +SecurityInfoIsActivationLockManageable Boolean +SecurityInfoIsUserEnrollment Boolean +SecurityInfoPasscodePresent Boolean +SecurityInfoUserApprovedEnrollment Boolean +SerialNumber String +Udid String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IAppleMdmDevice +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmDevice.md +#> + Function Get-JcSdkAppleMdmDevice { [OutputType([JumpCloud.SDK.V2.Models.IAppleMdmDevice])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -218,3 +343,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdmEnrollmentProfile.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdmEnrollmentProfile.ps1 index 26dd30fad..15e9c056d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdmEnrollmentProfile.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAppleMdmEnrollmentProfile.ps1 @@ -1,4 +1,43 @@ -Function Get-JcSdkAppleMdmEnrollmentProfile +<# +.Synopsis +Get a list of enrollment profiles for an apple mdm. + +Note: currently only one enrollment profile is supported. + +#### Sample Request +``` + curl https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/enrollmentprofiles \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +Get a list of enrollment profiles for an apple mdm. + +Note: currently only one enrollment profile is supported. + +#### Sample Request +``` + curl https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/enrollmentprofiles \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkAppleMdmEnrollmentProfile -AppleMdmId 5ecfd88e63336c651d4f4n59 + +Get a list of enrollment profiles for an apple mdm +.Example +PS C:\> Get-JcSdkAppleMdmEnrollmentProfile -AppleMdmId 5ecfd88e63336c651d4f4n59 -Id 5ecfd88e63336c651d4f4n60 + +Get an enrollment profile by Id + +.Outputs +JumpCloud.SDK.V2.Models.IAppleMdm +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmEnrollmentProfile.md +#> + Function Get-JcSdkAppleMdmEnrollmentProfile { [OutputType([JumpCloud.SDK.V2.Models.IAppleMdm])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -114,3 +153,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationAssociation.ps1 index bc96b0f2c..3d8446bfd 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationAssociation.ps1 @@ -1,4 +1,86 @@ -Function Get-JcSdkApplicationAssociation +<# +.Synopsis +This endpoint will return the _direct_ associations of an Application. +A direct association can be a non-homogeneous relationship between 2 different objects, for example Applications and User Groups. + + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations?targets=user_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return the _direct_ associations of an Application. +A direct association can be a non-homogeneous relationship between 2 different objects, for example Applications and User Groups. + + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations?targets=user_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkApplicationAssociation -ApplicationId:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphConnection +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationAssociation.md +#> + Function Get-JcSdkApplicationAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -182,3 +264,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationTraverseUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationTraverseUser.ps1 index 373262c15..0a00ff4cb 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationTraverseUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationTraverseUser.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkApplicationTraverseUser +<# +.Synopsis +This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkApplicationTraverseUser -ApplicationId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUser.md +#> + Function Get-JcSdkApplicationTraverseUser { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationTraverseUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationTraverseUserGroup.ps1 index 3a9290a7d..9b66b8d65 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationTraverseUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApplicationTraverseUserGroup.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkApplicationTraverseUserGroup +<# +.Synopsis +This endpoint will return all Users Groups bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Application to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Application. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/usergroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Users Groups bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Application to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Application. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/usergroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkApplicationTraverseUserGroup -ApplicationId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUserGroup.md +#> + Function Get-JcSdkApplicationTraverseUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApprovalFlow.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApprovalFlow.ps1 index 08693b796..c9a5bcc02 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApprovalFlow.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApprovalFlow.ps1 @@ -1,4 +1,53 @@ -Function Get-JcSdkApprovalFlow +<# +.Synopsis +Endpoint for getting workflow by id +.Description +Endpoint for getting workflow by id +.Example +PS C:\> Get-JcSdkApprovalFlow -ApprovalFlowId:() +.Example +PS C:\> Get-JcSdkApprovalFlow -Fields:() -Filter:() -Sort:() + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IJumpcloudIngressoAccessWorkflow +.Outputs +JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAllAccessWorkFlowsResponse +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlow.md +#> + Function Get-JcSdkApprovalFlow { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoAccessWorkflow], [JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAllAccessWorkFlowsResponse])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -204,3 +253,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApprovalFlowSetting.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApprovalFlowSetting.ps1 index d7628af88..531dd9a62 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApprovalFlowSetting.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkApprovalFlowSetting.ps1 @@ -1,4 +1,17 @@ -Function Get-JcSdkApprovalFlowSetting +<# +.Synopsis +Endpoint for getting workflow settings for an organisation +.Description +Endpoint for getting workflow settings for an organisation +.Example +PS C:\> Get-JcSdkApprovalFlowSetting + +.Outputs +JumpCloud.SDK.V2.Models.IJumpcloudIngressoAccessWorkflowSettings +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlowSetting.md +#> + Function Get-JcSdkApprovalFlowSetting { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoAccessWorkflowSettings])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -115,3 +128,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAuthenticationPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAuthenticationPolicy.ps1 index a010e2bc0..bbf4bad89 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAuthenticationPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkAuthenticationPolicy.ps1 @@ -1,4 +1,109 @@ -Function Get-JcSdkAuthenticationPolicy +<# +.Synopsis +Return a specific authentication policy. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +Return a specific authentication policy. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkAuthenticationPolicy -Filter:() -Sort:() -XTotalCount:() + + + +---- ---------- +Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions +Description String +Disabled Boolean +EffectAction String +Id String +MfaRequired Boolean +Name String +TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] +Type String +UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserGroupExclusions String +UserGroupInclusions String +UserInclusions String +UserVerificationRequirement String + + +.Example +PS C:\> Get-JcSdkAuthenticationPolicy -Id:() + + + +---- ---------- +Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions +Description String +Disabled Boolean +EffectAction String +Id String +MfaRequired Boolean +Name String +TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] +Type String +UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserGroupExclusions String +UserGroupInclusions String +UserInclusions String +UserVerificationRequirement String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IAuthnPolicy +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAuthenticationPolicy.md +#> + Function Get-JcSdkAuthenticationPolicy { [OutputType([JumpCloud.SDK.V2.Models.IAuthnPolicy])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -211,3 +316,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkBulkUserState.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkBulkUserState.ps1 index 36cc80c39..b46d95481 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkBulkUserState.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkBulkUserState.ps1 @@ -1,4 +1,45 @@ -Function Get-JcSdkBulkUserState +<# +.Synopsis +The endpoint allows you to list scheduled statechange jobs. +#### Sample Request +``` +curl -X GET \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ + -H 'x-api-key: {API_KEY}' \\ + -H 'Content-Type: application/json' \\ + -H 'Accept: application/json' +``` +.Description +The endpoint allows you to list scheduled statechange jobs. +#### Sample Request +``` +curl -X GET \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ + -H 'x-api-key: {API_KEY}' \\ + -H 'Content-Type: application/json' \\ + -H 'Accept: application/json' +``` +.Example +PS C:\> Get-JcSdkBulkUserState + + + +---- ---------- +ScheduledDate String +ScheduledJobId String +State String +SystemUserId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.IScheduledUserstateResult +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUserState.md +#> + Function Get-JcSdkBulkUserState { [OutputType([JumpCloud.SDK.V2.Models.IScheduledUserstateResult])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -190,3 +231,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkBulkUsersResult.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkBulkUsersResult.ps1 index 7bac6384d..c4a060e1d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkBulkUsersResult.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkBulkUsersResult.ps1 @@ -1,4 +1,84 @@ -Function Get-JcSdkBulkUsersResult +<# +.Synopsis +This endpoint will return the results of particular user import or get job request. + +#### Sample Request +``` +curl -X GET \\ + https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Description +This endpoint will return the results of particular user import or get job request. + +#### Sample Request +``` +curl -X GET \\ + https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Example +PS C:\> Get-JcSdkBulkUsersResult -JobId:() + + + +---- ---------- +CreatedAt String +Id String +Meta JumpCloud.SDK.V2.Models.JobWorkresultMeta +PersistedFields JumpCloud.SDK.V2.Models.JobWorkresultPersistedFields +Status String +StatusMsg String +UpdatedAt String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IJobWorkresult +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUsersResult.md +#> + Function Get-JcSdkBulkUsersResult { [OutputType([JumpCloud.SDK.V2.Models.IJobWorkresult])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -175,3 +255,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandAssociation.ps1 index 4c15317db..9786aa98e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandAssociation.ps1 @@ -1,4 +1,88 @@ -Function Get-JcSdkCommandAssociation +<# +.Synopsis +This endpoint will return the _direct_ associations of this Command. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations?targets=system_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return the _direct_ associations of this Command. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations?targets=system_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkCommandAssociation -CommandId:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphConnection +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandAssociation.md +#> + Function Get-JcSdkCommandAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -182,3 +266,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandTraverseSystem.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandTraverseSystem.ps1 index 99fb7e9f6..91f64e437 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandTraverseSystem.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandTraverseSystem.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkCommandTraverseSystem +<# +.Synopsis +This endpoint will return all Systems bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Command to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Command. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systems \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Systems bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Command to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Command. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systems \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkCommandTraverseSystem -CommandId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystem.md +#> + Function Get-JcSdkCommandTraverseSystem { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandTraverseSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandTraverseSystemGroup.ps1 index a3672502d..cd9a1adec 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandTraverseSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCommandTraverseSystemGroup.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkCommandTraverseSystemGroup +<# +.Synopsis +This endpoint will return all System Groups bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Command to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Command. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systemgroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all System Groups bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Command to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Command. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systemgroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkCommandTraverseSystemGroup -CommandId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystemGroup.md +#> + Function Get-JcSdkCommandTraverseSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCustomEmailConfiguration.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCustomEmailConfiguration.ps1 index e84d74c83..2d44b8f70 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCustomEmailConfiguration.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCustomEmailConfiguration.ps1 @@ -1,4 +1,67 @@ -Function Get-JcSdkCustomEmailConfiguration +<# +.Synopsis +Get the custom email configuration for the specified custom email type +.Description +Get the custom email configuration for the specified custom email type +.Example +PS C:\> Get-JcSdkCustomEmailConfiguration -CustomEmailType:() + + + +---- ---------- +Body String +Button String +Header String +Id String +NextStepContactInfo String +Subject String +Title String +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.ICustomEmail +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailConfiguration.md +#> + Function Get-JcSdkCustomEmailConfiguration { [OutputType([JumpCloud.SDK.V2.Models.ICustomEmail])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -120,3 +183,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCustomEmailTemplate.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCustomEmailTemplate.ps1 index 10512fc11..af9cbdd95 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCustomEmailTemplate.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkCustomEmailTemplate.ps1 @@ -1,4 +1,31 @@ -Function Get-JcSdkCustomEmailTemplate +<# +.Synopsis +Get the list of custom email templates +.Description +Get the list of custom email templates +.Example +PS C:\> Get-JcSdkCustomEmailTemplate + + + +---- ---------- +Description String +DisplayName String +Fields JumpCloud.SDK.V2.Models.CustomEmailTemplateField[] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ICustomEmailTemplate +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailTemplate.md +#> + Function Get-JcSdkCustomEmailTemplate { [OutputType([JumpCloud.SDK.V2.Models.ICustomEmailTemplate])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -108,3 +135,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDirectory.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDirectory.ps1 index ac5da6505..09f7292c5 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDirectory.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDirectory.ps1 @@ -1,4 +1,49 @@ -Function Get-JcSdkDirectory +<# +.Synopsis +This endpoint returns all active directories (LDAP, O365 Suite, G-Suite). + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/directories \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns all active directories (LDAP, O365 Suite, G-Suite). + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/directories \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkDirectory + + + +---- ---------- +DefaultDomainDomain String +DefaultDomainId String +Id String +Name String +OAuthStatus JumpCloud.SDK.V2.Models.DirectoryOAuthStatus +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.IDirectory +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDirectory.md +#> + Function Get-JcSdkDirectory { [OutputType([JumpCloud.SDK.V2.Models.IDirectory])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -181,3 +226,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDuoAccount.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDuoAccount.ps1 index ee1178cd0..5d1e434a1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDuoAccount.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDuoAccount.ps1 @@ -1,4 +1,83 @@ -Function Get-JcSdkDuoAccount +<# +.Synopsis +This endpoint returns a specific Duo account. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns a specific Duo account. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkDuoAccount + + + +---- ---------- +Id String +Name String + + +.Example +PS C:\> Get-JcSdkDuoAccount -Id:() + + + +---- ---------- +Id String +Name String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IDuoAccount +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoAccount.md +#> + Function Get-JcSdkDuoAccount { [OutputType([JumpCloud.SDK.V2.Models.IDuoAccount])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -120,3 +199,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDuoApplication.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDuoApplication.ps1 index 680bd89ea..e9c2cd31c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDuoApplication.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkDuoApplication.ps1 @@ -1,4 +1,87 @@ -Function Get-JcSdkDuoApplication +<# +.Synopsis +This endpoint returns a specific Duo application that is associated with the specified Duo account. + +#### Sample Request +``` + curl https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns a specific Duo application that is associated with the specified Duo account. + +#### Sample Request +``` + curl https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkDuoApplication -AccountId:() + + + +---- ---------- +ApiHost String +Id String +IntegrationKey String +Name String + + +.Example +PS C:\> Get-JcSdkDuoApplication -AccountId:() -ApplicationId:() + + + +---- ---------- +ApiHost String +Id String +IntegrationKey String +Name String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IDuoApplication +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoApplication.md +#> + Function Get-JcSdkDuoApplication { [OutputType([JumpCloud.SDK.V2.Models.IDuoApplication])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -127,3 +210,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuite.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuite.ps1 index f24602ec6..a6ada04bc 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuite.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuite.ps1 @@ -1,4 +1,84 @@ -Function Get-JcSdkGSuite +<# +.Synopsis +This endpoint returns a specific G Suite. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns a specific G Suite. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkGSuite -Id:() + + + +---- ---------- +DefaultDomainDomain String +DefaultDomainId String +GroupsEnabled Boolean +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGsuite +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuite.md +#> + Function Get-JcSdkGSuite { [OutputType([JumpCloud.SDK.V2.Models.IGsuite])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -120,3 +200,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteAssociation.ps1 index 76a8782fc..3e3aa8a6e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteAssociation.ps1 @@ -1,4 +1,88 @@ -Function Get-JcSdkGSuiteAssociation +<# +.Synopsis +This endpoint returns the _direct_ associations of this G Suite instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. + + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations?targets=user_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns the _direct_ associations of this G Suite instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. + + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations?targets=user_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkGSuiteAssociation -GsuiteId:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphConnection +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteAssociation.md +#> + Function Get-JcSdkGSuiteAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -182,3 +266,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTranslationRule.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTranslationRule.ps1 index 84ad44cb7..f05ff5df1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTranslationRule.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTranslationRule.ps1 @@ -1,4 +1,89 @@ -Function Get-JcSdkGSuiteTranslationRule +<# +.Synopsis +This endpoint returns a specific translation rule for a specific G Suite instance. +These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. + +###### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Description +This endpoint returns a specific translation rule for a specific G Suite instance. +These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. + +###### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Example +PS C:\> Get-JcSdkGSuiteTranslationRule -GsuiteId:() -Fields:() -Filter:() -Sort:() + + + +---- ---------- +BuiltIn String +Direction String +Id String + + +.Example +PS C:\> Get-JcSdkGSuiteTranslationRule -GsuiteId:() -Id:() + + + +---- ---------- +BuiltIn String +Direction String +Id String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGSuiteTranslationRule +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTranslationRule.md +#> + Function Get-JcSdkGSuiteTranslationRule { [OutputType([JumpCloud.SDK.V2.Models.IGSuiteTranslationRule])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -221,3 +306,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTraverseUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTraverseUser.ps1 index 1ef04b6e2..c4841b5e1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTraverseUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTraverseUser.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkGSuiteTraverseUser +<# +.Synopsis +This endpoint will return all Users bound to a G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this G Suite instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this G Suite instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/users \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Users bound to a G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this G Suite instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this G Suite instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/users \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkGSuiteTraverseUser -GsuiteId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUser.md +#> + Function Get-JcSdkGSuiteTraverseUser { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTraverseUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTraverseUserGroup.ps1 index 4571786b2..2d21357c7 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTraverseUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteTraverseUserGroup.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkGSuiteTraverseUserGroup +<# +.Synopsis +This endpoint will return all User Groups bound to an G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this G Suite instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this G Suite instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSuite_ID}/usergroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all User Groups bound to an G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this G Suite instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this G Suite instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSuite_ID}/usergroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkGSuiteTraverseUserGroup -GsuiteId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUserGroup.md +#> + Function Get-JcSdkGSuiteTraverseUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteUsersToImport.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteUsersToImport.ps1 index f0947e353..5b36ccce5 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteUsersToImport.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGSuiteUsersToImport.ps1 @@ -1,4 +1,29 @@ -Function Get-JcSdkGSuiteUsersToImport +<# +.Synopsis +Lists G Suite users available for import. +.Description +Lists G Suite users available for import. +.Example +PS C:\> Get-JcSdkGSuiteUsersToImport + + + +---- ---------- +NextPageToken String +Users JumpCloud.SDK.V2.Models.Get200ApplicationJsonPropertiesItemsItem[] + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.IPathsC7Pl4LGsuitesGsuiteIdImportUsersGetResponses200ContentApplicationJsonSchema +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteUsersToImport.md +#> + Function Get-JcSdkGSuiteUsersToImport { [OutputType([JumpCloud.SDK.V2.Models.IPathsC7Pl4LGsuitesGsuiteIdImportUsersGetResponses200ContentApplicationJsonSchema])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -187,3 +212,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGroup.ps1 index 353cd8cd3..77ac209f4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGroup.ps1 @@ -1,4 +1,65 @@ -Function Get-JcSdkGroup +<# +.Synopsis +This endpoint returns all Groups that exist in your organization. + +#### Available filter fields: + - `name` + - `disabled` + - `type` + - `memberQueryErrorFlags` + +#### Sample Request + +``` + curl -X GET \\ + https://console.jumpcloud.com/api/v2/groups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns all Groups that exist in your organization. + +#### Available filter fields: + - `name` + - `disabled` + - `type` + - `memberQueryErrorFlags` + +#### Sample Request + +``` + curl -X GET \\ + https://console.jumpcloud.com/api/v2/groups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkGroup + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +Name String +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.IGroup +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGroup.md +#> + Function Get-JcSdkGroup { [OutputType([JumpCloud.SDK.V2.Models.IGroup])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -208,3 +269,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGsuiteUsersToImportFormatted.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGsuiteUsersToImportFormatted.ps1 index 541b06f2e..373ac2a79 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGsuiteUsersToImportFormatted.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkGsuiteUsersToImportFormatted.ps1 @@ -1,4 +1,29 @@ -Function Get-JcSdkGsuiteUsersToImportFormatted +<# +.Synopsis +Lists available G Suite users for import, translated to the Jumpcloud user schema. +.Description +Lists available G Suite users for import, translated to the Jumpcloud user schema. +.Example +PS C:\> Get-JcSdkGsuiteUsersToImportFormatted + + + +---- ---------- +NextPageToken String +Users JumpCloud.SDK.V2.Models.User[] + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.IPathsKa8FhwGsuitesGsuiteIdImportJumpcloudusersGetResponses200ContentApplicationJsonSchema +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGsuiteUsersToImportFormatted.md +#> + Function Get-JcSdkGsuiteUsersToImportFormatted { [OutputType([JumpCloud.SDK.V2.Models.IPathsKa8FhwGsuitesGsuiteIdImportJumpcloudusersGetResponses200ContentApplicationJsonSchema])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +218,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkIPList.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkIPList.ps1 index e3600ca00..59ecf399b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkIPList.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkIPList.ps1 @@ -1,4 +1,87 @@ -Function Get-JcSdkIPList +<# +.Synopsis +Return a specific IP list. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +Return a specific IP list. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkIPList -Filter:() -Sort:() -XTotalCount:() + + + +---- ---------- +Description String +Id String +Ips String +Name String + + +.Example +PS C:\> Get-JcSdkIPList -Id:() + + + +---- ---------- +Description String +Id String +Ips String +Name String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IIPList +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkIPList.md +#> + Function Get-JcSdkIPList { [OutputType([JumpCloud.SDK.V2.Models.IIPList])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -211,3 +294,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServer.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServer.ps1 index 15d8c60a1..c7abfabe6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServer.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServer.ps1 @@ -1,4 +1,89 @@ -Function Get-JcSdkLdapServer +<# +.Synopsis +This endpoint returns a specific LDAP server. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns a specific LDAP server. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkLdapServer -Fields:() -Filter:() -Sort:() + + + +---- ---------- +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + + +.Example +PS C:\> Get-JcSdkLdapServer -Id:() + + + +---- ---------- +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.ILdapServer +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServer.md +#> + Function Get-JcSdkLdapServer { [OutputType([JumpCloud.SDK.V2.Models.ILdapServer])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -214,3 +299,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerAssociation.ps1 index 66b424cd4..40b6ab696 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerAssociation.ps1 @@ -1,4 +1,88 @@ -Function Get-JcSdkLdapServerAssociation +<# +.Synopsis +This endpoint returns the _direct_ associations of this LDAP Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. + +#### Sample Request + +``` + curl -X GET 'https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations?targets=user_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns the _direct_ associations of this LDAP Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. + +#### Sample Request + +``` + curl -X GET 'https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations?targets=user_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkLdapServerAssociation -LdapserverId:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphConnection +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerAssociation.md +#> + Function Get-JcSdkLdapServerAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -182,3 +266,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerSambaDomain.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerSambaDomain.ps1 index 330efc597..53483268e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerSambaDomain.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerSambaDomain.ps1 @@ -1,4 +1,87 @@ -Function Get-JcSdkLdapServerSambaDomain +<# +.Synopsis +This endpoint returns a specific samba domain for an LDAP server. + +##### Sample Request +``` +curl -X GET \\ + https://console.jumpcloud.com/api/v2/ldapservers/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Description +This endpoint returns a specific samba domain for an LDAP server. + +##### Sample Request +``` +curl -X GET \\ + https://console.jumpcloud.com/api/v2/ldapservers/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Example +PS C:\> Get-JcSdkLdapServerSambaDomain -LdapserverId:() -Fields:() -Filter:() -Sort:() + + + +---- ---------- +Id String +Name String +Sid String + + +.Example +PS C:\> Get-JcSdkLdapServerSambaDomain -LdapserverId:() -Id:() + + + +---- ---------- +Id String +Name String +Sid String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.ISambaDomain +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerSambaDomain.md +#> + Function Get-JcSdkLdapServerSambaDomain { [OutputType([JumpCloud.SDK.V2.Models.ISambaDomain])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -221,3 +304,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerTraverseUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerTraverseUser.ps1 index 43baead44..a12c560c1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerTraverseUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerTraverseUser.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkLdapServerTraverseUser +<# +.Synopsis +This endpoint will return all Users bound to an LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this LDAP server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this LDAP server instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Users bound to an LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this LDAP server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this LDAP server instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkLdapServerTraverseUser -LdapserverId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUser.md +#> + Function Get-JcSdkLdapServerTraverseUser { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerTraverseUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerTraverseUserGroup.ps1 index 18634da8f..578cc6130 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerTraverseUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkLdapServerTraverseUserGroup.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkLdapServerTraverseUserGroup +<# +.Synopsis +This endpoint will return all Users Groups bound to a LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this LDAP server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this LDAP server instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Users Groups bound to a LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this LDAP server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this LDAP server instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkLdapServerTraverseUserGroup -LdapserverId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUserGroup.md +#> + Function Get-JcSdkLdapServerTraverseUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkNextScheduledBulkUserState.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkNextScheduledBulkUserState.ps1 index b300a7780..c93819aa7 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkNextScheduledBulkUserState.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkNextScheduledBulkUserState.ps1 @@ -1,4 +1,49 @@ -Function Get-JcSdkNextScheduledBulkUserState +<# +.Synopsis +This endpoint is used to lookup the next upcoming scheduled state change for each user in the +given list. +The users parameter is limited to 100 items per request. +The results are also limited +to 100 items. +This endpoint returns a max of 1 event per state per user. +For example, if a user +has 3 ACTIVATED events scheduled it will return the next upcoming activation event. +However, if a +user also has a SUSPENDED event scheduled along with the ACTIVATED events it will return the next +upcoming activation event _and_ the next upcoming suspension event. +.Description +This endpoint is used to lookup the next upcoming scheduled state change for each user in the +given list. +The users parameter is limited to 100 items per request. +The results are also limited +to 100 items. +This endpoint returns a max of 1 event per state per user. +For example, if a user +has 3 ACTIVATED events scheduled it will return the next upcoming activation event. +However, if a +user also has a SUSPENDED event scheduled along with the ACTIVATED events it will return the next +upcoming activation event _and_ the next upcoming suspension event. +.Example +PS C:\> Get-JcSdkNextScheduledBulkUserState + + + +---- ---------- +EventsCount Int +Results JumpCloud.SDK.V2.Models.ScheduledUserstateResult[] + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.IPathsUbbqf1BulkUserstatesEventlistNextGetResponses200ContentApplicationJsonSchema +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkNextScheduledBulkUserState.md +#> + Function Get-JcSdkNextScheduledBulkUserState { [OutputType([JumpCloud.SDK.V2.Models.IPathsUbbqf1BulkUserstatesEventlistNextGetResponses200ContentApplicationJsonSchema])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -171,3 +216,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365.ps1 index 3d5ed546c..f0bc4daf4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365.ps1 @@ -1,4 +1,90 @@ -Function Get-JcSdkOffice365 +<# +.Synopsis +This endpoint returns a specific Office 365 instance. + +##### + +Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint returns a specific Office 365 instance. + +##### + +Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkOffice365 -Office365Id:() + + + +---- ---------- +DefaultDomainDomain String +DefaultDomainId String +GroupsEnabled Boolean +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IOffice365 +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365.md +#> + Function Get-JcSdkOffice365 { [OutputType([JumpCloud.SDK.V2.Models.IOffice365])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -120,3 +206,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365Association.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365Association.ps1 index c09d3bbbf..3e73b1b9c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365Association.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365Association.ps1 @@ -1,4 +1,90 @@ -Function Get-JcSdkOffice365Association +<# +.Synopsis +This endpoint returns _direct_ associations of an Office 365 instance. + + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations?targets=user_group' \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint returns _direct_ associations of an Office 365 instance. + + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations?targets=user_group' \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkOffice365Association -Office365Id:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphConnection +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365Association.md +#> + Function Get-JcSdkOffice365Association { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -182,3 +268,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TranslationRule.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TranslationRule.ps1 index 619b6491f..4f855842e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TranslationRule.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TranslationRule.ps1 @@ -1,4 +1,89 @@ -Function Get-JcSdkOffice365TranslationRule +<# +.Synopsis +This endpoint returns a specific translation rule for a specific Office 365 instance. +These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. + +###### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Description +This endpoint returns a specific translation rule for a specific Office 365 instance. +These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. + +###### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Example +PS C:\> Get-JcSdkOffice365TranslationRule -Office365Id:() -Fields:() -Filter:() -Sort:() + + + +---- ---------- +BuiltIn String +Direction String +Id String + + +.Example +PS C:\> Get-JcSdkOffice365TranslationRule -Office365Id:() -Id:() + + + +---- ---------- +BuiltIn String +Direction String +Id String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IOffice365TranslationRule +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TranslationRule.md +#> + Function Get-JcSdkOffice365TranslationRule { [OutputType([JumpCloud.SDK.V2.Models.IOffice365TranslationRule])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -221,3 +306,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TraverseUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TraverseUser.ps1 index 1913d8c6a..4cc16e918 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TraverseUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TraverseUser.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkOffice365TraverseUser +<# +.Synopsis +This endpoint will return all Users bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Office 365 instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Office 365 instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Users bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Office 365 instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Office 365 instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkOffice365TraverseUser -Office365Id:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUser.md +#> + Function Get-JcSdkOffice365TraverseUser { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -202,3 +293,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TraverseUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TraverseUserGroup.ps1 index 29d194c11..0c4a01bcc 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TraverseUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365TraverseUserGroup.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkOffice365TraverseUserGroup +<# +.Synopsis +This endpoint will return all Users Groups bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Office 365 instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Office 365 instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Users Groups bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Office 365 instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Office 365 instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkOffice365TraverseUserGroup -Office365Id:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUserGroup.md +#> + Function Get-JcSdkOffice365TraverseUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365UsersToImport.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365UsersToImport.ps1 index 539e14a67..be76309b4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365UsersToImport.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOffice365UsersToImport.ps1 @@ -1,4 +1,30 @@ -Function Get-JcSdkOffice365UsersToImport +<# +.Synopsis +Lists Office 365 users available for import. +.Description +Lists Office 365 users available for import. +.Example +PS C:\> Get-JcSdkOffice365UsersToImport + + + +---- ---------- +SkipToken String +Top Int +Users JumpCloud.SDK.V2.Models.Paths1Hu9JikOffice365SOffice365IdImportUsersGetResponses200ContentApplicationJsonSchemaPropertiesUsersItem… + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.IPaths1J0ThkrOffice365SOffice365IdImportUsersGetResponses200ContentApplicationJsonSchema +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365UsersToImport.md +#> + Function Get-JcSdkOffice365UsersToImport { [OutputType([JumpCloud.SDK.V2.Models.IPaths1J0ThkrOffice365SOffice365IdImportUsersGetResponses200ContentApplicationJsonSchema])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -201,3 +227,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOrganizationPolicyResult.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOrganizationPolicyResult.ps1 index a2a54c8a1..36a9e51f6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOrganizationPolicyResult.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkOrganizationPolicyResult.ps1 @@ -1,4 +1,56 @@ -Function Get-JcSdkOrganizationPolicyResult +<# +.Synopsis +This endpoint returns all policy results for an organization. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Description +This endpoint returns all policy results for an organization. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Example +PS C:\> Get-JcSdkOrganizationPolicyResult + + + +---- ---------- +Detail String +EndedAt Datetime +ExitStatus System.Nullable[long] ExitStatus {get;set;} +Id String +PolicyId String +StartedAt Datetime +State String +StdErr String +StdOut String +Success Boolean +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.IPolicyResult +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOrganizationPolicyResult.md +#> + Function Get-JcSdkOrganizationPolicyResult { [OutputType([JumpCloud.SDK.V2.Models.IPolicyResult])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -202,3 +254,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicy.ps1 index 455b149c8..0bbaf7804 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicy.ps1 @@ -1,4 +1,111 @@ -Function Get-JcSdkPolicy +<# +.Synopsis +This endpoint returns a specific policy. + +###### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/policies/{PolicyID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Description +This endpoint returns a specific policy. + +###### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/policies/{PolicyID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Example +PS C:\> Get-JcSdkPolicy -Fields:() -Filter:() -Sort:() + + + +---- ---------- +Id String +Name String +TemplateActivation String +TemplateAlert String +TemplateBehavior String +TemplateDeliveryTypes String +TemplateDescription String +TemplateDisplayName String +TemplateId String +TemplateName String +TemplateOSMetaFamily String +TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] +TemplateReference String +TemplateState String + + +.Example +PS C:\> Get-JcSdkPolicy -Id:() + + + +---- ---------- +Id String +Name String +TemplateActivation String +TemplateAlert String +TemplateBehavior String +TemplateDeliveryTypes String +TemplateDescription String +TemplateDisplayName String +TemplateId String +TemplateName String +TemplateOSMetaFamily String +TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] +TemplateReference String +TemplateState String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IPolicy +.Outputs +JumpCloud.SDK.V2.Models.IPolicyWithDetails +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicy.md +#> + Function Get-JcSdkPolicy { [OutputType([JumpCloud.SDK.V2.Models.IPolicyWithDetails], [JumpCloud.SDK.V2.Models.IPolicy])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -214,3 +321,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyAssociation.ps1 index 3d5cdb143..f34275680 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyAssociation.ps1 @@ -1,4 +1,86 @@ -Function Get-JcSdkPolicyAssociation +<# +.Synopsis +This endpoint returns the _direct_ associations of a Policy. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations?targets=system_group \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns the _direct_ associations of a Policy. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations?targets=system_group \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkPolicyAssociation -PolicyId:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphConnection +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyAssociation.md +#> + Function Get-JcSdkPolicyAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -182,3 +264,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroup.ps1 index fc636de5a..33737f2a5 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroup.ps1 @@ -1,4 +1,91 @@ -Function Get-JcSdkPolicyGroup +<# +.Synopsis +This endpoint returns the details of a Policy Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns the details of a Policy Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkPolicyGroup -Fields:() -Filter:() -Sort:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +Name String +Type String + + +.Example +PS C:\> Get-JcSdkPolicyGroup -Id:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +Name String +Type String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IPolicyGroup +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroup.md +#> + Function Get-JcSdkPolicyGroup { [OutputType([JumpCloud.SDK.V2.Models.IPolicyGroup])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -214,3 +301,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupAssociation.ps1 index 90645170c..758da874d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupAssociation.ps1 @@ -1,4 +1,56 @@ -Function Get-JcSdkPolicyGroupAssociation +<# +.Synopsis +This endpoint returns the _direct_ associations of this Policy Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations?targets=system \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns the _direct_ associations of this Policy Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations?targets=system \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkPolicyGroupAssociation + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.IGraphConnection +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupAssociation.md +#> + Function Get-JcSdkPolicyGroupAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -176,3 +228,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupMember.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupMember.ps1 index 4817e368b..f8237a781 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupMember.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupMember.ps1 @@ -1,4 +1,97 @@ -Function Get-JcSdkPolicyGroupMember +<# +.Synopsis +This endpoint returns all the Policy Groups a Policy is a member of. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/memberof \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint returns all the Policy Groups a Policy is a member of. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/memberof \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkPolicyGroupMember -PolicyId:() -Filter:() -Sort:() -Authorization:() -Date:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + +.Example +PS C:\> Get-JcSdkPolicyGroupMember -GroupId:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphConnection +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMember.md +#> + Function Get-JcSdkPolicyGroupMember { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths], [JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -227,3 +320,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupMembership.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupMembership.ps1 index cc6419399..6df8a2a6b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupMembership.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupMembership.ps1 @@ -1,4 +1,79 @@ -Function Get-JcSdkPolicyGroupMembership +<# +.Synopsis +This endpoint returns all Policy members that are a member of this Policy Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/membership \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns all Policy members that are a member of this Policy Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/membership \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkPolicyGroupMembership -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMembership.md +#> + Function Get-JcSdkPolicyGroupMembership { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -205,3 +280,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupTraverseSystem.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupTraverseSystem.ps1 index 18ff3c0d5..d345b0d42 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupTraverseSystem.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupTraverseSystem.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkPolicyGroupTraverseSystem +<# +.Synopsis +This endpoint will return all Systems bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Systems bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkPolicyGroupTraverseSystem -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystem.md +#> + Function Get-JcSdkPolicyGroupTraverseSystem { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupTraverseSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupTraverseSystemGroup.ps1 index 91dc0fa05..8474aff9b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupTraverseSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyGroupTraverseSystemGroup.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkPolicyGroupTraverseSystemGroup +<# +.Synopsis +This endpoint will return all System Groups bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all System Groups bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkPolicyGroupTraverseSystemGroup -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystemGroup.md +#> + Function Get-JcSdkPolicyGroupTraverseSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyResult.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyResult.ps1 index 3285d0495..1ce182296 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyResult.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyResult.ps1 @@ -1,4 +1,101 @@ -Function Get-JcSdkPolicyResult +<# +.Synopsis +This endpoint will return the policy results for a specific policy. + +##### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policyresults/{Policy_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Description +This endpoint will return the policy results for a specific policy. + +##### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policyresults/{Policy_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Example +PS C:\> Get-JcSdkPolicyResult -Id:() + + + +---- ---------- +Detail String +EndedAt Datetime +ExitStatus System.Nullable[long] ExitStatus {get;set;} +Id String +PolicyId String +StartedAt Datetime +State String +StdErr String +StdOut String +Success Boolean +SystemId String + + +.Example +PS C:\> Get-JcSdkPolicyResult -PolicyId:() -Fields:() -Filter:() -Sort:() + + + +---- ---------- +Detail String +EndedAt Datetime +ExitStatus System.Nullable[long] ExitStatus {get;set;} +Id String +PolicyId String +StartedAt Datetime +State String +StdErr String +StdOut String +Success Boolean +SystemId String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IPolicyResult +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyResult.md +#> + Function Get-JcSdkPolicyResult { [OutputType([JumpCloud.SDK.V2.Models.IPolicyResult])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -220,3 +317,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyStatus.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyStatus.ps1 index cfe0e14b8..fe959693f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyStatus.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyStatus.ps1 @@ -1,4 +1,56 @@ -Function Get-JcSdkPolicyStatus +<# +.Synopsis +This endpoint returns the latest policy results for a specific policy. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Description +This endpoint returns the latest policy results for a specific policy. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Example +PS C:\> Get-JcSdkPolicyStatus + + + +---- ---------- +Detail String +EndedAt Datetime +ExitStatus System.Nullable[long] ExitStatus {get;set;} +Id String +PolicyId String +StartedAt Datetime +State String +StdErr String +StdOut String +Success Boolean +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.IPolicyResult +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyStatus.md +#> + Function Get-JcSdkPolicyStatus { [OutputType([JumpCloud.SDK.V2.Models.IPolicyResult])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -208,3 +260,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTemplate.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTemplate.ps1 index 3ca59aae6..efa73d472 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTemplate.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTemplate.ps1 @@ -1,4 +1,105 @@ -Function Get-JcSdkPolicyTemplate +<# +.Synopsis +This endpoint returns a specific policy template. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/policytemplates/{Policy_Template_ID}\\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns a specific policy template. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/policytemplates/{Policy_Template_ID}\\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkPolicyTemplate -Fields:() -Filter:() -Sort:() + + + +---- ---------- +Activation String +Alert String +Behavior String +DeliveryTypes String +Description String +DisplayName String +Id String +Name String +OSMetaFamily String +OSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] +Reference String +State String + + +.Example +PS C:\> Get-JcSdkPolicyTemplate -Id:() + + + +---- ---------- +Activation String +Alert String +Behavior String +DeliveryTypes String +Description String +DisplayName String +Id String +Name String +OSMetaFamily String +OSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] +Reference String +State String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IPolicyTemplate +.Outputs +JumpCloud.SDK.V2.Models.IPolicyTemplateWithDetails +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTemplate.md +#> + Function Get-JcSdkPolicyTemplate { [OutputType([JumpCloud.SDK.V2.Models.IPolicyTemplateWithDetails], [JumpCloud.SDK.V2.Models.IPolicyTemplate])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -214,3 +315,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTraverseSystem.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTraverseSystem.ps1 index 8e5d732f1..76cf75e6b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTraverseSystem.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTraverseSystem.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkPolicyTraverseSystem +<# +.Synopsis +This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkPolicyTraverseSystem -PolicyId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystem.md +#> + Function Get-JcSdkPolicyTraverseSystem { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTraverseSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTraverseSystemGroup.ps1 index 50ce7c6dd..655b193a8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTraverseSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkPolicyTraverseSystemGroup.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkPolicyTraverseSystemGroup +<# +.Synopsis +This endpoint will return all Systems Groups bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Systems Groups bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkPolicyTraverseSystemGroup -PolicyId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystemGroup.md +#> + Function Get-JcSdkPolicyTraverseSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProviderAdministrator.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProviderAdministrator.ps1 index 85b5735ab..ac41f47f6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProviderAdministrator.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProviderAdministrator.ps1 @@ -1,4 +1,31 @@ -Function Get-JcSdkProviderAdministrator +<# +.Synopsis +This endpoint returns a list of the Administrators associated with the Provider. +You must be associated with the provider to use this route. +.Description +This endpoint returns a list of the Administrators associated with the Provider. +You must be associated with the provider to use this route. +.Example +PS C:\> Get-JcSdkProviderAdministrator + + + +---- ---------- +Results JumpCloud.SDK.V2.Models.Administrator[] +TotalCount Int + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.IPathsYwlyndProvidersProviderIdAdministratorsGetResponses200ContentApplicationJsonSchema +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderAdministrator.md +#> + Function Get-JcSdkProviderAdministrator { [OutputType([JumpCloud.SDK.V2.Models.IPathsYwlyndProvidersProviderIdAdministratorsGetResponses200ContentApplicationJsonSchema])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -217,3 +244,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProviderOrganization.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProviderOrganization.ps1 index ae6e77219..28a2fa7f2 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProviderOrganization.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProviderOrganization.ps1 @@ -1,4 +1,31 @@ -Function Get-JcSdkProviderOrganization +<# +.Synopsis +This endpoint returns a list of the Organizations associated with the Provider. +You must be associated with the provider to use this route. +.Description +This endpoint returns a list of the Organizations associated with the Provider. +You must be associated with the provider to use this route. +.Example +PS C:\> Get-JcSdkProviderOrganization + + + +---- ---------- +Results JumpCloud.SDK.V2.Models.Organization[] +TotalCount Int + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.IPaths1O3J7V8ProvidersProviderIdOrganizationsGetResponses200ContentApplicationJsonSchema +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderOrganization.md +#> + Function Get-JcSdkProviderOrganization { [OutputType([JumpCloud.SDK.V2.Models.IPaths1O3J7V8ProvidersProviderIdOrganizationsGetResponses200ContentApplicationJsonSchema])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -217,3 +244,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProvidersInvoice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProvidersInvoice.ps1 index 134d62efa..b7e7e72b8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProvidersInvoice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkProvidersInvoice.ps1 @@ -1,4 +1,63 @@ -Function Get-JcSdkProvidersInvoice +<# +.Synopsis +Retrieves a list of invoices for this provider. +You must be associated to the provider to use this endpoint. +.Description +Retrieves a list of invoices for this provider. +You must be associated to the provider to use this endpoint. +.Example +PS C:\> Get-JcSdkProvidersInvoice -ProviderId:() + + + +---- ---------- +Records JumpCloud.SDK.V2.Models.ProviderInvoice[] +TotalCount Int + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IProviderInvoiceResponse +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProvidersInvoice.md +#> + Function Get-JcSdkProvidersInvoice { [OutputType([JumpCloud.SDK.V2.Models.IProviderInvoiceResponse])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -205,3 +264,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerAssociation.ps1 index 4614a3e4c..dd825f1ed 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerAssociation.ps1 @@ -1,4 +1,86 @@ -Function Get-JcSdkRadiusServerAssociation +<# +.Synopsis +This endpoint returns the _direct_ associations of a Radius Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations?targets=user_group \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns the _direct_ associations of a Radius Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations?targets=user_group \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkRadiusServerAssociation -RadiusserverId:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphConnection +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerAssociation.md +#> + Function Get-JcSdkRadiusServerAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -182,3 +264,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerTraverseUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerTraverseUser.ps1 index 68865ec0a..4e66821a1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerTraverseUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerTraverseUser.ps1 @@ -1,4 +1,97 @@ -Function Get-JcSdkRadiusServerTraverseUser +<# +.Synopsis +This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. + +See `/members` and `/associations` endpoints to manage those collections. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Description +This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. + +See `/members` and `/associations` endpoints to manage those collections. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Example +PS C:\> Get-JcSdkRadiusServerTraverseUser -RadiusserverId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUser.md +#> + Function Get-JcSdkRadiusServerTraverseUser { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +289,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerTraverseUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerTraverseUserGroup.ps1 index 6e3914f24..79b662d8b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerTraverseUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkRadiusServerTraverseUserGroup.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkRadiusServerTraverseUserGroup +<# +.Synopsis +This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkRadiusServerTraverseUserGroup -RadiusserverId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUserGroup.md +#> + Function Get-JcSdkRadiusServerTraverseUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareApp.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareApp.ps1 index 601ff5638..c969fd44a 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareApp.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareApp.ps1 @@ -1,4 +1,87 @@ -Function Get-JcSdkSoftwareApp +<# +.Synopsis +Retrieves a Software Application. +The optional isConfigEnabled and appConfiguration apple_vpp attributes are populated in this response. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +Retrieves a Software Application. +The optional isConfigEnabled and appConfiguration apple_vpp attributes are populated in this response. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkSoftwareApp -Filter:() -Sort:() + + + +---- ---------- +DisplayName String +Id String +Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] + + +.Example +PS C:\> Get-JcSdkSoftwareApp -Id:() + + + +---- ---------- +DisplayName String +Id String +Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.ISoftwareApp +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareApp.md +#> + Function Get-JcSdkSoftwareApp { [OutputType([JumpCloud.SDK.V2.Models.ISoftwareApp])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -205,3 +288,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppAssociation.ps1 index 6bde7f8b2..a3e6e16c6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppAssociation.ps1 @@ -1,4 +1,86 @@ -Function Get-JcSdkSoftwareAppAssociation +<# +.Synopsis +This endpoint will return the _direct_ associations of a Software Application. +A direct association can be a non-homogeneous relationship between 2 different objects, for example Software Application and System Groups. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations?targets=system_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return the _direct_ associations of a Software Application. +A direct association can be a non-homogeneous relationship between 2 different objects, for example Software Application and System Groups. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations?targets=system_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkSoftwareAppAssociation -SoftwareAppId:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphConnection +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppAssociation.md +#> + Function Get-JcSdkSoftwareAppAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -182,3 +264,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppStatus.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppStatus.ps1 index f77bd8fca..382843b3b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppStatus.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppStatus.ps1 @@ -1,4 +1,83 @@ -Function Get-JcSdkSoftwareAppStatus +<# +.Synopsis +This endpoint allows you to get the status of the provided Software Application on associated JumpCloud systems. + +#### Sample Request +``` +$ curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/statuses \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +``` +.Description +This endpoint allows you to get the status of the provided Software Application on associated JumpCloud systems. + +#### Sample Request +``` +$ curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/statuses \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +``` +.Example +PS C:\> Get-JcSdkSoftwareAppStatus -SoftwareAppId:() + + + +---- ---------- +Code Int +Details String +Id String +SoftwareAppId String +State String +SystemId String +Timestamp String +Version String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.ISoftwareAppStatus +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppStatus.md +#> + Function Get-JcSdkSoftwareAppStatus { [OutputType([JumpCloud.SDK.V2.Models.ISoftwareAppStatus])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -205,3 +284,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppTraverseSystem.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppTraverseSystem.ps1 index 20fde392c..7fd6a783a 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppTraverseSystem.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppTraverseSystem.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkSoftwareAppTraverseSystem +<# +.Synopsis +This endpoint will return all Systems bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Software App to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Software App. + +See `/associations` endpoint to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Systems bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Software App to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Software App. + +See `/associations` endpoint to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkSoftwareAppTraverseSystem -SoftwareAppId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystem.md +#> + Function Get-JcSdkSoftwareAppTraverseSystem { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppTraverseSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppTraverseSystemGroup.ps1 index fd307a87f..a28850d1c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppTraverseSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSoftwareAppTraverseSystemGroup.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkSoftwareAppTraverseSystemGroup +<# +.Synopsis +This endpoint will return all Systems Groups bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Software App to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Software App. + +See `/associations` endpoint to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Systems Groups bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Software App to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Software App. + +See `/associations` endpoint to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkSoftwareAppTraverseSystemGroup -SoftwareAppId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystemGroup.md +#> + Function Get-JcSdkSoftwareAppTraverseSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSubscription.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSubscription.ps1 index 19ed33ded..2b0d7e82d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSubscription.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSubscription.ps1 @@ -1,4 +1,51 @@ -Function Get-JcSdkSubscription +<# +.Synopsis +This endpoint returns all pricing & packaging subscriptions. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/subscriptions \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Description +This endpoint returns all pricing & packaging subscriptions. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/subscriptions \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Example +PS C:\> Get-JcSdkSubscription + + + +---- ---------- +AnnualPrice float AnnualPrice {get;set;} +DisplayName String +Features JumpCloud.SDK.V2.Models.Feature[] +ListPrice float ListPrice {get;set;} +ProductCode String +UpgradeRecommendation String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISubscription +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSubscription.md +#> + Function Get-JcSdkSubscription { [OutputType([JumpCloud.SDK.V2.Models.ISubscription])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -108,3 +155,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemAssociation.ps1 index cd2cb47f6..ad656dacf 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemAssociation.ps1 @@ -1,4 +1,90 @@ -Function Get-JcSdkSystemAssociation +<# +.Synopsis +This endpoint returns the _direct_ associations of a System. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations?targets=user \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint returns the _direct_ associations of a System. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations?targets=user \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkSystemAssociation -SystemId:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphConnection +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemAssociation.md +#> + Function Get-JcSdkSystemAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -194,3 +280,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemFdeKey.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemFdeKey.ps1 index a2ca07367..622948823 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemFdeKey.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemFdeKey.ps1 @@ -1,4 +1,55 @@ -Function Get-JcSdkSystemFdeKey +<# +.Synopsis +This endpoint will return the current (latest) fde key saved for a system. +.Description +This endpoint will return the current (latest) fde key saved for a system. +.Example +PS C:\> Get-JcSdkSystemFdeKey -SystemId:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.ISystemfdekey +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemFdeKey.md +#> + Function Get-JcSdkSystemFdeKey { [OutputType([JumpCloud.SDK.V2.Models.ISystemfdekey])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -120,3 +171,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroup.ps1 index e1b3dc0c3..762b87354 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroup.ps1 @@ -1,4 +1,101 @@ -Function Get-JcSdkSystemGroup +<# +.Synopsis +This endpoint returns the details of a System Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns the details of a System Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkSystemGroup -Fields:() -Filter:() -Sort:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +Type String + + +.Example +PS C:\> Get-JcSdkSystemGroup -Id:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +Type String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.ISystemGroup +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroup.md +#> + Function Get-JcSdkSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.ISystemGroup])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -214,3 +311,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupAssociation.ps1 index c90ade75a..decbcff75 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupAssociation.ps1 @@ -1,4 +1,88 @@ -Function Get-JcSdkSystemGroupAssociation +<# +.Synopsis +This endpoint returns the _direct_ associations of a System Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations?targets=user \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns the _direct_ associations of a System Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations?targets=user \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkSystemGroupAssociation -GroupId:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphConnection +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupAssociation.md +#> + Function Get-JcSdkSystemGroupAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -182,3 +266,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupMember.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupMember.ps1 index 882b66480..dda37e1b1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupMember.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupMember.ps1 @@ -1,4 +1,84 @@ -Function Get-JcSdkSystemGroupMember +<# +.Synopsis +This endpoint returns the system members of a System Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint returns the system members of a System Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkSystemGroupMember -GroupId:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphConnection +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMember.md +#> + Function Get-JcSdkSystemGroupMember { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -175,3 +255,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupMembership.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupMembership.ps1 index 51931a433..f47a30d5f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupMembership.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupMembership.ps1 @@ -1,4 +1,81 @@ -Function Get-JcSdkSystemGroupMembership +<# +.Synopsis +This endpoint returns all Systems that are a member of this System Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID/membership \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint returns all Systems that are a member of this System Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID/membership \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkSystemGroupMembership -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMembership.md +#> + Function Get-JcSdkSystemGroupMembership { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -205,3 +282,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseCommand.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseCommand.ps1 index dda97fe76..e52672c3b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseCommand.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseCommand.ps1 @@ -1,4 +1,104 @@ -Function Get-JcSdkSystemGroupTraverseCommand +<# +.Synopsis +This endpoint will return all Commands bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/commands \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Commands bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/commands \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkSystemGroupTraverseCommand -GroupId:() + + + +---- ---------- +Command String +CommandType String +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +LaunchType String +Name String +Organization String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Schedule String +ScheduleRepeatType String +Timeout String +TimeToLiveSeconds Int +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.ICommandsGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseCommand.md +#> + Function Get-JcSdkSystemGroupTraverseCommand { [OutputType([JumpCloud.SDK.V2.Models.ICommandsGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -203,3 +303,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraversePolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraversePolicy.ps1 index a40c5fef1..e86453e53 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraversePolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraversePolicy.ps1 @@ -1,4 +1,99 @@ -Function Get-JcSdkSystemGroupTraversePolicy +<# +.Synopsis +This endpoint will return all Policies bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +This endpoint is not public yet as we haven't finished the code. + +##### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policies \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Policies bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +This endpoint is not public yet as we haven't finished the code. + +##### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policies \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkSystemGroupTraversePolicy -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicy.md +#> + Function Get-JcSdkSystemGroupTraversePolicy { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +291,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraversePolicyGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraversePolicyGroup.ps1 index 3389253dc..436149b23 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraversePolicyGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraversePolicyGroup.ps1 @@ -1,4 +1,97 @@ -Function Get-JcSdkSystemGroupTraversePolicyGroup +<# +.Synopsis +This endpoint will return all Policy Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policygroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint will return all Policy Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policygroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkSystemGroupTraversePolicyGroup -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicyGroup.md +#> + Function Get-JcSdkSystemGroupTraversePolicyGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +289,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseUser.ps1 index f30d404a0..5a4021bdc 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseUser.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkSystemGroupTraverseUser +<# +.Synopsis +This endpoint will return all Users bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Users bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkSystemGroupTraverseUser -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUser.md +#> + Function Get-JcSdkSystemGroupTraverseUser { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseUserGroup.ps1 index 92985c983..9fb1d2209 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemGroupTraverseUserGroup.ps1 @@ -1,4 +1,97 @@ -Function Get-JcSdkSystemGroupTraverseUserGroup +<# +.Synopsis +This endpoint will return all User Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint will return all User Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkSystemGroupTraverseUserGroup -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUserGroup.md +#> + Function Get-JcSdkSystemGroupTraverseUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +289,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlf.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlf.ps1 index 599230ea4..809c93c2e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlf.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlf.ps1 @@ -1,4 +1,36 @@ -Function Get-JcSdkSystemInsightAlf +<# +.Synopsis +Valid filter fields are `system_id` and `global_state`. +.Description +Valid filter fields are `system_id` and `global_state`. +.Example +PS C:\> Get-JcSdkSystemInsightAlf + + + +---- ---------- +AllowSignedEnabled Int +CollectionTime String +FirewallUnload Int +GlobalState Int +LoggingEnabled Int +LoggingOption Int +StealthEnabled Int +SystemId String +Version String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsAlf +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlf.md +#> + Function Get-JcSdkSystemInsightAlf { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsAlf])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +225,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlfException.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlfException.ps1 index bff0db81f..40b66facd 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlfException.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlfException.ps1 @@ -1,4 +1,31 @@ -Function Get-JcSdkSystemInsightAlfException +<# +.Synopsis +Valid filter fields are `system_id` and `state`. +.Description +Valid filter fields are `system_id` and `state`. +.Example +PS C:\> Get-JcSdkSystemInsightAlfException + + + +---- ---------- +CollectionTime String +Path String +State System.Nullable[float] State {get;set;} +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsAlfExceptions +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfException.md +#> + Function Get-JcSdkSystemInsightAlfException { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsAlfExceptions])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +220,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlfExplicitAuth.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlfExplicitAuth.ps1 index 777053b68..bf7fc66e3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlfExplicitAuth.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAlfExplicitAuth.ps1 @@ -1,4 +1,30 @@ -Function Get-JcSdkSystemInsightAlfExplicitAuth +<# +.Synopsis +Valid filter fields are `system_id` and `process`. +.Description +Valid filter fields are `system_id` and `process`. +.Example +PS C:\> Get-JcSdkSystemInsightAlfExplicitAuth + + + +---- ---------- +CollectionTime String +Process String +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsAlfExplicitAuths +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfExplicitAuth.md +#> + Function Get-JcSdkSystemInsightAlfExplicitAuth { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsAlfExplicitAuths])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +219,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightApp.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightApp.ps1 index e3a6f0c8e..7dc436f20 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightApp.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightApp.ps1 @@ -1,4 +1,54 @@ -Function Get-JcSdkSystemInsightApp +<# +.Synopsis +Lists all apps for macOS devices. +For Windows devices, use [List System Insights Programs](#operation/systeminsights_list_programs). + +Valid filter fields are `system_id` and `bundle_name`. +.Description +Lists all apps for macOS devices. +For Windows devices, use [List System Insights Programs](#operation/systeminsights_list_programs). + +Valid filter fields are `system_id` and `bundle_name`. +.Example +PS C:\> Get-JcSdkSystemInsightApp + + + +---- ---------- +ApplescriptEnabled String +BundleExecutable String +BundleIdentifier String +BundleName String +BundlePackageType String +BundleShortVersion String +BundleVersion String +Category String +CollectionTime String +Compiler String +Copyright String +DevelopmentRegion String +DisplayName String +Element String +Environment String +InfoString +LastOpenedTime System.Nullable[float] LastOpenedTime {get;set;} +MinimumSystemVersion String +Name String +Path String +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsApps +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightApp.md +#> + Function Get-JcSdkSystemInsightApp { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsApps])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +243,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAppCompatShim.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAppCompatShim.ps1 index f4006ea7d..7b50a33e1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAppCompatShim.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAppCompatShim.ps1 @@ -1,4 +1,35 @@ -Function Get-JcSdkSystemInsightAppCompatShim +<# +.Synopsis +Valid filter fields are `system_id` and `enabled`. +.Description +Valid filter fields are `system_id` and `enabled`. +.Example +PS C:\> Get-JcSdkSystemInsightAppCompatShim + + + +---- ---------- +CollectionTime String +Description String +Executable String +InstallTime System.Nullable[float] InstallTime {get;set;} +Path String +SdbId String +SystemId String +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsAppcompatShims +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAppCompatShim.md +#> + Function Get-JcSdkSystemInsightAppCompatShim { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsAppcompatShims])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +224,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAuthorizedKey.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAuthorizedKey.ps1 index a9f78c975..0c6c3d873 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAuthorizedKey.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAuthorizedKey.ps1 @@ -1,4 +1,33 @@ -Function Get-JcSdkSystemInsightAuthorizedKey +<# +.Synopsis +Valid filter fields are `system_id` and `uid`. +.Description +Valid filter fields are `system_id` and `uid`. +.Example +PS C:\> Get-JcSdkSystemInsightAuthorizedKey + + + +---- ---------- +Algorithm String +CollectionTime String +Key String +KeyFile String +SystemId String +Uid String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsAuthorizedKeys +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAuthorizedKey.md +#> + Function Get-JcSdkSystemInsightAuthorizedKey { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsAuthorizedKeys])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +222,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAzureInstanceMetadata.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAzureInstanceMetadata.ps1 index c7fd6f9a4..f5d93a4e4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAzureInstanceMetadata.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAzureInstanceMetadata.ps1 @@ -1,4 +1,45 @@ -Function Get-JcSdkSystemInsightAzureInstanceMetadata +<# +.Synopsis +Valid filter fields are `system_id`. +.Description +Valid filter fields are `system_id`. +.Example +PS C:\> Get-JcSdkSystemInsightAzureInstanceMetadata + + + +---- ---------- +CollectionTime String +Location String +Name String +Offer String +OSType String +PlacementGroupId String +PlatformFaultDomain String +PlatformUpdateDomain String +Publisher String +ResourceGroupName String +Sku String +SubscriptionId String +SystemId String +Version String +VMId String +VMScaleSetName String +VMSize String +Zone String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsAzureInstanceMetadata +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceMetadata.md +#> + Function Get-JcSdkSystemInsightAzureInstanceMetadata { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsAzureInstanceMetadata])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +234,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAzureInstanceTag.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAzureInstanceTag.ps1 index 9f7791917..4f3b5d6f3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAzureInstanceTag.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightAzureInstanceTag.ps1 @@ -1,4 +1,32 @@ -Function Get-JcSdkSystemInsightAzureInstanceTag +<# +.Synopsis +Valid filter fields are `system_id`. +.Description +Valid filter fields are `system_id`. +.Example +PS C:\> Get-JcSdkSystemInsightAzureInstanceTag + + + +---- ---------- +CollectionTime String +Key String +SystemId String +Value String +VMId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsAzureInstanceTags +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceTag.md +#> + Function Get-JcSdkSystemInsightAzureInstanceTag { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsAzureInstanceTags])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +221,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBattery.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBattery.ps1 index c0c13e696..e0d62a19f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBattery.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBattery.ps1 @@ -1,4 +1,47 @@ -Function Get-JcSdkSystemInsightBattery +<# +.Synopsis +Valid filter fields are `system_id` and `health`. +.Description +Valid filter fields are `system_id` and `health`. +.Example +PS C:\> Get-JcSdkSystemInsightBattery + + + +---- ---------- +Amperage Int +Charged Int +Charging Int +CollectionTime String +Condition String +CurrentCapacity Int +CycleCount Int +DesignedCapacity Int +Health String +ManufactureDate Int +Manufacturer String +MaxCapacity Int +MinutesToFullCharge Int +MinutesUntilEmpty Int +Model String +PercentRemaining Int +SerialNumber String +State String +SystemId String +Voltage Int + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsBattery +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBattery.md +#> + Function Get-JcSdkSystemInsightBattery { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsBattery])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +236,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBitlockerInfo.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBitlockerInfo.ps1 index 22d71297b..3da742eda 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBitlockerInfo.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBitlockerInfo.ps1 @@ -1,4 +1,35 @@ -Function Get-JcSdkSystemInsightBitlockerInfo +<# +.Synopsis +Valid filter fields are `system_id` and `protection_status`. +.Description +Valid filter fields are `system_id` and `protection_status`. +.Example +PS C:\> Get-JcSdkSystemInsightBitlockerInfo + + + +---- ---------- +CollectionTime String +ConversionStatus Int +DeviceId String +DriveLetter String +EncryptionMethod String +PersistentVolumeId String +ProtectionStatus Int +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsBitlockerInfo +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBitlockerInfo.md +#> + Function Get-JcSdkSystemInsightBitlockerInfo { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsBitlockerInfo])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +224,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBrowserPlugin.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBrowserPlugin.ps1 index 7d184a8d2..ca30ea688 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBrowserPlugin.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightBrowserPlugin.ps1 @@ -1,4 +1,39 @@ -Function Get-JcSdkSystemInsightBrowserPlugin +<# +.Synopsis +Valid filter fields are `system_id` and `name`. +.Description +Valid filter fields are `system_id` and `name`. +.Example +PS C:\> Get-JcSdkSystemInsightBrowserPlugin + + + +---- ---------- +CollectionTime String +Description String +DevelopmentRegion String +Disabled Int +Identifier String +Name String +Native Int +Path String +Sdk String +SystemId String +Uid String +Version String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsBrowserPlugins +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBrowserPlugin.md +#> + Function Get-JcSdkSystemInsightBrowserPlugin { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsBrowserPlugins])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +228,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCertificate.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCertificate.ps1 index 3007eb5a6..deea6ee5f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCertificate.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCertificate.ps1 @@ -1,4 +1,49 @@ -Function Get-JcSdkSystemInsightCertificate +<# +.Synopsis +Valid filter fields are `system_id` and `common_name`. +.Description +Valid filter fields are `system_id` and `common_name`. +.Example +PS C:\> Get-JcSdkSystemInsightCertificate + + + +---- ---------- +AuthorityKeyId String +Ca Int +CommonName String +Issuer String +KeyAlgorithm String +KeyStrength String +KeyUsage String +NotValidAfter String +NotValidBefore String +Path String +SelfSigned Int +Serial String +Sha1 String +Sid String +SigningAlgorithm String +Store String +StoreId String +StoreLocation String +Subject String +SubjectKeyId String +SystemId String +Username String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsCertificates +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCertificate.md +#> + Function Get-JcSdkSystemInsightCertificate { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsCertificates])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +238,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightChassisInfo.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightChassisInfo.ps1 index f1be038e2..64bc0c083 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightChassisInfo.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightChassisInfo.ps1 @@ -1,4 +1,42 @@ -Function Get-JcSdkSystemInsightChassisInfo +<# +.Synopsis +Valid filter fields are `system_id`. +.Description +Valid filter fields are `system_id`. +.Example +PS C:\> Get-JcSdkSystemInsightChassisInfo + + + +---- ---------- +AudibleAlarm String +BreachDescription String +ChassisTypes String +CollectionTime String +Description String +Lock String +Manufacturer String +Model String +SecurityBreach String +Serial String +Sku String +SmbiosTag String +Status String +SystemId String +VisibleAlarm String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsChassisInfo +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChassisInfo.md +#> + Function Get-JcSdkSystemInsightChassisInfo { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsChassisInfo])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +231,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightChromeExtension.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightChromeExtension.ps1 index b4b575648..bb0718c7d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightChromeExtension.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightChromeExtension.ps1 @@ -1,4 +1,40 @@ -Function Get-JcSdkSystemInsightChromeExtension +<# +.Synopsis +Valid filter fields are `system_id` and `name`. +.Description +Valid filter fields are `system_id` and `name`. +.Example +PS C:\> Get-JcSdkSystemInsightChromeExtension + + + +---- ---------- +Author String +CollectionTime String +Description String +Identifier String +Locale String +Name String +Path String +Permissions String +Persistent Int +SystemId String +Uid String +UpdateUrl String +Version String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsChromeExtensions +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChromeExtension.md +#> + Function Get-JcSdkSystemInsightChromeExtension { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsChromeExtensions])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +229,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightConnectivity.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightConnectivity.ps1 index bbf77cfcc..fd221f6a3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightConnectivity.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightConnectivity.ps1 @@ -1,4 +1,38 @@ -Function Get-JcSdkSystemInsightConnectivity +<# +.Synopsis +The only valid filter field is `system_id`. +.Description +The only valid filter field is `system_id`. +.Example +PS C:\> Get-JcSdkSystemInsightConnectivity + + + +---- ---------- +CollectionTime String +Disconnected Int +Ipv4Internet Int +Ipv4LocalNetwork Int +Ipv4NoTraffic Int +Ipv4Subnet Int +Ipv6Internet Int +Ipv6LocalNetwork Int +Ipv6NoTraffic Int +Ipv6Subnet Int +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsConnectivity +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightConnectivity.md +#> + Function Get-JcSdkSystemInsightConnectivity { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsConnectivity])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +227,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCrash.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCrash.ps1 index 5471f0f4b..0cf3299e5 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCrash.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCrash.ps1 @@ -1,4 +1,45 @@ -Function Get-JcSdkSystemInsightCrash +<# +.Synopsis +Valid filter fields are `system_id` and `identifier`. +.Description +Valid filter fields are `system_id` and `identifier`. +.Example +PS C:\> Get-JcSdkSystemInsightCrash + + + +---- ---------- +CollectionTime String +CrashedThread String +CrashPath String +Datetime String +ExceptionCodes String +ExceptionNotes String +ExceptionType String +Identifier String +Parent String +Path String +Pid String +Registers String +Responsible String +StackTrace String +SystemId String +Type String +Uid Int +Version String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsCrashes +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCrash.md +#> + Function Get-JcSdkSystemInsightCrash { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsCrashes])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +234,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCupDestination.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCupDestination.ps1 index f9482fd48..8a9aabae3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCupDestination.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightCupDestination.ps1 @@ -1,4 +1,31 @@ -Function Get-JcSdkSystemInsightCupDestination +<# +.Synopsis +Valid filter fields are `system_id` and `name`. +.Description +Valid filter fields are `system_id` and `name`. +.Example +PS C:\> Get-JcSdkSystemInsightCupDestination + + + +---- ---------- +Name String +OptionName String +OptionValue String +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsCupsDestinations +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCupDestination.md +#> + Function Get-JcSdkSystemInsightCupDestination { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsCupsDestinations])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +220,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDiskEncryption.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDiskEncryption.ps1 index 4bf3eca09..45fc79afe 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDiskEncryption.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDiskEncryption.ps1 @@ -1,4 +1,36 @@ -Function Get-JcSdkSystemInsightDiskEncryption +<# +.Synopsis +Valid filter fields are `system_id` and `encryption_status`. +.Description +Valid filter fields are `system_id` and `encryption_status`. +.Example +PS C:\> Get-JcSdkSystemInsightDiskEncryption + + + +---- ---------- +CollectionTime String +Encrypted Int +EncryptionStatus String +Name String +SystemId String +Type String +Uid String +UserUuid String +Uuid String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsDiskEncryption +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskEncryption.md +#> + Function Get-JcSdkSystemInsightDiskEncryption { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsDiskEncryption])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +225,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDiskInfo.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDiskInfo.ps1 index f94bf48e4..10c50ccdd 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDiskInfo.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDiskInfo.ps1 @@ -1,4 +1,40 @@ -Function Get-JcSdkSystemInsightDiskInfo +<# +.Synopsis +Valid filter fields are `system_id` and `disk_index`. +.Description +Valid filter fields are `system_id` and `disk_index`. +.Example +PS C:\> Get-JcSdkSystemInsightDiskInfo + + + +---- ---------- +CollectionTime String +Description String +DiskIndex Int +DiskSize String +HardwareModel String +Id String +Manufacturer String +Name String +Partitions Int +PnpDeviceId String +Serial String +SystemId String +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsDiskInfo +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskInfo.md +#> + Function Get-JcSdkSystemInsightDiskInfo { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsDiskInfo])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +229,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDnsResolver.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDnsResolver.ps1 index a13dce0cb..84aa72d5a 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDnsResolver.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightDnsResolver.ps1 @@ -1,4 +1,34 @@ -Function Get-JcSdkSystemInsightDnsResolver +<# +.Synopsis +Valid filter fields are `system_id` and `type`. +.Description +Valid filter fields are `system_id` and `type`. +.Example +PS C:\> Get-JcSdkSystemInsightDnsResolver + + + +---- ---------- +Address String +CollectionTime String +Id System.Nullable[float] Id {get;set;} +Netmask String +Options String +SystemId String +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsDnsResolvers +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDnsResolver.md +#> + Function Get-JcSdkSystemInsightDnsResolver { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsDnsResolvers])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +223,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightEtcHost.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightEtcHost.ps1 index 32d2980d6..8c7182fbc 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightEtcHost.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightEtcHost.ps1 @@ -1,4 +1,31 @@ -Function Get-JcSdkSystemInsightEtcHost +<# +.Synopsis +Valid filter fields are `system_id` and `address`. +.Description +Valid filter fields are `system_id` and `address`. +.Example +PS C:\> Get-JcSdkSystemInsightEtcHost + + + +---- ---------- +Address String +CollectionTime String +Hostnames String +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsEtcHosts +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightEtcHost.md +#> + Function Get-JcSdkSystemInsightEtcHost { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsEtcHosts])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +220,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightFirefoxAddon.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightFirefoxAddon.ps1 index a64b00c40..a54c0dea1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightFirefoxAddon.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightFirefoxAddon.ps1 @@ -1,4 +1,43 @@ -Function Get-JcSdkSystemInsightFirefoxAddon +<# +.Synopsis +Valid filter fields are `system_id` and `name`. +.Description +Valid filter fields are `system_id` and `name`. +.Example +PS C:\> Get-JcSdkSystemInsightFirefoxAddon + + + +---- ---------- +Active Int +Autoupdate Int +CollectionTime String +Creator String +Description String +Disabled Int +Identifier String +Location String +Name String +Path String +SourceUrl String +SystemId String +Type String +Uid String +Version String +Visible Int + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsFirefoxAddons +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightFirefoxAddon.md +#> + Function Get-JcSdkSystemInsightFirefoxAddon { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsFirefoxAddons])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +232,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightGroup.ps1 index 87fa1618f..438b4ec7d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightGroup.ps1 @@ -1,4 +1,34 @@ -Function Get-JcSdkSystemInsightGroup +<# +.Synopsis +Valid filter fields are `system_id` and `groupname`. +.Description +Valid filter fields are `system_id` and `groupname`. +.Example +PS C:\> Get-JcSdkSystemInsightGroup + + + +---- ---------- +CollectionTime String +Comment String +Gid String +GidSigned String +Groupname String +GroupSid String +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsGroups +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightGroup.md +#> + Function Get-JcSdkSystemInsightGroup { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsGroups])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +223,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightIeExtension.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightIeExtension.ps1 index 6506758d8..ad9118f68 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightIeExtension.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightIeExtension.ps1 @@ -1,4 +1,33 @@ -Function Get-JcSdkSystemInsightIeExtension +<# +.Synopsis +Valid filter fields are `system_id` and `name`. +.Description +Valid filter fields are `system_id` and `name`. +.Example +PS C:\> Get-JcSdkSystemInsightIeExtension + + + +---- ---------- +CollectionTime String +Name String +Path String +RegistryPath String +SystemId String +Version String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsIeExtensions +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightIeExtension.md +#> + Function Get-JcSdkSystemInsightIeExtension { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsIeExtensions])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +222,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightInterfaceAddress.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightInterfaceAddress.ps1 index e20a0020c..2f8507782 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightInterfaceAddress.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightInterfaceAddress.ps1 @@ -1,4 +1,36 @@ -Function Get-JcSdkSystemInsightInterfaceAddress +<# +.Synopsis +Valid filter fields are `system_id` and `address`. +.Description +Valid filter fields are `system_id` and `address`. +.Example +PS C:\> Get-JcSdkSystemInsightInterfaceAddress + + + +---- ---------- +Address String +Broadcast String +CollectionTime String +FriendlyName String +Interface String +Mask String +PointToPoint String +SystemId String +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsInterfaceAddresses +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceAddress.md +#> + Function Get-JcSdkSystemInsightInterfaceAddress { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsInterfaceAddresses])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +225,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightInterfaceDetail.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightInterfaceDetail.ps1 index cf0f85f02..761bcf3c6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightInterfaceDetail.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightInterfaceDetail.ps1 @@ -1,4 +1,63 @@ -Function Get-JcSdkSystemInsightInterfaceDetail +<# +.Synopsis +Valid filter fields are `system_id` and `interface`. +.Description +Valid filter fields are `system_id` and `interface`. +.Example +PS C:\> Get-JcSdkSystemInsightInterfaceDetail + + + +---- ---------- +Collisions String +ConnectionId String +ConnectionStatus String +Description String +DhcpEnabled Int +DhcpLeaseExpires String +DhcpLeaseObtained String +DhcpServer String +DnsDomain String +DnsDomainSuffixSearchOrder String +DnsHostName String +DnsServerSearchOrder String +Enabled Int +Flags Int +FriendlyName String +Ibytes String +Idrops String +Ierrors String +Interface String +Ipackets String +LastChange String +LinkSpeed String +Mac String +Manufacturer String +Metric Int +Mtu Int +Obytes String +Odrops String +Oerrors String +Opackets String +PciSlot String +PhysicalAdapter Int +Service String +Speed Int +SystemId String +Type Int + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsInterfaceDetails +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceDetail.md +#> + Function Get-JcSdkSystemInsightInterfaceDetail { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsInterfaceDetails])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +252,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightKernelInfo.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightKernelInfo.ps1 index ab1ea3c39..bf14f2d72 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightKernelInfo.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightKernelInfo.ps1 @@ -1,4 +1,33 @@ -Function Get-JcSdkSystemInsightKernelInfo +<# +.Synopsis +Valid filter fields are `system_id` and `version`. +.Description +Valid filter fields are `system_id` and `version`. +.Example +PS C:\> Get-JcSdkSystemInsightKernelInfo + + + +---- ---------- +Arguments String +CollectionTime String +Device String +Path String +SystemId String +Version String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsKernelInfo +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightKernelInfo.md +#> + Function Get-JcSdkSystemInsightKernelInfo { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsKernelInfo])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +222,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLaunchd.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLaunchd.ps1 index 410e10a07..7df764526 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLaunchd.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLaunchd.ps1 @@ -1,4 +1,50 @@ -Function Get-JcSdkSystemInsightLaunchd +<# +.Synopsis +Valid filter fields are `system_id` and `name`. +.Description +Valid filter fields are `system_id` and `name`. +.Example +PS C:\> Get-JcSdkSystemInsightLaunchd + + + +---- ---------- +CollectionTime String +Disabled String +Groupname String +InetdCompatibility String +KeepAlive String +Label String +Name String +OnDemand String +Path String +ProcessType String +Program String +ProgramArguments String +QueueDirectories String +RootDirectory String +RunAtLoad String +StartInterval String +StartOnMount String +StderrPath String +StdoutPath String +SystemId String +Username String +WatchPaths String +WorkingDirectory String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsLaunchd +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLaunchd.md +#> + Function Get-JcSdkSystemInsightLaunchd { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsLaunchd])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +239,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLinuxPackage.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLinuxPackage.ps1 index 663709a0e..3c4e3001b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLinuxPackage.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLinuxPackage.ps1 @@ -1,4 +1,47 @@ -Function Get-JcSdkSystemInsightLinuxPackage +<# +.Synopsis +Lists all programs for Linux devices. +For macOS devices, use [List System Insights System Apps](#operation/systeminsights_list_apps). +For windows devices, use [List System Insights System Apps](#operation/systeminsights_list_programs). + +Valid filter fields are `name` and `package_format`. +.Description +Lists all programs for Linux devices. +For macOS devices, use [List System Insights System Apps](#operation/systeminsights_list_apps). +For windows devices, use [List System Insights System Apps](#operation/systeminsights_list_programs). + +Valid filter fields are `name` and `package_format`. +.Example +PS C:\> Get-JcSdkSystemInsightLinuxPackage + + + +---- ---------- +Arch String +InstallTime Int +MaintainerOrVendor String +MountNamespaceId String +Name String +PackageFormat String +PackageGroupOrSection String +PidWithNamespace Int +ReleaseOrRevision String +Size String +SystemId String +Version String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsLinuxPackages +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLinuxPackage.md +#> + Function Get-JcSdkSystemInsightLinuxPackage { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsLinuxPackages])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +236,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLoggedinUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLoggedinUser.ps1 index 65e8195e8..997dc16f0 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLoggedinUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLoggedinUser.ps1 @@ -1,4 +1,35 @@ -Function Get-JcSdkSystemInsightLoggedinUser +<# +.Synopsis +Valid filter fields are `system_id` and `user`. +.Description +Valid filter fields are `system_id` and `user`. +.Example +PS C:\> Get-JcSdkSystemInsightLoggedinUser + + + +---- ---------- +CollectionTime String +Host String +Pid Int +SystemId String +Time Int +Tty String +Type String +User String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsLoggedInUsers +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLoggedinUser.md +#> + Function Get-JcSdkSystemInsightLoggedinUser { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsLoggedInUsers])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +224,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLogicalDrive.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLogicalDrive.ps1 index afb27862e..067284dc7 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLogicalDrive.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightLogicalDrive.ps1 @@ -1,4 +1,35 @@ -Function Get-JcSdkSystemInsightLogicalDrive +<# +.Synopsis +Valid filter fields are `system_id` and `device_id`. +.Description +Valid filter fields are `system_id` and `device_id`. +.Example +PS C:\> Get-JcSdkSystemInsightLogicalDrive + + + +---- ---------- +BootPartition Int +CollectionTime String +DeviceId String +FileSystem String +FreeSpace String +Size String +SystemId String +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsLogicalDrives +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLogicalDrive.md +#> + Function Get-JcSdkSystemInsightLogicalDrive { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsLogicalDrives])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +224,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightManagedPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightManagedPolicy.ps1 index 25b13c400..0bd27bafb 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightManagedPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightManagedPolicy.ps1 @@ -1,4 +1,35 @@ -Function Get-JcSdkSystemInsightManagedPolicy +<# +.Synopsis +Valid filter fields are `system_id` and `domain`. +.Description +Valid filter fields are `system_id` and `domain`. +.Example +PS C:\> Get-JcSdkSystemInsightManagedPolicy + + + +---- ---------- +CollectionTime String +Domain String +Manual Int +Name String +SystemId String +Username String +Uuid String +Value String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsManagedPolicies +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightManagedPolicy.md +#> + Function Get-JcSdkSystemInsightManagedPolicy { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsManagedPolicies])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +224,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightMount.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightMount.ps1 index 9ae5e0ae0..dc803e22a 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightMount.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightMount.ps1 @@ -1,4 +1,40 @@ -Function Get-JcSdkSystemInsightMount +<# +.Synopsis +Valid filter fields are `system_id` and `path`. +.Description +Valid filter fields are `system_id` and `path`. +.Example +PS C:\> Get-JcSdkSystemInsightMount + + + +---- ---------- +Blocks String +BlocksAvailable String +BlocksFree String +BlocksSize String +CollectionTime String +Device String +DeviceAlias String +Flags String +Inodes String +InodesFree String +Path String +SystemId String +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsMounts +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightMount.md +#> + Function Get-JcSdkSystemInsightMount { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsMounts])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +229,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightOSVersion.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightOSVersion.ps1 index f1e382d63..7e0d52aec 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightOSVersion.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightOSVersion.ps1 @@ -1,4 +1,39 @@ -Function Get-JcSdkSystemInsightOSVersion +<# +.Synopsis +Valid filter fields are `system_id` and `version`. +.Description +Valid filter fields are `system_id` and `version`. +.Example +PS C:\> Get-JcSdkSystemInsightOSVersion + + + +---- ---------- +Build String +Codename String +CollectionTime String +InstallDate String +Major Int +Minor Int +Name String +Patch Int +Platform String +PlatformLike String +SystemId String +Version String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsOSVersion +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightOSVersion.md +#> + Function Get-JcSdkSystemInsightOSVersion { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsOSVersion])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +228,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightPatch.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightPatch.ps1 index ccd54c7b4..449616376 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightPatch.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightPatch.ps1 @@ -1,4 +1,37 @@ -Function Get-JcSdkSystemInsightPatch +<# +.Synopsis +Valid filter fields are `system_id` and `hotfix_id`. +.Description +Valid filter fields are `system_id` and `hotfix_id`. +.Example +PS C:\> Get-JcSdkSystemInsightPatch + + + +---- ---------- +Caption String +CollectionTime String +Csname String +Description String +FixComments String +HotfixId String +InstallDate String +InstalledBy String +InstalledOn String +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsPatches +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPatch.md +#> + Function Get-JcSdkSystemInsightPatch { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsPatches])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +226,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightProgram.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightProgram.ps1 index e5dc3d50b..9895708c1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightProgram.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightProgram.ps1 @@ -1,4 +1,44 @@ -Function Get-JcSdkSystemInsightProgram +<# +.Synopsis +Lists all programs for Windows devices. +For macOS devices, use [List System Insights Apps](#operation/systeminsights_list_apps). + +Valid filter fields are `system_id` and `name`. +.Description +Lists all programs for Windows devices. +For macOS devices, use [List System Insights Apps](#operation/systeminsights_list_apps). + +Valid filter fields are `system_id` and `name`. +.Example +PS C:\> Get-JcSdkSystemInsightProgram + + + +---- ---------- +CollectionTime String +IdentifyingNumber String +InstallDate String +InstallLocation String +InstallSource String +Language String +Name String +Publisher String +SystemId String +UninstallString +Version String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsPrograms +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightProgram.md +#> + Function Get-JcSdkSystemInsightProgram { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsPrograms])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +233,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightPythonPackage.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightPythonPackage.ps1 index 1c4fa0e34..8307d5cc4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightPythonPackage.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightPythonPackage.ps1 @@ -1,4 +1,35 @@ -Function Get-JcSdkSystemInsightPythonPackage +<# +.Synopsis +Valid filter fields are `system_id` and `name`. +.Description +Valid filter fields are `system_id` and `name`. +.Example +PS C:\> Get-JcSdkSystemInsightPythonPackage + + + +---- ---------- +Auther String +Directory String +License String +Name String +Path String +Summary String +SystemId String +Version String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsPythonPackages +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPythonPackage.md +#> + Function Get-JcSdkSystemInsightPythonPackage { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsPythonPackages])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +224,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSafariExtension.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSafariExtension.ps1 index 90c9dcfbe..189a7cd02 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSafariExtension.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSafariExtension.ps1 @@ -1,4 +1,39 @@ -Function Get-JcSdkSystemInsightSafariExtension +<# +.Synopsis +Valid filter fields are `system_id` and `name`. +.Description +Valid filter fields are `system_id` and `name`. +.Example +PS C:\> Get-JcSdkSystemInsightSafariExtension + + + +---- ---------- +Author String +CollectionTime String +Description String +DeveloperId String +Identifier String +Name String +Path String +Sdk String +SystemId String +Uid String +UpdateUrl String +Version String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsSafariExtensions +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSafariExtension.md +#> + Function Get-JcSdkSystemInsightSafariExtension { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsSafariExtensions])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +228,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightScheduledTask.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightScheduledTask.ps1 index 14687f1bf..3c9a0bdd2 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightScheduledTask.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightScheduledTask.ps1 @@ -1,4 +1,38 @@ -Function Get-JcSdkSystemInsightScheduledTask +<# +.Synopsis +Valid filter fields are `system_id` and `enabled`. +.Description +Valid filter fields are `system_id` and `enabled`. +.Example +PS C:\> Get-JcSdkSystemInsightScheduledTask + + + +---- ---------- +Action String +Enabled Int +Hidden Int +LastRunCode String +LastRunMessage String +LastRunTime String +Name String +NextRunTime String +Path String +State String +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsScheduledTasks +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightScheduledTask.md +#> + Function Get-JcSdkSystemInsightScheduledTask { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsScheduledTasks])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +227,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSecureboot.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSecureboot.ps1 index 315db03c8..c8f20626f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSecureboot.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSecureboot.ps1 @@ -1,4 +1,31 @@ -Function Get-JcSdkSystemInsightSecureboot +<# +.Synopsis +Valid filter fields are `system_id`. +.Description +Valid filter fields are `system_id`. +.Example +PS C:\> Get-JcSdkSystemInsightSecureboot + + + +---- ---------- +CollectionTime String +SecureBoot System.Nullable[float] SecureBoot {get;set;} +SetupMode System.Nullable[float] SetupMode {get;set;} +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsSecureboot +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSecureboot.md +#> + Function Get-JcSdkSystemInsightSecureboot { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsSecureboot])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +220,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightService.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightService.ps1 index afd070421..1a9502bc8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightService.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightService.ps1 @@ -1,4 +1,40 @@ -Function Get-JcSdkSystemInsightService +<# +.Synopsis +Valid filter fields are `system_id` and `name`. +.Description +Valid filter fields are `system_id` and `name`. +.Example +PS C:\> Get-JcSdkSystemInsightService + + + +---- ---------- +Description String +DisplayName String +ModulePath String +Name String +Path String +Pid Int +ServiceExitCode Int +ServiceType String +StartType String +Status String +SystemId String +UserAccount String +Win32ExitCode Int + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsServices +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightService.md +#> + Function Get-JcSdkSystemInsightService { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsServices])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +229,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightShadow.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightShadow.ps1 index d0e6e32ad..695dc8243 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightShadow.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightShadow.ps1 @@ -1,4 +1,39 @@ -Function Get-JcSdkSystemInsightShadow +<# +.Synopsis +Valid filter fields are `system_id` and `username`. +.Description +Valid filter fields are `system_id` and `username`. +.Example +PS C:\> Get-JcSdkSystemInsightShadow + + + +---- ---------- +CollectionTime String +Expire String +Flag String +HashAlg String +Inactive String +LastChange String +Max String +Min String +PasswordStatus String +SystemId String +Username String +Warning String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsShadow +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightShadow.md +#> + Function Get-JcSdkSystemInsightShadow { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsShadow])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +228,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharedFolder.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharedFolder.ps1 index 4ef0db8a2..fa8b23f83 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharedFolder.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharedFolder.ps1 @@ -1,4 +1,31 @@ -Function Get-JcSdkSystemInsightSharedFolder +<# +.Synopsis +Valid filter fields are `system_id` and `name`. +.Description +Valid filter fields are `system_id` and `name`. +.Example +PS C:\> Get-JcSdkSystemInsightSharedFolder + + + +---- ---------- +CollectionTime String +Name String +Path String +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsSharedFolders +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedFolder.md +#> + Function Get-JcSdkSystemInsightSharedFolder { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsSharedFolders])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +220,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharedResource.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharedResource.ps1 index aace56e6a..d9debb1fb 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharedResource.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharedResource.ps1 @@ -1,4 +1,37 @@ -Function Get-JcSdkSystemInsightSharedResource +<# +.Synopsis +Valid filter fields are `system_id` and `type`. +.Description +Valid filter fields are `system_id` and `type`. +.Example +PS C:\> Get-JcSdkSystemInsightSharedResource + + + +---- ---------- +AllowMaximum Int +CollectionTime String +Description String +InstallDate String +MaximumAllowed String +Name String +Path String +Status String +SystemId String +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsSharedResources +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedResource.md +#> + Function Get-JcSdkSystemInsightSharedResource { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsSharedResources])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +226,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharingPreference.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharingPreference.ps1 index ab9652b81..91f16cfec 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharingPreference.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSharingPreference.ps1 @@ -1,4 +1,39 @@ -Function Get-JcSdkSystemInsightSharingPreference +<# +.Synopsis +Only valid filed field is `system_id`. +.Description +Only valid filed field is `system_id`. +.Example +PS C:\> Get-JcSdkSystemInsightSharingPreference + + + +---- ---------- +BluetoothSharing Int +CollectionTime String +ContentCaching Int +DiscSharing Int +FileSharing Int +InternetSharing Int +PrinterSharing Int +RemoteAppleEvents Int +RemoteLogin Int +RemoteManagement Int +ScreenSharing Int +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsSharingPreferences +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharingPreference.md +#> + Function Get-JcSdkSystemInsightSharingPreference { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsSharingPreferences])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +228,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSipConfig.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSipConfig.ps1 index 97eb10e7a..3e6f8aec3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSipConfig.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSipConfig.ps1 @@ -1,4 +1,32 @@ -Function Get-JcSdkSystemInsightSipConfig +<# +.Synopsis +Valid filter fields are `system_id` and `enabled`. +.Description +Valid filter fields are `system_id` and `enabled`. +.Example +PS C:\> Get-JcSdkSystemInsightSipConfig + + + +---- ---------- +CollectionTime String +ConfigFlag String +Enabled Int +EnabledNvram Int +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsSipConfig +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSipConfig.md +#> + Function Get-JcSdkSystemInsightSipConfig { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsSipConfig])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +221,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightStartupItem.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightStartupItem.ps1 index 8431f518e..bdc4a23b6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightStartupItem.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightStartupItem.ps1 @@ -1,4 +1,35 @@ -Function Get-JcSdkSystemInsightStartupItem +<# +.Synopsis +Valid filter fields are `system_id` and `name`. +.Description +Valid filter fields are `system_id` and `name`. +.Example +PS C:\> Get-JcSdkSystemInsightStartupItem + + + +---- ---------- +Args String +Name String +Path String +Source String +Status String +SystemId String +Type String +Username String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsStartupItems +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightStartupItem.md +#> + Function Get-JcSdkSystemInsightStartupItem { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsStartupItems])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +224,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSystemControl.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSystemControl.ps1 index 7852f2cd0..b15441920 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSystemControl.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSystemControl.ps1 @@ -1,4 +1,36 @@ -Function Get-JcSdkSystemInsightSystemControl +<# +.Synopsis +Valid filter fields are `system_id` and `name`. +.Description +Valid filter fields are `system_id` and `name`. +.Example +PS C:\> Get-JcSdkSystemInsightSystemControl + + + +---- ---------- +CollectionTime String +ConfigValue String +CurrentValue String +FieldName String +Name String +Oid String +Subsystem String +SystemId String +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsSystemControls +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemControl.md +#> + Function Get-JcSdkSystemInsightSystemControl { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsSystemControls])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +225,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSystemInfo.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSystemInfo.ps1 index 5ee5ddb62..5c090bc42 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSystemInfo.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightSystemInfo.ps1 @@ -1,4 +1,44 @@ -Function Get-JcSdkSystemInsightSystemInfo +<# +.Synopsis +Valid filter fields are `system_id` and `cpu_subtype`. +.Description +Valid filter fields are `system_id` and `cpu_subtype`. +.Example +PS C:\> Get-JcSdkSystemInsightSystemInfo + + + +---- ---------- +CollectionTime String +ComputerName String +CpuBrand String +CpuLogicalCores Int +CpuMicrocode String +CpuPhysicalCores Int +CpuSubtype String +CpuType String +HardwareModel String +HardwareSerial String +HardwareVendor String +HardwareVersion String +Hostname String +LocalHostname String +PhysicalMemory String +SystemId String +Uuid String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsSystemInfo +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemInfo.md +#> + Function Get-JcSdkSystemInsightSystemInfo { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsSystemInfo])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +233,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightTpmInfo.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightTpmInfo.ps1 index ca9c067d5..cceb72c87 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightTpmInfo.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightTpmInfo.ps1 @@ -1,4 +1,38 @@ -Function Get-JcSdkSystemInsightTpmInfo +<# +.Synopsis +Valid filter fields are `system_id`. +.Description +Valid filter fields are `system_id`. +.Example +PS C:\> Get-JcSdkSystemInsightTpmInfo + + + +---- ---------- +Activated System.Nullable[float] Activated {get;set;} +CollectionTime String +Enabled System.Nullable[float] Enabled {get;set;} +ManufacturerId System.Nullable[float] ManufacturerId {get;set;} +ManufacturerName String +ManufacturerVersion String +Owned System.Nullable[float] Owned {get;set;} +PhysicalPresenceVersion String +ProductName String +SpecVersion String +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsTpmInfo +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightTpmInfo.md +#> + Function Get-JcSdkSystemInsightTpmInfo { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsTpmInfo])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +227,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUptime.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUptime.ps1 index 6b4b42477..3edf3047f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUptime.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUptime.ps1 @@ -1,4 +1,34 @@ -Function Get-JcSdkSystemInsightUptime +<# +.Synopsis +Valid filter fields are `system_id` and `days`. +.Description +Valid filter fields are `system_id` and `days`. +.Example +PS C:\> Get-JcSdkSystemInsightUptime + + + +---- ---------- +CollectionTime String +Days Int +Hours Int +Minutes Int +Seconds Int +SystemId String +TotalSeconds String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsUptime +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUptime.md +#> + Function Get-JcSdkSystemInsightUptime { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsUptime])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +223,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUsbDevice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUsbDevice.ps1 index 65de3f8f6..2c68ae51e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUsbDevice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUsbDevice.ps1 @@ -1,4 +1,41 @@ -Function Get-JcSdkSystemInsightUsbDevice +<# +.Synopsis +Valid filter fields are `system_id` and `model`. +.Description +Valid filter fields are `system_id` and `model`. +.Example +PS C:\> Get-JcSdkSystemInsightUsbDevice + + + +---- ---------- +Class String +CollectionTime String +Model String +ModelId String +Protocol String +Removable Int +Serial String +Subclass String +SystemId String +UsbAddress Int +UsbPort Int +Vendor String +VendorId String +Version String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsUsbDevices +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUsbDevice.md +#> + Function Get-JcSdkSystemInsightUsbDevice { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsUsbDevices])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +230,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUser.ps1 index cceadf1a4..6d12c5660 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUser.ps1 @@ -1,4 +1,45 @@ -Function Get-JcSdkSystemInsightUser +<# +.Synopsis +Valid filter fields are `system_id` and `username`. +.Description +Valid filter fields are `system_id` and `username`. +.Example +PS C:\> Get-JcSdkSystemInsightUser + + + +---- ---------- +AdManaged Boolean +Admin Boolean +CollectionTime String +Description String +Directory String +Gid String +GidSigned String +LastLogin String +Managed Boolean +RealUser Boolean +Shell String +Suspended Boolean +SystemId String +Type String +Uid String +UidSigned String +Username String +Uuid String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsUsers +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUser.md +#> + Function Get-JcSdkSystemInsightUser { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsUsers])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +234,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserAssist.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserAssist.ps1 index 203a2b972..d02a6682d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserAssist.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserAssist.ps1 @@ -1,4 +1,33 @@ -Function Get-JcSdkSystemInsightUserAssist +<# +.Synopsis +Valid filter fields are `system_id`. +.Description +Valid filter fields are `system_id`. +.Example +PS C:\> Get-JcSdkSystemInsightUserAssist + + + +---- ---------- +CollectionTime String +Count System.Nullable[float] Count {get;set;} +LastExecutionTime System.Nullable[float] LastExecutionTime {get;set;} +Path String +Sid String +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsUserassist +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserAssist.md +#> + Function Get-JcSdkSystemInsightUserAssist { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsUserassist])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +222,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserGroup.ps1 index 504a7c791..2118d3675 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserGroup.ps1 @@ -1,4 +1,31 @@ -Function Get-JcSdkSystemInsightUserGroup +<# +.Synopsis +Only valid filter field is `system_id`. +.Description +Only valid filter field is `system_id`. +.Example +PS C:\> Get-JcSdkSystemInsightUserGroup + + + +---- ---------- +CollectionTime String +Gid String +SystemId String +Uid String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsUserGroups +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserGroup.md +#> + Function Get-JcSdkSystemInsightUserGroup { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsUserGroups])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +220,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserSshKey.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserSshKey.ps1 index cc5861f79..c7b25c022 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserSshKey.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightUserSshKey.ps1 @@ -1,4 +1,32 @@ -Function Get-JcSdkSystemInsightUserSshKey +<# +.Synopsis +Valid filter fields are `system_id` and `uid`. +.Description +Valid filter fields are `system_id` and `uid`. +.Example +PS C:\> Get-JcSdkSystemInsightUserSshKey + + + +---- ---------- +CollectionTime String +Encrypted Int +Path String +SystemId String +Uid String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsUserSshKeys +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserSshKey.md +#> + Function Get-JcSdkSystemInsightUserSshKey { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsUserSshKeys])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +221,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWifiNetwork.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWifiNetwork.ps1 index 56b2c04cc..5e26586aa 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWifiNetwork.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWifiNetwork.ps1 @@ -1,4 +1,41 @@ -Function Get-JcSdkSystemInsightWifiNetwork +<# +.Synopsis +Valid filter fields are `system_id` and `security_type`. +.Description +Valid filter fields are `system_id` and `security_type`. +.Example +PS C:\> Get-JcSdkSystemInsightWifiNetwork + + + +---- ---------- +AutoLogin System.Nullable[float] AutoLogin {get;set;} +CaptivePortal System.Nullable[float] CaptivePortal {get;set;} +CollectionTime String +Disabled System.Nullable[float] Disabled {get;set;} +LastConnected System.Nullable[float] LastConnected {get;set;} +NetworkName String +Passpoint System.Nullable[float] Passpoint {get;set;} +PossiblyHidden System.Nullable[float] PossiblyHidden {get;set;} +Roaming System.Nullable[float] Roaming {get;set;} +RoamingProfile String +SecurityType String +Ssid String +SystemId String +TemporarilyDisabled System.Nullable[float] TemporarilyDisabled {get;set;} + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsWifiNetworks +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiNetwork.md +#> + Function Get-JcSdkSystemInsightWifiNetwork { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsWifiNetworks])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +230,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWifiStatus.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWifiStatus.ps1 index fc3f7bdd7..161c0e936 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWifiStatus.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWifiStatus.ps1 @@ -1,4 +1,42 @@ -Function Get-JcSdkSystemInsightWifiStatus +<# +.Synopsis +Valid filter fields are `system_id` and `security_type`. +.Description +Valid filter fields are `system_id` and `security_type`. +.Example +PS C:\> Get-JcSdkSystemInsightWifiStatus + + + +---- ---------- +Bssid String +Channel System.Nullable[float] Channel {get;set;} +ChannelBand System.Nullable[float] ChannelBand {get;set;} +ChannelWidth System.Nullable[float] ChannelWidth {get;set;} +CollectionTime String +CountryCode String +Interface String +Mode String +NetworkName String +Noise System.Nullable[float] Noise {get;set;} +Rssi System.Nullable[float] Rssi {get;set;} +SecurityType String +Ssid String +SystemId String +TransmitRate String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsWifiStatus +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiStatus.md +#> + Function Get-JcSdkSystemInsightWifiStatus { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsWifiStatus])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +231,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWindowsSecurityCenter.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWindowsSecurityCenter.ps1 index 820684282..8ba603026 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWindowsSecurityCenter.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWindowsSecurityCenter.ps1 @@ -1,4 +1,36 @@ -Function Get-JcSdkSystemInsightWindowsSecurityCenter +<# +.Synopsis +Valid filter fields are `system_id`. +.Description +Valid filter fields are `system_id`. +.Example +PS C:\> Get-JcSdkSystemInsightWindowsSecurityCenter + + + +---- ---------- +Antispyware String +Antivirus String +Autoupdate String +CollectionTime String +Firewall String +InternetSettings String +SystemId String +UserAccountControl String +WindowsSecurityCenterService String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsWindowsSecurityCenter +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityCenter.md +#> + Function Get-JcSdkSystemInsightWindowsSecurityCenter { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsWindowsSecurityCenter])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +225,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWindowsSecurityProduct.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWindowsSecurityProduct.ps1 index 44535daeb..444260a24 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWindowsSecurityProduct.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemInsightWindowsSecurityProduct.ps1 @@ -1,4 +1,35 @@ -Function Get-JcSdkSystemInsightWindowsSecurityProduct +<# +.Synopsis +Valid filter fields are `system_id` and `state`. +.Description +Valid filter fields are `system_id` and `state`. +.Example +PS C:\> Get-JcSdkSystemInsightWindowsSecurityProduct + + + +---- ---------- +CollectionTime String +Name String +RemediationPath String +SignaturesUpToDate System.Nullable[float] SignaturesUpToDate {get;set;} +State String +StateTimestamp String +SystemId String +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.ISystemInsightsWindowsSecurityProducts +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityProduct.md +#> + Function Get-JcSdkSystemInsightWindowsSecurityProduct { [OutputType([JumpCloud.SDK.V2.Models.ISystemInsightsWindowsSecurityProducts])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -193,3 +224,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemMember.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemMember.ps1 index 030ba9ed8..b54853154 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemMember.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemMember.ps1 @@ -1,4 +1,81 @@ -Function Get-JcSdkSystemMember +<# +.Synopsis +This endpoint returns all the System Groups a System is a member of. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/memberof \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint returns all the System Groups a System is a member of. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/memberof \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkSystemMember -SystemId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemMember.md +#> + Function Get-JcSdkSystemMember { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -217,3 +294,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemPolicyStatus.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemPolicyStatus.ps1 index 6c93420f2..05d108ece 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemPolicyStatus.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemPolicyStatus.ps1 @@ -1,4 +1,58 @@ -Function Get-JcSdkSystemPolicyStatus +<# +.Synopsis +This endpoint returns the policy results for a particular system. + +##### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint returns the policy results for a particular system. + +##### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkSystemPolicyStatus + + + +---- ---------- +Detail String +EndedAt Datetime +ExitStatus System.Nullable[long] ExitStatus {get;set;} +Id String +PolicyId String +StartedAt Datetime +State String +StdErr String +StdOut String +Success Boolean +SystemId String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.IPolicyResult +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemPolicyStatus.md +#> + Function Get-JcSdkSystemPolicyStatus { [OutputType([JumpCloud.SDK.V2.Models.IPolicyResult])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -208,3 +262,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseCommand.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseCommand.ps1 index 7d6cb912d..f25f2c2d9 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseCommand.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseCommand.ps1 @@ -1,4 +1,106 @@ -Function Get-JcSdkSystemTraverseCommand +<# +.Synopsis +This endpoint will return all Commands bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/commands \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint will return all Commands bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/commands \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkSystemTraverseCommand -SystemId:() + + + +---- ---------- +Command String +CommandType String +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +LaunchType String +Name String +Organization String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Schedule String +ScheduleRepeatType String +Timeout String +TimeToLiveSeconds Int +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.ICommandsGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseCommand.md +#> + Function Get-JcSdkSystemTraverseCommand { [OutputType([JumpCloud.SDK.V2.Models.ICommandsGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -203,3 +305,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraversePolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraversePolicy.ps1 index d70ae6458..bccf31411 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraversePolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraversePolicy.ps1 @@ -1,4 +1,103 @@ -Function Get-JcSdkSystemTraversePolicy +<# +.Synopsis +This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +This endpoint is not yet public as we have finish the code. + +##### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +This endpoint is not yet public as we have finish the code. + +##### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkSystemTraversePolicy -SystemId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicy.md +#> + Function Get-JcSdkSystemTraversePolicy { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +295,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraversePolicyGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraversePolicyGroup.ps1 index 5fc6b1d80..d2f557bcb 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraversePolicyGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraversePolicyGroup.ps1 @@ -1,4 +1,97 @@ -Function Get-JcSdkSystemTraversePolicyGroup +<# +.Synopsis +This endpoint will return all Policy Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policygroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint will return all Policy Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policygroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkSystemTraversePolicyGroup -SystemId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicyGroup.md +#> + Function Get-JcSdkSystemTraversePolicyGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -208,3 +301,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseUser.ps1 index 171d0e288..2ef4bf10c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseUser.ps1 @@ -1,4 +1,97 @@ -Function Get-JcSdkSystemTraverseUser +<# +.Synopsis +This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkSystemTraverseUser -SystemId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUser.md +#> + Function Get-JcSdkSystemTraverseUser { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -208,3 +301,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseUserGroup.ps1 index 23d315583..f4eccf8f3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkSystemTraverseUserGroup.ps1 @@ -1,4 +1,97 @@ -Function Get-JcSdkSystemTraverseUserGroup +<# +.Synopsis +This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkSystemTraverseUserGroup -SystemId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUserGroup.md +#> + Function Get-JcSdkSystemTraverseUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -208,3 +301,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserAssociation.ps1 index 9fb10ed0e..b1daf5df2 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserAssociation.ps1 @@ -1,4 +1,90 @@ -Function Get-JcSdkUserAssociation +<# +.Synopsis +This endpoint returns the _direct_ associations of a User. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/associations?targets=system_group \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint returns the _direct_ associations of a User. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/associations?targets=system_group \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkUserAssociation -UserId:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphConnection +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserAssociation.md +#> + Function Get-JcSdkUserAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -182,3 +268,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroup.ps1 index fe53ed33b..87cd98019 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroup.ps1 @@ -1,4 +1,107 @@ -Function Get-JcSdkUserGroup +<# +.Synopsis +This endpoint returns the details of a User Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns the details of a User Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserGroup -Fields:() -Filter:() -Sort:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +SuggestionCountAdd Int +SuggestionCountRemove Int +SuggestionCountTotal Int +Type String + + +.Example +PS C:\> Get-JcSdkUserGroup -Id:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +SuggestionCountAdd Int +SuggestionCountRemove Int +SuggestionCountTotal Int +Type String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IUserGroup +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroup.md +#> + Function Get-JcSdkUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IUserGroup])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -214,3 +317,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupAssociation.ps1 index 09c565ef9..0c4e94629 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupAssociation.ps1 @@ -1,4 +1,88 @@ -Function Get-JcSdkUserGroupAssociation +<# +.Synopsis +This endpoint returns the _direct_ associations of this User Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations?targets=system \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns the _direct_ associations of this User Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations?targets=system \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserGroupAssociation -GroupId:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphConnection +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupAssociation.md +#> + Function Get-JcSdkUserGroupAssociation { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -182,3 +266,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupMember.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupMember.ps1 index 1d305c12d..177de5343 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupMember.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupMember.ps1 @@ -1,4 +1,82 @@ -Function Get-JcSdkUserGroupMember +<# +.Synopsis +This endpoint returns the user members of a User Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns the user members of a User Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserGroupMember -GroupId:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphConnection +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMember.md +#> + Function Get-JcSdkUserGroupMember { [OutputType([JumpCloud.SDK.V2.Models.IGraphConnection])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -175,3 +253,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupMembership.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupMembership.ps1 index 87f655e41..57de04877 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupMembership.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupMembership.ps1 @@ -1,4 +1,79 @@ -Function Get-JcSdkUserGroupMembership +<# +.Synopsis +This endpoint returns all users members that are a member of this User Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/membership \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns all users members that are a member of this User Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/membership \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserGroupMembership -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMembership.md +#> + Function Get-JcSdkUserGroupMembership { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -205,3 +280,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseActiveDirectory.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseActiveDirectory.ps1 index 9235f0c01..4771f397f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseActiveDirectory.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseActiveDirectory.ps1 @@ -1,4 +1,91 @@ -Function Get-JcSdkUserGroupTraverseActiveDirectory +<# +.Synopsis +This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserGroupTraverseActiveDirectory -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseActiveDirectory.md +#> + Function Get-JcSdkUserGroupTraverseActiveDirectory { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +283,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseApplication.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseApplication.ps1 index 83f712f18..c5c3336ef 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseApplication.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseApplication.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkUserGroupTraverseApplication +<# +.Synopsis +This endpoint will return all Applications bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/applications \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Applications bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/applications \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserGroupTraverseApplication -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseApplication.md +#> + Function Get-JcSdkUserGroupTraverseApplication { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseDirectory.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseDirectory.ps1 index b3051ded6..680ec5102 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseDirectory.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseDirectory.ps1 @@ -1,4 +1,97 @@ -Function Get-JcSdkUserGroupTraverseDirectory +<# +.Synopsis +This endpoint will return all Directories bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directories from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/directories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint will return all Directories bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directories from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/directories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkUserGroupTraverseDirectory -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseDirectory.md +#> + Function Get-JcSdkUserGroupTraverseDirectory { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +289,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseGSuite.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseGSuite.ps1 index 2e2349678..c0fdcbad8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseGSuite.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseGSuite.ps1 @@ -1,4 +1,97 @@ -Function Get-JcSdkUserGroupTraverseGSuite +<# +.Synopsis +This endpoint will return all G Suite Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID/gsuites \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint will return all G Suite Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID/gsuites \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkUserGroupTraverseGSuite -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseGSuite.md +#> + Function Get-JcSdkUserGroupTraverseGSuite { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +289,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseLdapServer.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseLdapServer.ps1 index 77516c5e9..49690e109 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseLdapServer.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseLdapServer.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkUserGroupTraverseLdapServer +<# +.Synopsis +This endpoint will return all LDAP Servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/ldapservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all LDAP Servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/ldapservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserGroupTraverseLdapServer -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseLdapServer.md +#> + Function Get-JcSdkUserGroupTraverseLdapServer { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseOffice365.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseOffice365.ps1 index c99783f62..c1cc6434f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseOffice365.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseOffice365.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkUserGroupTraverseOffice365 +<# +.Synopsis +This endpoint will return all Office 365 instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/office365s \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Office 365 instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/office365s \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserGroupTraverseOffice365 -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseOffice365.md +#> + Function Get-JcSdkUserGroupTraverseOffice365 { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseRadiusServer.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseRadiusServer.ps1 index 7fb3d2f45..59cc875d6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseRadiusServer.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseRadiusServer.ps1 @@ -1,4 +1,97 @@ -Function Get-JcSdkUserGroupTraverseRadiusServer +<# +.Synopsis +This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Get-JcSdkUserGroupTraverseRadiusServer -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseRadiusServer.md +#> + Function Get-JcSdkUserGroupTraverseRadiusServer { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +289,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseSystem.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseSystem.ps1 index dd60aef0d..32a25e5f4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseSystem.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseSystem.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkUserGroupTraverseSystem +<# +.Synopsis +This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserGroupTraverseSystem -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystem.md +#> + Function Get-JcSdkUserGroupTraverseSystem { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseSystemGroup.ps1 index 27dad23cc..ba31c4794 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserGroupTraverseSystemGroup.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkUserGroupTraverseSystemGroup +<# +.Synopsis +This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserGroupTraverseSystemGroup -GroupId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystemGroup.md +#> + Function Get-JcSdkUserGroupTraverseSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserMember.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserMember.ps1 index ddbb88f68..d2d5f6e56 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserMember.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserMember.ps1 @@ -1,4 +1,79 @@ -Function Get-JcSdkUserMember +<# +.Synopsis +This endpoint returns all the User Groups a User is a member of. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/memberof \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint returns all the User Groups a User is a member of. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/memberof \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserMember -UserId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserMember.md +#> + Function Get-JcSdkUserMember { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -205,3 +280,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserPushEndpoint.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserPushEndpoint.ps1 index 97bf2df08..fafbbcc70 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserPushEndpoint.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserPushEndpoint.ps1 @@ -1,4 +1,85 @@ -Function Get-JcSdkUserPushEndpoint +<# +.Synopsis +This endpoint will retrieve a push endpoint associated with a user. +.Description +This endpoint will retrieve a push endpoint associated with a user. +.Example +PS C:\> Get-JcSdkUserPushEndpoint -UserId:() + + + +---- ---------- +DeviceAppVersion String +DeviceMake String +DeviceModel String +DeviceOS String +DeviceOSVersion String +DeviceUvEnabled Boolean +EnrollmentDate Datetime +Id String +LastUsedDate Datetime +Name String +State String + + +.Example +PS C:\> Get-JcSdkUserPushEndpoint -UserId:() -PushEndpointId:() + + + +---- ---------- +DeviceAppVersion String +DeviceMake String +DeviceModel String +DeviceOS String +DeviceOSVersion String +DeviceUvEnabled Boolean +EnrollmentDate Datetime +Id String +LastUsedDate Datetime +Name String +State String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IPushEndpointResponse +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserPushEndpoint.md +#> + Function Get-JcSdkUserPushEndpoint { [OutputType([JumpCloud.SDK.V2.Models.IPushEndpointResponse])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -127,3 +208,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseActiveDirectory.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseActiveDirectory.ps1 index 4e51c23e0..34a944110 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseActiveDirectory.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseActiveDirectory.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkUserTraverseActiveDirectory +<# +.Synopsis +This endpoint will return all Active Directory Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Active Directory instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory instance from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/activedirectories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Active Directory Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Active Directory instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory instance from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/activedirectories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserTraverseActiveDirectory -UserId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseActiveDirectory.md +#> + Function Get-JcSdkUserTraverseActiveDirectory { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseApplication.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseApplication.ps1 index 95783c961..3d00bfb17 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseApplication.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseApplication.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkUserTraverseApplication +<# +.Synopsis +This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserTraverseApplication -UserId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseApplication.md +#> + Function Get-JcSdkUserTraverseApplication { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseDirectory.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseDirectory.ps1 index d87d3a4d9..7139fd7e8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseDirectory.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseDirectory.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkUserTraverseDirectory +<# +.Synopsis +This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserTraverseDirectory -UserId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseDirectory.md +#> + Function Get-JcSdkUserTraverseDirectory { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseGSuite.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseGSuite.ps1 index c0c0eaa1b..928795c46 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseGSuite.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseGSuite.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkUserTraverseGSuite +<# +.Synopsis +This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserTraverseGSuite -UserId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseGSuite.md +#> + Function Get-JcSdkUserTraverseGSuite { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseLdapServer.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseLdapServer.ps1 index 9e514f95b..6a7ebbc21 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseLdapServer.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseLdapServer.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkUserTraverseLdapServer +<# +.Synopsis +This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserTraverseLdapServer -UserId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseLdapServer.md +#> + Function Get-JcSdkUserTraverseLdapServer { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseOffice365.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseOffice365.ps1 index e83c1d410..802241a03 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseOffice365.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseOffice365.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkUserTraverseOffice365 +<# +.Synopsis +This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserTraverseOffice365 -UserId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseOffice365.md +#> + Function Get-JcSdkUserTraverseOffice365 { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseRadiusServer.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseRadiusServer.ps1 index cf38d90d3..73c976d64 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseRadiusServer.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseRadiusServer.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkUserTraverseRadiusServer +<# +.Synopsis +This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserTraverseRadiusServer -UserId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseRadiusServer.md +#> + Function Get-JcSdkUserTraverseRadiusServer { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseSystem.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseSystem.ps1 index b8127d895..46eb43c30 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseSystem.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseSystem.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkUserTraverseSystem +<# +.Synopsis +This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserTraverseSystem -UserId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystem.md +#> + Function Get-JcSdkUserTraverseSystem { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseSystemGroup.ps1 index 2665b9225..1c62522cc 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkUserTraverseSystemGroup.ps1 @@ -1,4 +1,95 @@ -Function Get-JcSdkUserTraverseSystemGroup +<# +.Synopsis +This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Get-JcSdkUserTraverseSystemGroup -UserId:() + + + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGraphObjectWithPaths +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystemGroup.md +#> + Function Get-JcSdkUserTraverseSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.IGraphObjectWithPaths])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -196,3 +287,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkWorkday.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkWorkday.ps1 index e64dea5d7..c6734c8d1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkWorkday.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkWorkday.ps1 @@ -1,4 +1,101 @@ -Function Get-JcSdkWorkday +<# +.Synopsis +This endpoint will return all the available information about an instance of Workday. + +#### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/workdays/ \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Description +This endpoint will return all the available information about an instance of Workday. + +#### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/workdays/ \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Example +PS C:\> Get-JcSdkWorkday -Fields:() -Filter:() -Sort:() + + + +---- ---------- +BasicExpiry String +BasicIsValid Boolean +BasicMessage String +Id String +LastImport String +Name String +OauthExpiry String +OauthIsValid Boolean +OauthMessage String +ReportUrl String + + +.Example +PS C:\> Get-JcSdkWorkday -Id:() + + + +---- ---------- +BasicExpiry String +BasicIsValid Boolean +BasicMessage String +Id String +LastImport String +Name String +OauthExpiry String +OauthIsValid Boolean +OauthMessage String +ReportUrl String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IWorkdayOutput +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkday.md +#> + Function Get-JcSdkWorkday { [OutputType([JumpCloud.SDK.V2.Models.IWorkdayOutput])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] @@ -214,3 +311,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkWorkdayWorker.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkWorkdayWorker.ps1 index a48fe8d55..3ac3e9fdb 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkWorkdayWorker.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Get-JcSdkWorkdayWorker.ps1 @@ -1,4 +1,86 @@ -Function Get-JcSdkWorkdayWorker +<# +.Synopsis +This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. + +##### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + + +``` +.Description +This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. + +##### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + + +``` +.Example +PS C:\> Get-JcSdkWorkdayWorker -WorkdayId:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.WorkdayWorkerAttributes +Email String +FirstName String +LastName String +Username String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IWorkdayWorker +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkdayWorker.md +#> + Function Get-JcSdkWorkdayWorker { [OutputType([JumpCloud.SDK.V2.Models.IWorkdayWorker])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] @@ -184,3 +266,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Grant-JcSdkWorkday.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Grant-JcSdkWorkday.ps1 index 62ad8313f..d3677e0e3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Grant-JcSdkWorkday.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Grant-JcSdkWorkday.ps1 @@ -1,4 +1,110 @@ -Function Grant-JcSdkWorkday +<# +.Synopsis +This endpoint adds an authorization method to a workday instance. + +You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. +Failure to provide these credentials will result in the request being rejected. + +Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ +\t\"auth\":{ +\t \"basic\": { +\t\t\"username\": \"someDeveloper\",\t +\t\t\"password\": \"notTheRealPassword\" + +\t } +\t} +}' + +``` +.Description +This endpoint adds an authorization method to a workday instance. + +You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. +Failure to provide these credentials will result in the request being rejected. + +Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ +\t\"auth\":{ +\t \"basic\": { +\t\t\"username\": \"someDeveloper\",\t +\t\t\"password\": \"notTheRealPassword\" + +\t } +\t} +}' + +``` +.Example +PS C:\> Grant-JcSdkWorkday -WorkdayId:() -BasicPassword:() -BasicUsername:() -OauthCode:() + + +.Example +PS C:\> Grant-JcSdkWorkday -WorkdayId:() -Body:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IAuthInputObject +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [BasicPassword ]: + [BasicUsername ]: + [OauthCode ]: + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Grant-JcSdkWorkday.md +#> + Function Grant-JcSdkWorkday { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='AuthorizeExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -150,3 +256,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkScim.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkScim.ps1 index 4a063de29..c8493ac4d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkScim.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkScim.ps1 @@ -1,4 +1,61 @@ -Function Import-JcSdkScim +<# +.Synopsis +Get a list of users to import from an Application IdM service provider. +.Description +Get a list of users to import from an Application IdM service provider. +.Example +PS C:\> Import-JcSdkScim -ApplicationId:() + + + +---- ---------- +TotalCount System.Nullable[float] TotalCount {get;set;} +Users JumpCloud.SDK.V2.Models.ImportUser[] + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IImportUsersResponse +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkScim.md +#> + Function Import-JcSdkScim { [OutputType([JumpCloud.SDK.V2.Models.IImportUsersResponse])] [CmdletBinding(DefaultParameterSetName='Import', PositionalBinding=$false)] @@ -164,3 +221,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkWorkday.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkWorkday.ps1 index 8ad705817..adcb9b770 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkWorkday.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkWorkday.ps1 @@ -1,4 +1,167 @@ -Function Import-JcSdkWorkday +<# +.Synopsis +The endpoint allows you to import a Workday Import request. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '[ +\t{ +\t\t\"email\":\"{email}\", +\t\t\"firstname\":\"{firstname}\", +\t\t\"lastname\":\"{firstname}\", +\t\t\"username\":\"{username}\", +\t\t\"attributes\":[ +\t\t\t{\"name\":\"EmployeeID\",\"value\":\"0000\"}, +\t\t\t{\"name\":\"WorkdayID\",\"value\":\"name.name\"} +\t\t\t] +\t\t +\t} +] +``` +.Description +The endpoint allows you to import a Workday Import request. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '[ +\t{ +\t\t\"email\":\"{email}\", +\t\t\"firstname\":\"{firstname}\", +\t\t\"lastname\":\"{firstname}\", +\t\t\"username\":\"{username}\", +\t\t\"attributes\":[ +\t\t\t{\"name\":\"EmployeeID\",\"value\":\"0000\"}, +\t\t\t{\"name\":\"WorkdayID\",\"value\":\"name.name\"} +\t\t\t] +\t\t +\t} +] +``` +.Example +PS C:\> Import-JcSdkWorkday -WorkdayId:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +System.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserCreate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] +.Outputs +JumpCloud.SDK.V2.Models.IJobIdResult +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY >: + [AccountLocked ]: + [Activated ]: + [Addresses >]: + [Country ]: + [ExtendedAddress ]: + [Locality ]: + [PoBox ]: + [PostalCode ]: + [Region ]: + [StreetAddress ]: + [Type ]: + [AllowPublicKey ]: + [AlternateEmail ]: + [Attributes >]: + [Name ]: + [Value ]: + [Company ]: + [CostCenter ]: + [DelegatedAuthorityId ]: ObjectId of the target Active Directory connection + [DelegatedAuthorityName ]: Authority name + [Department ]: + [Description ]: + [DisableDeviceMaxLoginAttempts ]: + [Displayname ]: + [Email ]: + [EmployeeIdentifier ]: Must be unique per user. + [EmployeeType ]: + [EnableManagedUid ]: + [EnableUserPortalMultifactor ]: + [ExternalDn ]: + [ExternalPasswordExpirationDate ]: + [ExternalSourceType ]: + [ExternallyManaged ]: + [Firstname ]: + [JobTitle ]: + [Lastname ]: + [LdapBindingUser ]: + [Location ]: + [ManagedAppleId ]: + [Manager ]: Relation with another systemuser to identify the last as a manager. + [MfaConfigured ]: + [MfaExclusion ]: + [MfaExclusionDays ]: + [MfaExclusionUntil ]: + [Middlename ]: + [Password ]: + [PasswordNeverExpires ]: + [PasswordlessSudo ]: + [PhoneNumbers >]: + [Number ]: + [Type ]: + [PublicKey ]: + [RecoveryEmailAddress ]: + [Relationships >]: + [Type ]: + [Value ]: + [RestrictedField ]: + [RestrictedFieldId ]: + [RestrictedFieldType ]: + [SambaServiceUser ]: + [State ]: + [Sudo ]: + [Suspended ]: + [UnixGuid ]: + [UnixUid ]: + [Username ]: + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkday.md +#> + Function Import-JcSdkWorkday { [OutputType([JumpCloud.SDK.V2.Models.IJobIdResult])] [CmdletBinding(DefaultParameterSetName='Import', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -122,3 +285,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkWorkdayResult.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkWorkdayResult.ps1 index 142d8d8ec..cbcdaa5fd 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkWorkdayResult.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Import-JcSdkWorkdayResult.ps1 @@ -1,4 +1,82 @@ -Function Import-JcSdkWorkdayResult +<# +.Synopsis +This endpoint provides a list of job results from the workday import and will contain all imported data from Workday. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import/{ImportJobID}/results \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint provides a list of job results from the workday import and will contain all imported data from Workday. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import/{ImportJobID}/results \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Import-JcSdkWorkdayResult -Id:() -JobId:() + + + +---- ---------- +CreatedAt String +Id String +Meta JumpCloud.SDK.V2.Models.JobWorkresultMeta +PersistedFields JumpCloud.SDK.V2.Models.JobWorkresultPersistedFields +Status String +StatusMsg String +UpdatedAt String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IJobWorkresult +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkdayResult.md +#> + Function Import-JcSdkWorkdayResult { [OutputType([JumpCloud.SDK.V2.Models.IJobWorkresult])] [CmdletBinding(DefaultParameterSetName='Import', PositionalBinding=$false)] @@ -120,3 +198,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Invoke-JcSdkReclaimSoftwareAppLicense.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Invoke-JcSdkReclaimSoftwareAppLicense.ps1 index 6757f2e5e..a18779165 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Invoke-JcSdkReclaimSoftwareAppLicense.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Invoke-JcSdkReclaimSoftwareAppLicense.ps1 @@ -1,4 +1,79 @@ -Function Invoke-JcSdkReclaimSoftwareAppLicense +<# +.Synopsis +This endpoint allows you to reclaim the licenses from a software app associated with devices that are deleted. +#### Sample Request +``` +$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/reclaim-licenses \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '{}' +``` +.Description +This endpoint allows you to reclaim the licenses from a software app associated with devices that are deleted. +#### Sample Request +``` +$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/reclaim-licenses \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '{}' +``` +.Example +PS C:\> Invoke-JcSdkReclaimSoftwareAppLicense -SoftwareAppId:() + + + +---- ---------- +AssignedLicenses Int +AvailableLicenses Int +ReclaimedLicenses Int +TotalLicenses Int + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.ISoftwareAppReclaimLicenses +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Invoke-JcSdkReclaimSoftwareAppLicense.md +#> + Function Invoke-JcSdkReclaimSoftwareAppLicense { [OutputType([JumpCloud.SDK.V2.Models.ISoftwareAppReclaimLicenses])] [CmdletBinding(DefaultParameterSetName='Reclaim', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -114,3 +189,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Lock-JcSdkAppleMdmDevice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Lock-JcSdkAppleMdmDevice.ps1 index 93ad445c7..ee974cf26 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Lock-JcSdkAppleMdmDevice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Lock-JcSdkAppleMdmDevice.ps1 @@ -1,4 +1,78 @@ -Function Lock-JcSdkAppleMdmDevice +<# +.Synopsis +Locks a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/lock \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` +.Description +Locks a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/lock \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` +.Example +PS C:\> Lock-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Pin:() + + +.Example +PS C:\> Lock-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Body:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.IPathsLf7IzoApplemdmsAppleMdmIdDevicesDeviceIdLockPostRequestbodyContentApplicationJsonSchema +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [Pin ]: 6-digit PIN, required for MacOS, to lock the device + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Lock-JcSdkAppleMdmDevice.md +#> + Function Lock-JcSdkAppleMdmDevice { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='LockExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -143,3 +217,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkActiveDirectory.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkActiveDirectory.ps1 index 5a2fac231..bec6e445f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkActiveDirectory.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkActiveDirectory.ps1 @@ -1,4 +1,76 @@ -Function New-JcSdkActiveDirectory +<# +.Synopsis +This endpoint allows you to create a new Active Directory. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/ \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"domain\": \"{DC=AD_domain_name;DC=com}\" + }' +``` +.Description +This endpoint allows you to create a new Active Directory. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/ \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"domain\": \"{DC=AD_domain_name;DC=com}\" + }' +``` +.Example +PS C:\> New-JcSdkActiveDirectory -Domain:() -UseCase:() + + + +---- ---------- +Domain String +Id String +PrimaryAgent String +UseCase String + + +.Example +PS C:\> New-JcSdkActiveDirectory -Body:() + + + +---- ---------- +Domain String +Id String +PrimaryAgent String +UseCase String + + + +.Inputs +JumpCloud.SDK.V2.Models.IActiveDirectory +.Outputs +JumpCloud.SDK.V2.Models.IActiveDirectory +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [DelegationState ]: Delegation state of the Active Directory instance + [Domain ]: Domain name for this Active Directory instance. + [GroupsEnabled ]: + [UpdatedAt ]: + [UseCase ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectory.md +#> + Function New-JcSdkActiveDirectory { [OutputType([JumpCloud.SDK.V2.Models.IActiveDirectory])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -138,3 +210,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkActiveDirectoryAgent.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkActiveDirectoryAgent.ps1 index 69ed2b955..8ce74c28b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkActiveDirectoryAgent.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkActiveDirectoryAgent.ps1 @@ -1,4 +1,102 @@ -Function New-JcSdkActiveDirectoryAgent +<# +.Synopsis +This endpoint allows you to create a new Active Directory Agent. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ \"agent_type\":\"{SYNC}\" }' +``` +.Description +This endpoint allows you to create a new Active Directory Agent. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ \"agent_type\":\"{SYNC}\" }' +``` +.Example +PS C:\> New-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -AgentType:() + + + +---- ---------- +ConnectKey String +ContactAt String +Hostname String +Id String +SourceIP String +State String +Version String + + +.Example +PS C:\> New-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -Body:() + + + +---- ---------- +ConnectKey String +ContactAt String +Hostname String +Id String +SourceIP String +State String +Version String + + + +.Inputs +JumpCloud.SDK.V2.Models.IActiveDirectoryAgent +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IActiveDirectoryAgentGet +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [AgentType ]: + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectoryAgent.md +#> + Function New-JcSdkActiveDirectoryAgent { [OutputType([JumpCloud.SDK.V2.Models.IActiveDirectoryAgentGet])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -130,3 +228,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkAdministratorOrganization.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkAdministratorOrganization.ps1 index dd75673bc..a18826a57 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkAdministratorOrganization.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkAdministratorOrganization.ps1 @@ -1,4 +1,72 @@ -Function New-JcSdkAdministratorOrganization +<# +.Synopsis +This endpoint allows you to grant Administrator access to an Organization. +.Description +This endpoint allows you to grant Administrator access to an Organization. +.Example +PS C:\> New-JcSdkAdministratorOrganization -Id:() -Organization:() + + + +---- ---------- +Administrator String +Organization String + + +.Example +PS C:\> New-JcSdkAdministratorOrganization -Id:() -Body:() + + + +---- ---------- +Administrator String +Organization String + + + +.Inputs +JumpCloud.SDK.V2.Models.IAdministratorOrganizationLinkReq +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [Organization ]: The identifier for an organization to link this administrator to. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAdministratorOrganization.md +#> + Function New-JcSdkAdministratorOrganization { [OutputType([JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -130,3 +198,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkApprovalFlow.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkApprovalFlow.ps1 index aa2854965..ba4747448 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkApprovalFlow.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkApprovalFlow.ps1 @@ -1,4 +1,61 @@ -Function New-JcSdkApprovalFlow +<# +.Synopsis +Endpoint for adding a new access workflow +.Description +Endpoint for adding a new access workflow +.Example +New-JcSdkApprovalFlow -ApprovalType 'manual' -Category "Application" -Description "A new workflow" -MultiSelectDuration @("P5D") -Name "New Workflow" -ResourceId 5d67fd481da3c52aa1faa883 -ResourceType "user_group" -Status "active" -TimeBasedAccess -TtlConfig "TTL_CONFIG_MULTI_SELECT_DURATIONS" -VisibleTo @('6148cd739d38866f0814e874') + +.Inputs +JumpCloud.SDK.V2.Models.IJumpcloudIngressoCreateAccessWorkflowRequest +.Outputs +JumpCloud.SDK.V2.Models.IJumpcloudIngressoCreateAccessWorkflowResponse +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +APPROVERRESOURCES : + [RequireAll ]: + [ResourceId ]: + [ResourceName ]: + [ResourceOrder ]: + [ResourceType ]: + +BODY : + [ApprovalType ]: + [ApproverRequirement ]: + [ApproverResources >]: + [RequireAll ]: + [ResourceId ]: + [ResourceName ]: + [ResourceOrder ]: + [ResourceType ]: + [Category ]: + [Description ]: + [FixedDuration ]: + [IconColor ]: + [IconUrl ]: + [MultiSelectDuration >]: + [Name ]: + [NonAdminApproval ]: + [OrganizationObjectId ]: + [ResourceId ]: + [ResourceType ]: + [SlackConfig >]: + [SlackResourceId ]: + [SlackEnabled ]: + [Status ]: + [TimeBasedAccess ]: + [TtlConfig ]: + [VisibleTo >]: + +SLACKCONFIG : + [SlackResourceId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkApprovalFlow.md +#> + Function New-JcSdkApprovalFlow { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoCreateAccessWorkflowResponse])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -232,3 +289,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkAuthenticationPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkAuthenticationPolicy.ps1 index ad736b106..7fb4fc3e3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkAuthenticationPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkAuthenticationPolicy.ps1 @@ -1,4 +1,168 @@ -Function New-JcSdkAuthenticationPolicy +<# +.Synopsis +Create an authentication policy. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/authn/policies \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Sample Policy\", + \"disabled\": false, + \"effect\": { + \"action\": \"allow\" + }, + \"targets\": { + \"users\": { + \"inclusions\": [\"ALL\"] + }, + \"userGroups\": { + \"exclusions\": [{USER_GROUP_ID}] + }, + \"resources\": [ {\"type\": \"user_portal\" } ] + }, + \"conditions\":{ + \"ipAddressIn\": [{IP_LIST_ID}] + } + }' +``` +.Description +Create an authentication policy. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/authn/policies \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Sample Policy\", + \"disabled\": false, + \"effect\": { + \"action\": \"allow\" + }, + \"targets\": { + \"users\": { + \"inclusions\": [\"ALL\"] + }, + \"userGroups\": { + \"exclusions\": [{USER_GROUP_ID}] + }, + \"resources\": [ {\"type\": \"user_portal\" } ] + }, + \"conditions\":{ + \"ipAddressIn\": [{IP_LIST_ID}] + } + }' +``` +.Example +PS C:\> New-JcSdkAuthenticationPolicy -Conditions:() -Description:() -Disabled:() -EffectAction:() -MfaRequired:() -Name:() -TargetResources:() -Type:() -UserAttributeExclusions:() -UserAttributeInclusions:() -UserGroupExclusions:() -UserGroupInclusions:() -UserInclusions:() -UserVerificationRequirement:() + + + +---- ---------- +Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions +Description String +Disabled Boolean +EffectAction String +Id String +MfaRequired Boolean +Name String +TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] +Type String +UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserGroupExclusions String +UserGroupInclusions String +UserInclusions String +UserVerificationRequirement String + + +.Example +PS C:\> New-JcSdkAuthenticationPolicy -Body:() + + + +---- ---------- +Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions +Description String +Disabled Boolean +EffectAction String +Id String +MfaRequired Boolean +Name String +TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] +Type String +UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserGroupExclusions String +UserGroupInclusions String +UserInclusions String +UserVerificationRequirement String + + + +.Inputs +JumpCloud.SDK.V2.Models.IAuthnPolicy +.Outputs +JumpCloud.SDK.V2.Models.IAuthnPolicy +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [Conditions ]: Dictionary of + [(Any) ]: This indicates any property can be added to this object. + [CustomErrorMessage ]: The custom error message to be displayed when the policy is applied. + [CustomErrorMessageEnabled ]: Indicates whether the custom error message is enabled or not. + [Description ]: + [Disabled ]: + [EffectAction ]: + [MfaRequired ]: + [Name ]: + [ObligationMfaFactors >]: + [Type ]: + [PrimaryHelpText ]: The text to be displayed for the help link. + [PrimaryHelpUrl ]: The URL to be opened when the help link is clicked. + [SecondaryHelpText ]: The text to be displayed for the help link. + [SecondaryHelpUrl ]: The URL to be opened when the help link is clicked. + [TargetResources >]: + Type : + [Id ]: Object ID of the resource target. If undefined, then all resources of the given type are targeted. + [Type ]: AuthnPolicyType + [UserAttributeExclusions >]: + [Field ]: The only field that is currently supported is ldap_binding_user + [Operator ]: + [Value ]: Can be any value - string, number, boolean, array or object. + [UserAttributeInclusions >]: + [UserGroupExclusions >]: + [UserGroupInclusions >]: + [UserInclusions >]: + [UserVerificationRequirement ]: + +OBLIGATIONMFAFACTORS : + [Type ]: + +TARGETRESOURCES : + Type : + [Id ]: Object ID of the resource target. If undefined, then all resources of the given type are targeted. + +USERATTRIBUTEEXCLUSIONS : + [Field ]: The only field that is currently supported is ldap_binding_user + [Operator ]: + [Value ]: Can be any value - string, number, boolean, array or object. + +USERATTRIBUTEINCLUSIONS : + [Field ]: The only field that is currently supported is ldap_binding_user + [Operator ]: + [Value ]: Can be any value - string, number, boolean, array or object. +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAuthenticationPolicy.md +#> + Function New-JcSdkAuthenticationPolicy { [OutputType([JumpCloud.SDK.V2.Models.IAuthnPolicy])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -243,3 +407,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkBulkUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkBulkUser.ps1 index ab9a7c713..ddd6e28e2 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkBulkUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkBulkUser.ps1 @@ -1,4 +1,193 @@ -Function New-JcSdkBulkUser +<# +.Synopsis +The endpoint allows you to create a bulk job to asynchronously create users. +See [create a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_post) +for the full list of attributes. + +#### Default User State +The `state` of each user in the request can be explicitly passed in or +omitted. +If `state` is omitted, then the user will get created +using the value returned from the +[Get an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organizations_get) +endpoint. +The default user state for bulk created users depends on the +`creation-source` header. +For `creation-source:jumpcloud:bulk` the +default state is stored in `settings.newSystemUserStateDefaults.csvImport`. +For other `creation-source` header values, the default state is stored in +`settings.newSystemUserStateDefaults.applicationImport` + +These default state values can be changed in the admin portal settings +or by using the +[create an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organization_put) +endpoint. + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '[ + { + \"email\":\"{email}\", + \"firstname\":\"{firstname}\", + \"lastname\":\"{firstname}\", + \"username\":\"{username}\", + \"attributes\":[ + { + \"name\":\"EmployeeID\", + \"value\":\"0000\" + }, + { + \"name\":\"Custom\", + \"value\":\"attribute\" + } + ] + } +]' +``` +.Description +The endpoint allows you to create a bulk job to asynchronously create users. +See [create a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_post) +for the full list of attributes. + +#### Default User State +The `state` of each user in the request can be explicitly passed in or +omitted. +If `state` is omitted, then the user will get created +using the value returned from the +[Get an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organizations_get) +endpoint. +The default user state for bulk created users depends on the +`creation-source` header. +For `creation-source:jumpcloud:bulk` the +default state is stored in `settings.newSystemUserStateDefaults.csvImport`. +For other `creation-source` header values, the default state is stored in +`settings.newSystemUserStateDefaults.applicationImport` + +These default state values can be changed in the admin portal settings +or by using the +[create an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organization_put) +endpoint. + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '[ + { + \"email\":\"{email}\", + \"firstname\":\"{firstname}\", + \"lastname\":\"{firstname}\", + \"username\":\"{username}\", + \"attributes\":[ + { + \"name\":\"EmployeeID\", + \"value\":\"0000\" + }, + { + \"name\":\"Custom\", + \"value\":\"attribute\" + } + ] + } +]' +``` +.Example +PS C:\> New-JcSdkBulkUser + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +System.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserCreate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] +.Outputs +JumpCloud.SDK.V2.Models.IJobIdResult +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY >: + [AccountLocked ]: + [Activated ]: + [Addresses >]: + [Country ]: + [ExtendedAddress ]: + [Locality ]: + [PoBox ]: + [PostalCode ]: + [Region ]: + [StreetAddress ]: + [Type ]: + [AllowPublicKey ]: + [AlternateEmail ]: + [Attributes >]: + [Name ]: + [Value ]: + [Company ]: + [CostCenter ]: + [DelegatedAuthorityId ]: ObjectId of the target Active Directory connection + [DelegatedAuthorityName ]: Authority name + [Department ]: + [Description ]: + [DisableDeviceMaxLoginAttempts ]: + [Displayname ]: + [Email ]: + [EmployeeIdentifier ]: Must be unique per user. + [EmployeeType ]: + [EnableManagedUid ]: + [EnableUserPortalMultifactor ]: + [ExternalDn ]: + [ExternalPasswordExpirationDate ]: + [ExternalSourceType ]: + [ExternallyManaged ]: + [Firstname ]: + [JobTitle ]: + [Lastname ]: + [LdapBindingUser ]: + [Location ]: + [ManagedAppleId ]: + [Manager ]: Relation with another systemuser to identify the last as a manager. + [MfaConfigured ]: + [MfaExclusion ]: + [MfaExclusionDays ]: + [MfaExclusionUntil ]: + [Middlename ]: + [Password ]: + [PasswordNeverExpires ]: + [PasswordlessSudo ]: + [PhoneNumbers >]: + [Number ]: + [Type ]: + [PublicKey ]: + [RecoveryEmailAddress ]: + [Relationships >]: + [Type ]: + [Value ]: + [RestrictedField ]: + [RestrictedFieldId ]: + [RestrictedFieldType ]: + [SambaServiceUser ]: + [State ]: + [Sudo ]: + [Suspended ]: + [UnixGuid ]: + [UnixUid ]: + [Username ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUser.md +#> + Function New-JcSdkBulkUser { [OutputType([JumpCloud.SDK.V2.Models.IJobIdResult])] [CmdletBinding(DefaultParameterSetName='Create', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -128,3 +317,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkBulkUserState.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkBulkUserState.ps1 index a269a0d5f..618446209 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkBulkUserState.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkBulkUserState.ps1 @@ -1,4 +1,76 @@ -Function New-JcSdkBulkUserState +<# +.Synopsis +This endpoint allows you to create scheduled statechange jobs. +#### Sample Request +``` +curl -X POST \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ + -H 'x-api-key: {API_KEY}' \\ + -H 'Content-Type: application/json' \\ + -H 'Accept: application/json' \\ + -d '{ + \"user_ids\": [\"{User_ID_1}\", \"{User_ID_2}\", \"{User_ID_3}\"], + \"state\": \"SUSPENDED\", + \"start_date\": \"2000-01-01T00:00:00.000Z\" + }' +``` +.Description +This endpoint allows you to create scheduled statechange jobs. +#### Sample Request +``` +curl -X POST \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ + -H 'x-api-key: {API_KEY}' \\ + -H 'Content-Type: application/json' \\ + -H 'Accept: application/json' \\ + -d '{ + \"user_ids\": [\"{User_ID_1}\", \"{User_ID_2}\", \"{User_ID_3}\"], + \"state\": \"SUSPENDED\", + \"start_date\": \"2000-01-01T00:00:00.000Z\" + }' +``` +.Example +PS C:\> New-JcSdkBulkUserState -StartDate:() -State:() -UserIds:() -ActivationEmailOverride:() -SendActivationEmails:() + + + +---- ---------- +ScheduledDate String +ScheduledJobId String +State String +SystemUserId String + + +.Example +PS C:\> New-JcSdkBulkUserState -Body:() + + + +---- ---------- +ScheduledDate String +ScheduledJobId String +State String +SystemUserId String + + + +.Inputs +JumpCloud.SDK.V2.Models.IBulkScheduledStatechangeCreate +.Outputs +JumpCloud.SDK.V2.Models.IScheduledUserstateResult +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + StartDate : Date and time that scheduled action should occur + State : The state to move the user(s) to + UserIds >: Array of system user ids to schedule for a state change + [ActivationEmailOverride ]: Send the activation or welcome email to the specified email address upon activation. Can only be used with a single user_id and scheduled activation. This field will be ignored if `send_activation_emails` is explicitly set to false. + [SendActivationEmails ]: Set to true to send activation or welcome email(s) to each user_id upon activation. Set to false to suppress emails. Can only be used with scheduled activation(s). +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUserState.md +#> + Function New-JcSdkBulkUserState { [OutputType([JumpCloud.SDK.V2.Models.IScheduledUserstateResult])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -143,3 +215,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkCustomEmailConfiguration.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkCustomEmailConfiguration.ps1 index ac887644d..73683f48b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkCustomEmailConfiguration.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkCustomEmailConfiguration.ps1 @@ -1,4 +1,66 @@ -Function New-JcSdkCustomEmailConfiguration +<# +.Synopsis +Create the custom email configuration for the specified custom email type. + +This action is only available to paying customers. +.Description +Create the custom email configuration for the specified custom email type. + +This action is only available to paying customers. +.Example +PS C:\> New-JcSdkCustomEmailConfiguration -Subject:() -Type:() -Body:() -Button:() -Header:() -NextStepContactInfo:() -Title:() + + + +---- ---------- +Body String +Button String +Header String +Id String +NextStepContactInfo String +Subject String +Title String +Type String + + +.Example +PS C:\> New-JcSdkCustomEmailConfiguration -CustomEmail:() + + + +---- ---------- +Body String +Button String +Header String +Id String +NextStepContactInfo String +Subject String +Title String +Type String + + + +.Inputs +JumpCloud.SDK.V2.Models.ICustomEmail +.Outputs +JumpCloud.SDK.V2.Models.ICustomEmail +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +CUSTOMEMAIL : + Subject : + Type : + [Body ]: + [Button ]: + [Header ]: + [NextStepContactInfo ]: + [Title ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkCustomEmailConfiguration.md +#> + Function New-JcSdkCustomEmailConfiguration { [OutputType([JumpCloud.SDK.V2.Models.ICustomEmail])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -150,3 +212,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkDuoAccount.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkDuoAccount.ps1 index 74a86e581..98a43eed9 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkDuoAccount.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkDuoAccount.ps1 @@ -1,4 +1,51 @@ -Function New-JcSdkDuoAccount +<# +.Synopsis +Registers a Duo account for an organization. +Only one Duo account will be allowed, +in case an organization has a Duo account already a 409 (Conflict) code will be returned. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` +.Description +Registers a Duo account for an organization. +Only one Duo account will be allowed, +in case an organization has a Duo account already a 409 (Conflict) code will be returned. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` +.Example +PS C:\> New-JcSdkDuoAccount + + + +---- ---------- +Id String +Name String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Outputs +JumpCloud.SDK.V2.Models.IDuoAccount +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoAccount.md +#> + Function New-JcSdkDuoAccount { [OutputType([JumpCloud.SDK.V2.Models.IDuoAccount])] [CmdletBinding(DefaultParameterSetName='Create', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -102,3 +149,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkDuoApplication.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkDuoApplication.ps1 index 6d2aeef0b..25757ddec 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkDuoApplication.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkDuoApplication.ps1 @@ -1,4 +1,107 @@ -Function New-JcSdkDuoApplication +<# +.Synopsis +Create a Duo application for your organization and the specified account. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Application Name\", + \"apiHost\": \"api-1234.duosecurity.com\", + \"integrationKey\": \"1234\", + \"secretKey\": \"5678\" + }' +``` +.Description +Create a Duo application for your organization and the specified account. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Application Name\", + \"apiHost\": \"api-1234.duosecurity.com\", + \"integrationKey\": \"1234\", + \"secretKey\": \"5678\" + }' +``` +.Example +PS C:\> New-JcSdkDuoApplication -AccountId:() -ApiHost:() -IntegrationKey:() -Name:() -SecretKey:() + + + +---- ---------- +ApiHost String +Id String +IntegrationKey String +Name String + + +.Example +PS C:\> New-JcSdkDuoApplication -AccountId:() -Body:() + + + +---- ---------- +ApiHost String +Id String +IntegrationKey String +Name String + + + +.Inputs +JumpCloud.SDK.V2.Models.IDuoApplicationReq +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IDuoApplication +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + ApiHost : + IntegrationKey : + Name : + SecretKey : + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoApplication.md +#> + Function New-JcSdkDuoApplication { [OutputType([JumpCloud.SDK.V2.Models.IDuoApplication])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -151,3 +254,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkGSuiteTranslationRule.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkGSuiteTranslationRule.ps1 index 95f0c7ed5..53d5fbf70 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkGSuiteTranslationRule.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkGSuiteTranslationRule.ps1 @@ -1,4 +1,99 @@ -Function New-JcSdkGSuiteTranslationRule +<# +.Synopsis +This endpoint allows you to create a translation rule for a specific G Suite instance. +These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Translation Rule Parameters} + }' +``` +.Description +This endpoint allows you to create a translation rule for a specific G Suite instance. +These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Translation Rule Parameters} + }' +``` +.Example +PS C:\> New-JcSdkGSuiteTranslationRule -GsuiteId:() -BuiltIn:() -Direction:() + + + +---- ---------- +BuiltIn String +Direction String +Id String + + +.Example +PS C:\> New-JcSdkGSuiteTranslationRule -GsuiteId:() -Body:() + + + +---- ---------- +BuiltIn String +Direction String +Id String + + + +.Inputs +JumpCloud.SDK.V2.Models.IGSuiteTranslationRuleRequest +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGSuiteTranslationRule +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [BuiltIn ]: Built-in translations for G Suite export: * `user_home_addresses` - Translate all JumpCloud user addresses of type `home` to G Suite Directory user addresses of type `home` * `user_work_addresses` - Translate all JumpCloud user addresses of type `work` to G Suite Directory user addresses of type `work` * `user_other_addresses` - Translate all JumpCloud user addresses of type `other` to G Suite Directory user addresses of type `other` * `user_home_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `home` to G Suite Directory user phones of type `home` * `user_mobile_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `mobile` to G Suite Directory user phones of type `mobile` * `user_other_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `other` to G Suite Directory user phones of type `other` * `user_work_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work` to G Suite Directory user phones of type `work` * `user_work_fax_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work_fax` to G Suite Directory user phones of type `work_fax` * `user_work_mobile_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work_mobile` to G Suite Directory user phones of type `work_mobile` * `user_manager` - Translate JumpCloud user `manager` to G Suite Directory user `relations-manager` * `user_primary_organization_cost_center` - Translate JumpCloud user `costCenter` to G Suite Directory user `costCenter` for `primary` organization * `user_primary_organization_department` - Translate JumpCloud user `department` to G Suite Directory user `department` for `primary` organization * `user_primary_organization_description` - Translate JumpCloud user `employeeType` to G Suite Directory user `description` for `primary` organization * `user_primary_organization_employee_id` - Translate JumpCloud user `employeeIdentifier` to G Suite Directory user `externalIds` element of type `organization` * `user_primary_organization_title` - Translate JumpCloud user `jobTitle` to G Suite Directory user `title` for `primary` organization * `user_alternate_email` - Translate JumpCloud user `alternateEmail` to G Suite Directory user `emails` * `user_status` - Translate JumpCloud user `status` to G Suite Directory user `status` * `user_password` - Translate JumpCloud user `password` to G Suite Directory user `password` + [Direction ]: Direction identify if an attribute is going to be exported or imported from GSuite * `Import`- The data will be imported from GSuite into the user modal * `Export`- The data will be exported from the user modal to GSuite + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkGSuiteTranslationRule.md +#> + Function New-JcSdkGSuiteTranslationRule { [OutputType([JumpCloud.SDK.V2.Models.IGSuiteTranslationRule])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -137,3 +232,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkIPList.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkIPList.ps1 index bc5824473..b335cefd1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkIPList.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkIPList.ps1 @@ -1,4 +1,82 @@ -Function New-JcSdkIPList +<# +.Synopsis +Create an IP list. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/iplists \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Sample IP List\", + \"ips\": [ + \"192.168.10.12\", + \"192.168.10.20 - 192.168.10.30\", + \"123.225.10.0/32\" + ] + }' +``` +.Description +Create an IP list. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/iplists \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Sample IP List\", + \"ips\": [ + \"192.168.10.12\", + \"192.168.10.20 - 192.168.10.30\", + \"123.225.10.0/32\" + ] + }' +``` +.Example +PS C:\> New-JcSdkIPList -Description:() -Ips:() -Name:() + + + +---- ---------- +Description String +Id String +Ips String +Name String + + +.Example +PS C:\> New-JcSdkIPList -Body:() + + + +---- ---------- +Description String +Id String +Ips String +Name String + + + +.Inputs +JumpCloud.SDK.V2.Models.IIPListRequest +.Outputs +JumpCloud.SDK.V2.Models.IIPList +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [Description ]: + [Ips >]: + [Name ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkIPList.md +#> + Function New-JcSdkIPList { [OutputType([JumpCloud.SDK.V2.Models.IIPList])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -127,3 +205,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkLdapServerSambaDomain.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkLdapServerSambaDomain.ps1 index b2c4aa53e..2890bb211 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkLdapServerSambaDomain.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkLdapServerSambaDomain.ps1 @@ -1,4 +1,99 @@ -Function New-JcSdkLdapServerSambaDomain +<# +.Synopsis +This endpoint allows you to create a samba domain for an LDAP server. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"sid\":\"{SID_ID}\", + \"name\":\"{WORKGROUP_NAME}\" + }' +``` +.Description +This endpoint allows you to create a samba domain for an LDAP server. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"sid\":\"{SID_ID}\", + \"name\":\"{WORKGROUP_NAME}\" + }' +``` +.Example +PS C:\> New-JcSdkLdapServerSambaDomain -LdapserverId:() -Name:() -Sid:() + + + +---- ---------- +Id String +Name String +Sid String + + +.Example +PS C:\> New-JcSdkLdapServerSambaDomain -LdapserverId:() -Body:() + + + +---- ---------- +Id String +Name String +Sid String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.ISambaDomain +.Outputs +JumpCloud.SDK.V2.Models.ISambaDomain +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Name : Name of this domain's WorkGroup + Sid : Security identifier of this domain + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkLdapServerSambaDomain.md +#> + Function New-JcSdkLdapServerSambaDomain { [OutputType([JumpCloud.SDK.V2.Models.ISambaDomain])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -137,3 +232,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkOffice365TranslationRule.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkOffice365TranslationRule.ps1 index 117427c1f..21653c6af 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkOffice365TranslationRule.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkOffice365TranslationRule.ps1 @@ -1,4 +1,99 @@ -Function New-JcSdkOffice365TranslationRule +<# +.Synopsis +This endpoint allows you to create a translation rule for a specific Office 365 instance. +These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Translation Rule Parameters} + }' +``` +.Description +This endpoint allows you to create a translation rule for a specific Office 365 instance. +These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Translation Rule Parameters} + }' +``` +.Example +PS C:\> New-JcSdkOffice365TranslationRule -Office365Id:() -BuiltIn:() -Direction:() + + + +---- ---------- +BuiltIn String +Direction String +Id String + + +.Example +PS C:\> New-JcSdkOffice365TranslationRule -Office365Id:() -Body:() + + + +---- ---------- +BuiltIn String +Direction String +Id String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.IOffice365TranslationRuleRequest +.Outputs +JumpCloud.SDK.V2.Models.IOffice365TranslationRule +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [BuiltIn ]: Built-in translations for Office 365 (Microsoft Graph) export: * `user_alternate_email` - Translate `alternateEmail` field of JumpCloud user to `otherMails` field of Microsoft Graph `user` * `user_business_phones` - Translate `number` field of first JumpCloud user `phoneNumber` of type `work` to `businessPhones` field of Microsoft Graph `user` * `user_city` - Translate `locality` field of JumpCloud user address of type `work` to `city` field of Microsoft Graph user * `user_country` - Translate `country` field of JumpCloud user address of type `work` to `country` field of Microsoft Graph `user` * `user_department` - Translate `department` field of JumpCloud user to `department` field of Microsoft Graph `user` * `user_job_title` - Translate `jobTitle` field of JumpCloud user to `jobTitle` field of Microsoft Graph `user` * `user_manager` - Translate `manager` field of JumpCloud user to `manager` field of Microsoft Graph `user` * `user_mobile_phone` - Translate `number` field of first JumpCloud user `phoneNumber` of type `mobile` to `mobilePhone` field of Microsoft Graph `user` * `user_office_location` - Translate `location` field of JumpCloud user to `officeLocation` field of Microsoft Graph `user` * `user_postal_code` - Translate `postalCode` field of JumpCloud user address of type `work` to `postalCode` field of Microsoft Graph `user` * `user_principal_name_from_alternate_email` - Translate user `alternateEmail` field of Jumpcloud user to `userPrincipalName` field of Microsoft Graph `user` * `user_state` - Translate `region` field of JumpCloud user address of type `work` to `state` field of Microsoft Graph `user` * `user_street_address` - Translate `streetAddress` field of JumpCloud user address of type `work` to `streetAddress` field of Microsoft Graph user + [Direction ]: Direction identify if a attribute is going to be exported or imported from Office365 * `Export`- The data will exported from the user modal to Office365 + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkOffice365TranslationRule.md +#> + Function New-JcSdkOffice365TranslationRule { [OutputType([JumpCloud.SDK.V2.Models.IOffice365TranslationRule])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -137,3 +232,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkPolicy.ps1 index 3ca38c77c..ebc6890d1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkPolicy.ps1 @@ -1,4 +1,109 @@ -Function New-JcSdkPolicy +<# +.Synopsis +This endpoint allows you to create a policy. +Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policies \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Policy_Parameters} + }' +``` +.Description +This endpoint allows you to create a policy. +Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policies \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Policy_Parameters} + }' +``` +.Example +PS C:\> New-JcSdkPolicy -Name:() -TemplateId:() -Notes:() -Values:() + + + +---- ---------- +ConfigFields JumpCloud.SDK.V2.Models.PolicyTemplateConfigField[] +Id String +Name String +Notes String +TemplateActivation String +TemplateAlert String +TemplateBehavior String +TemplateDeliveryTypes String +TemplateDescription String +TemplateDisplayName String +TemplateId String +TemplateName String +TemplateOSMetaFamily String +TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] +TemplateReference String +TemplateState String +Values JumpCloud.SDK.V2.Models.PolicyValue[] + + +.Example +PS C:\> New-JcSdkPolicy -Body:() + + + +---- ---------- +ConfigFields JumpCloud.SDK.V2.Models.PolicyTemplateConfigField[] +Id String +Name String +Notes String +TemplateActivation String +TemplateAlert String +TemplateBehavior String +TemplateDeliveryTypes String +TemplateDescription String +TemplateDisplayName String +TemplateId String +TemplateName String +TemplateOSMetaFamily String +TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] +TemplateReference String +TemplateState String +Values JumpCloud.SDK.V2.Models.PolicyValue[] + + + +.Inputs +JumpCloud.SDK.V2.Models.IPolicyCreateRequest +.Outputs +JumpCloud.SDK.V2.Models.IPolicyWithDetails +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Name : The description for this specific Policy. + TemplateId : ObjectId uniquely identifying a Policy instance. + [Notes ]: The notes for this specific Policy. + [Values >]: + [ConfigFieldId ]: The ObjectId of the corresponding Policy Template configuration field. + [Sensitive ]: Defines if the value is sensitive or not. + [Value ]: The value for the configuration field for this Policy instance. + +VALUES : + [ConfigFieldId ]: The ObjectId of the corresponding Policy Template configuration field. + [Sensitive ]: Defines if the value is sensitive or not. + [Value ]: The value for the configuration field for this Policy instance. +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicy.md +#> + Function New-JcSdkPolicy { [OutputType([JumpCloud.SDK.V2.Models.IPolicyWithDetails])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -133,3 +238,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkPolicyGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkPolicyGroup.ps1 index 3f76e9c61..69583a9c0 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkPolicyGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkPolicyGroup.ps1 @@ -1,4 +1,74 @@ -Function New-JcSdkPolicyGroup +<# +.Synopsis +This endpoint allows you to create a new Policy Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policygroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"{Group_Name}\" + }' +``` +.Description +This endpoint allows you to create a new Policy Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policygroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"{Group_Name}\" + }' +``` +.Example +PS C:\> New-JcSdkPolicyGroup -Name:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +Name String +Type String + + +.Example +PS C:\> New-JcSdkPolicyGroup -Body:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +Name String +Type String + + + +.Inputs +JumpCloud.SDK.V2.Models.IPolicyGroupData +.Outputs +JumpCloud.SDK.V2.Models.IPolicyGroup +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Name : Display name of a Policy Group. +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicyGroup.md +#> + Function New-JcSdkPolicyGroup { [OutputType([JumpCloud.SDK.V2.Models.IPolicyGroup])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -114,3 +184,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkProviderAdministrator.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkProviderAdministrator.ps1 index b5d3c9dd5..183fcc627 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkProviderAdministrator.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkProviderAdministrator.ps1 @@ -1,4 +1,106 @@ -Function New-JcSdkProviderAdministrator +<# +.Synopsis +This endpoint allows you to create a provider administrator. +You must be associated with the provider to use this route. +You must provide either `role` or `roleName`. +.Description +This endpoint allows you to create a provider administrator. +You must be associated with the provider to use this route. +You must provide either `role` or `roleName`. +.Example +PS C:\> New-JcSdkProviderAdministrator -ProviderId:() -Email:() -ApiKeyAllowed:() -BindNoOrgs:() -EnableMultiFactor:() -Firstname:() -Lastname:() -Role:() -RoleName:() + + + +---- ---------- +ApiKeyAllowed Boolean +ApiKeySet Boolean +Email String +EnableMultiFactor Boolean +Firstname String +Id String +Lastname String +OrganizationAccessTotal System.Nullable[float] OrganizationAccessTotal {get;set;} +Registered Boolean +Role String +RoleName String +Suspended Boolean + + +.Example +PS C:\> New-JcSdkProviderAdministrator -ProviderId:() -Body:() + + + +---- ---------- +ApiKeyAllowed Boolean +ApiKeySet Boolean +Email String +EnableMultiFactor Boolean +Firstname String +Id String +Lastname String +OrganizationAccessTotal System.Nullable[float] OrganizationAccessTotal {get;set;} +Registered Boolean +Role String +RoleName String +Suspended Boolean + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.IProviderAdminReq +.Outputs +JumpCloud.SDK.V2.Models.IAdministrator +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Email : + [ApiKeyAllowed ]: + [ApiKeyHashCreatedAt ]: + [ApiKeyHashExpireAt ]: + [ApiKeyHashPrefix ]: + [BindNoOrgs ]: + [EnableMultiFactor ]: + [Firstname ]: + [Lastname ]: + [Role ]: + [RoleName ]: + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkProviderAdministrator.md +#> + Function New-JcSdkProviderAdministrator { [OutputType([JumpCloud.SDK.V2.Models.IAdministrator])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -200,3 +302,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkSoftwareApp.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkSoftwareApp.ps1 index 5cc9f74f9..d0745cb41 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkSoftwareApp.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkSoftwareApp.ps1 @@ -1,4 +1,236 @@ -Function New-JcSdkSoftwareApp +<# +.Synopsis +This endpoint allows you to create a Software Application that will be managed by JumpCloud on associated JumpCloud systems. +The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. + +#### Sample Request +``` +$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '{ + \"displayName\": \"Adobe Reader\", + \"settings\": [{\"packageId\": \"adobereader\"}] +}' +``` +.Description +This endpoint allows you to create a Software Application that will be managed by JumpCloud on associated JumpCloud systems. +The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. + +#### Sample Request +``` +$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '{ + \"displayName\": \"Adobe Reader\", + \"settings\": [{\"packageId\": \"adobereader\"}] +}' +``` +.Example +PS C:\> New-JcSdkSoftwareApp -DisplayName:() -Id:() -Settings:() + + + +---- ---------- +DisplayName String +Id String +Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] +UploadUrl String + + +.Example +PS C:\> New-JcSdkSoftwareApp -Body:() + + + +---- ---------- +DisplayName String +Id String +Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] +UploadUrl String + + + +.Inputs +JumpCloud.SDK.V2.Models.ISoftwareApp +.Outputs +JumpCloud.SDK.V2.Models.ISoftwareAppCreate +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [CreatedAt ]: + [DisplayName ]: + [Id ]: + [Settings >]: + [AllowUpdateDelay ]: + [AppCatalogInstallableObjectId ]: ID of the app catalog installable that created this app. + [AppFileName ]: + [AppleVppAppConfiguration ]: Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'. + [AppleVppAssignedLicenses ]: + [AppleVppAvailableLicenses ]: + [AppleVppDetails ]: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. + [(Any) ]: This indicates any property can be added to this object. + [AppleVppIsConfigEnabled ]: Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''. + [AppleVppSupportedDeviceFamilies >]: The supported device families for this VPP Application. + [AppleVppTotalLicenses ]: + [Architectures >]: + [AssetKind ]: The manifest asset kind (ex: software). + [AssetSha256Size ]: The incremental size to use for summing the package as it is downloaded. + [AssetSha256Strings >]: The array of checksums, one each for the hash size up to the total size of the package. + [AutoUpdate ]: + [BundleId ]: + [CommandLineArguments ]: Command line arguments to use with the application. + [CreatedAt ]: + [Description ]: The software app description. + [DesiredState ]: State of Install or Uninstall + [DownloadUrl ]: + [EnterpriseObjectId ]: ID of the Enterprise with which this app is associated + [Format ]: + [GoogleAndroidAppPricing ]: Whether this app is free, free with in-app purchases, or paid. + [GoogleAndroidAppVersion ]: Latest version currently available for this app. + [GoogleAndroidAuthor ]: The name of the author of this app. + [GoogleAndroidAutoUpdateMode ]: Controls the auto-update mode for the app. + [GoogleAndroidCategory ]: The app category (e.g. COMMUNICATION, SOCIAL, etc.). + [GoogleAndroidContentRating ]: The content rating for this app. + [GoogleAndroidDisplayMode ]: The display mode of the web app. + [GoogleAndroidDistributionChannel ]: How and to whom the package is made available. + [GoogleAndroidFeatures >]: The array of android features for the app. + [GoogleAndroidFullDescription ]: Full app description, if available. + [GoogleAndroidIconUrl ]: A link to an image that can be used as an icon for the app. + [GoogleAndroidInstallType ]: The type of installation to perform for an app. + [GoogleAndroidManagedConfigurationTemplateId ]: The managed configurations template for the app. + [GoogleAndroidManagedProperties ]: Indicates whether this app has managed properties or not. + [GoogleAndroidMinSdkVersion ]: The minimum Android SDK necessary to run the app. + [GoogleAndroidName ]: The name of the app in the form enterprises/{enterprise}/applications/{packageName}. + [GoogleAndroidPermissionGrants >]: + [Id ]: An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR. + [Policy ]: The policy for granting the permission. + [GoogleAndroidRuntimePermission ]: The policy for granting permission requests to apps. + [GoogleAndroidStartUrl ]: The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps. + [GoogleAndroidType ]: Type of this android application. + [GoogleAndroidUpdateTime ]: The approximate time (within 7 days) the app was last published. + [GoogleAndroidVersionCode ]: The current version of the web app. + [IconUrl ]: URL to the icon for the app. + [Location ]: Repository where the app is located within the package manager + [LocationObjectId ]: ID of the repository where the app is located within the package manager + [MicrosoftStoreDoNotUpdate ]: Indicates whether the app can be updated or not. + [MicrosoftStoreNonRemovable ]: Indicates whether the app is removable by the users or not. + [MicrosoftStorePackageFamilyName ]: Package Family Name for the app from Microsoft App Store. + [ObjectId ]: + [PackageId ]: + [PackageKind ]: The package manifest kind (ex: software-package). + [PackageManager ]: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. + [PackageSubtitle ]: The package manifest subtitle. + [PackageVersion ]: The package manifest version. + [PackageVersionUpdatedAt ]: + [Scope ]: The installation scope of the software app. + [ShortVersion ]: + [StoredPackageObjectId ]: ID of the stored package this app uses to reference the stored install media. + [StoredPackageVersions >]: + [Metadata ]: Dictionary of + [(Any) ]: This indicates any property can be added to this object. + [Name ]: + [RejectedReason ]: + [Sha256Sum ]: + [Size ]: + [Status ]: + [Version ]: + [TeamId ]: + [UpdateTool ]: + [UpdateToolArguments ]: + [UpdatedAt ]: + [VersionlessDownloadUrl ]: + [UpdatedAt ]: + +SETTINGS : + [AllowUpdateDelay ]: + [AppCatalogInstallableObjectId ]: ID of the app catalog installable that created this app. + [AppFileName ]: + [AppleVppAppConfiguration ]: Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'. + [AppleVppAssignedLicenses ]: + [AppleVppAvailableLicenses ]: + [AppleVppDetails ]: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. + [(Any) ]: This indicates any property can be added to this object. + [AppleVppIsConfigEnabled ]: Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''. + [AppleVppSupportedDeviceFamilies >]: The supported device families for this VPP Application. + [AppleVppTotalLicenses ]: + [Architectures >]: + [AssetKind ]: The manifest asset kind (ex: software). + [AssetSha256Size ]: The incremental size to use for summing the package as it is downloaded. + [AssetSha256Strings >]: The array of checksums, one each for the hash size up to the total size of the package. + [AutoUpdate ]: + [BundleId ]: + [CommandLineArguments ]: Command line arguments to use with the application. + [CreatedAt ]: + [Description ]: The software app description. + [DesiredState ]: State of Install or Uninstall + [DownloadUrl ]: + [EnterpriseObjectId ]: ID of the Enterprise with which this app is associated + [Format ]: + [GoogleAndroidAppPricing ]: Whether this app is free, free with in-app purchases, or paid. + [GoogleAndroidAppVersion ]: Latest version currently available for this app. + [GoogleAndroidAuthor ]: The name of the author of this app. + [GoogleAndroidAutoUpdateMode ]: Controls the auto-update mode for the app. + [GoogleAndroidCategory ]: The app category (e.g. COMMUNICATION, SOCIAL, etc.). + [GoogleAndroidContentRating ]: The content rating for this app. + [GoogleAndroidDisplayMode ]: The display mode of the web app. + [GoogleAndroidDistributionChannel ]: How and to whom the package is made available. + [GoogleAndroidFeatures >]: The array of android features for the app. + [GoogleAndroidFullDescription ]: Full app description, if available. + [GoogleAndroidIconUrl ]: A link to an image that can be used as an icon for the app. + [GoogleAndroidInstallType ]: The type of installation to perform for an app. + [GoogleAndroidManagedConfigurationTemplateId ]: The managed configurations template for the app. + [GoogleAndroidManagedProperties ]: Indicates whether this app has managed properties or not. + [GoogleAndroidMinSdkVersion ]: The minimum Android SDK necessary to run the app. + [GoogleAndroidName ]: The name of the app in the form enterprises/{enterprise}/applications/{packageName}. + [GoogleAndroidPermissionGrants >]: + [Id ]: An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR. + [Policy ]: The policy for granting the permission. + [GoogleAndroidRuntimePermission ]: The policy for granting permission requests to apps. + [GoogleAndroidStartUrl ]: The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps. + [GoogleAndroidType ]: Type of this android application. + [GoogleAndroidUpdateTime ]: The approximate time (within 7 days) the app was last published. + [GoogleAndroidVersionCode ]: The current version of the web app. + [IconUrl ]: URL to the icon for the app. + [Location ]: Repository where the app is located within the package manager + [LocationObjectId ]: ID of the repository where the app is located within the package manager + [MicrosoftStoreDoNotUpdate ]: Indicates whether the app can be updated or not. + [MicrosoftStoreNonRemovable ]: Indicates whether the app is removable by the users or not. + [MicrosoftStorePackageFamilyName ]: Package Family Name for the app from Microsoft App Store. + [ObjectId ]: + [PackageId ]: + [PackageKind ]: The package manifest kind (ex: software-package). + [PackageManager ]: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. + [PackageSubtitle ]: The package manifest subtitle. + [PackageVersion ]: The package manifest version. + [PackageVersionUpdatedAt ]: + [Scope ]: The installation scope of the software app. + [ShortVersion ]: + [StoredPackageObjectId ]: ID of the stored package this app uses to reference the stored install media. + [StoredPackageVersions >]: + [Metadata ]: Dictionary of + [(Any) ]: This indicates any property can be added to this object. + [Name ]: + [RejectedReason ]: + [Sha256Sum ]: + [Size ]: + [Status ]: + [Version ]: + [TeamId ]: + [UpdateTool ]: + [UpdateToolArguments ]: + [UpdatedAt ]: + [VersionlessDownloadUrl ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSoftwareApp.md +#> + Function New-JcSdkSoftwareApp { [OutputType([JumpCloud.SDK.V2.Models.ISoftwareAppCreate])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -139,3 +371,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkSystemGroup.ps1 index 412de5324..31af9abee 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkSystemGroup.ps1 @@ -1,4 +1,109 @@ -Function New-JcSdkSystemGroup +<# +.Synopsis +This endpoint allows you to create a new System Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"{Group_Name}\" + }' +``` +.Description +This endpoint allows you to create a new System Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"{Group_Name}\" + }' +``` +.Example +PS C:\> New-JcSdkSystemGroup -Name:() -Attributes:() -Description:() -Email:() -MemberQueryExemptions:() -MemberQueryFilters:() -MemberQueryType:() -MemberSuggestionsNotify:() -MembershipMethod:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +Type String + + +.Example +PS C:\> New-JcSdkSystemGroup -Body:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +Type String + + + +.Inputs +JumpCloud.SDK.V2.Models.ISystemGroupPost +.Outputs +JumpCloud.SDK.V2.Models.ISystemGroup +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Name : Display name of a System Group. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + [Description ]: Description of a System Group + [Email ]: Email address of a System Group + [MemberQueryExemptions >]: Array of GraphObjects exempted from the query + Id : The ObjectID of the graph object. + Type : The type of graph object. + [Attributes ]: The graph attributes. + [MemberQueryFilters >]: For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. + [MemberQuerySearchFilters ]: For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. + [MemberQueryType ]: + [MemberSuggestionsNotify ]: True if notification emails are to be sent for membership suggestions. + [MembershipMethod ]: The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED. Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices). Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. + +MEMBERQUERYEXEMPTIONS : + Id : The ObjectID of the graph object. + Type : The type of graph object. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSystemGroup.md +#> + Function New-JcSdkSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.ISystemGroup])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -172,3 +277,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkUserGroup.ps1 index 5a82f7f35..dca73e860 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkUserGroup.ps1 @@ -1,4 +1,125 @@ -Function New-JcSdkUserGroup +<# +.Synopsis +This endpoint allows you to create a new User Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"{Group_Name}\" + }' +``` +.Description +This endpoint allows you to create a new User Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"{Group_Name}\" + }' +``` +.Example +PS C:\> New-JcSdkUserGroup -Name:() -Attributes:() -Description:() -Email:() -MemberQueryExemptions:() -MemberQueryFilters:() -MemberQueryType:() -MemberSuggestionsNotify:() -MembershipMethod:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +SuggestionCountAdd Int +SuggestionCountRemove Int +SuggestionCountTotal Int +Type String + + +.Example +PS C:\> New-JcSdkUserGroup -Body:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +SuggestionCountAdd Int +SuggestionCountRemove Int +SuggestionCountTotal Int +Type String + + + +.Inputs +JumpCloud.SDK.V2.Models.IUserGroupPost +.Outputs +JumpCloud.SDK.V2.Models.IUserGroup +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Name : Display name of a User Group. + [Attributes ]: The graph attributes for a UserGroup. + [(Any) ]: This indicates any property can be added to this object. + [SudoEnabled ]: Enables sudo + [SudoWithoutPassword ]: Enable sudo without password (requires 'enabled' to be true) + [LdapGroups >]: + [Name ]: + [PosixGroups >]: + Id : + Name : + [RadiusReply >]: + Name : + Value : + [SambaEnabled ]: + [Description ]: Description of a User Group + [Email ]: Email address of a User Group + [MemberQueryExemptions >]: Array of GraphObjects exempted from the query + Id : The ObjectID of the graph object. + Type : The type of graph object. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + [MemberQueryFilters >]: For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. + [MemberQuerySearchFilters ]: For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. + [MemberQueryType ]: + [MemberSuggestionsNotify ]: True if notification emails are to be sent for membership suggestions. + [MembershipMethod ]: The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED. Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices). Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. + +MEMBERQUERYEXEMPTIONS : + Id : The ObjectID of the graph object. + Type : The type of graph object. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkUserGroup.md +#> + Function New-JcSdkUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IUserGroup])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -172,3 +293,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkWorkday.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkWorkday.ps1 index b811d635a..80d7818f1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkWorkday.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/New-JcSdkWorkday.ps1 @@ -1,4 +1,114 @@ -Function New-JcSdkWorkday +<# +.Synopsis +This endpoint allows you to create a new workday instance. + +You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. +Failure to provide these credentials will result in the request being rejected. + +Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. + +Currently, only one instance is allowed and it must be `Workday Import`. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Workday2\", + \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", + \"auth\": { + \"basic\": { + \"username\": \"someDeveloper\", + \"password\": \"notTheRealPassword\" + } + } + }' +``` +.Description +This endpoint allows you to create a new workday instance. + +You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. +Failure to provide these credentials will result in the request being rejected. + +Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. + +Currently, only one instance is allowed and it must be `Workday Import`. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Workday2\", + \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", + \"auth\": { + \"basic\": { + \"username\": \"someDeveloper\", + \"password\": \"notTheRealPassword\" + } + } + }' +``` +.Example +PS C:\> New-JcSdkWorkday -BasicPassword:() -BasicUsername:() -Name:() -OauthCode:() -ReportUrl:() + + + +---- ---------- +BasicExpiry String +BasicIsValid Boolean +BasicMessage String +Id String +LastImport String +Name String +OauthExpiry String +OauthIsValid Boolean +OauthMessage String +ReportUrl String + + +.Example +PS C:\> New-JcSdkWorkday -Body:() + + + +---- ---------- +BasicExpiry String +BasicIsValid Boolean +BasicMessage String +Id String +LastImport String +Name String +OauthExpiry String +OauthIsValid Boolean +OauthMessage String +ReportUrl String + + + +.Inputs +JumpCloud.SDK.V2.Models.IWorkdayInput +.Outputs +JumpCloud.SDK.V2.Models.IWorkdayOutput +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [BasicPassword ]: + [BasicUsername ]: + [Name ]: + [OauthCode ]: + [ReportUrl ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkWorkday.md +#> + Function New-JcSdkWorkday { [OutputType([JumpCloud.SDK.V2.Models.IWorkdayOutput])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -138,3 +248,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkActiveDirectory.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkActiveDirectory.ps1 index 3abfcd191..4d7ab0f68 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkActiveDirectory.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkActiveDirectory.ps1 @@ -1,4 +1,79 @@ -Function Remove-JcSdkActiveDirectory +<# +.Synopsis +This endpoint allows you to delete an Active Directory Instance. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Description +This endpoint allows you to delete an Active Directory Instance. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Example +PS C:\> Remove-JcSdkActiveDirectory -Id:() + + + +---- ---------- +Domain String +Id String +PrimaryAgent String +UseCase String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IActiveDirectory +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectory.md +#> + Function Remove-JcSdkActiveDirectory { [OutputType([JumpCloud.SDK.V2.Models.IActiveDirectory])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -114,3 +189,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkActiveDirectoryAgent.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkActiveDirectoryAgent.ps1 index 62d83d513..569abcf35 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkActiveDirectoryAgent.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkActiveDirectoryAgent.ps1 @@ -1,4 +1,71 @@ -Function Remove-JcSdkActiveDirectoryAgent +<# +.Synopsis +This endpoint deletes an Active Directory agent. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint deletes an Active Directory agent. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Remove-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -AgentId:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectoryAgent.md +#> + Function Remove-JcSdkActiveDirectoryAgent { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -126,3 +193,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAdministratorOrganization.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAdministratorOrganization.ps1 index 9a4a66fda..fdd4e2cbf 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAdministratorOrganization.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAdministratorOrganization.ps1 @@ -1,4 +1,55 @@ -Function Remove-JcSdkAdministratorOrganization +<# +.Synopsis +This endpoint removes the association link between an Administrator and an Organization. +.Description +This endpoint removes the association link between an Administrator and an Organization. +.Example +PS C:\> Remove-JcSdkAdministratorOrganization -AdministratorId:() -Id:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAdministratorOrganization.md +#> + Function Remove-JcSdkAdministratorOrganization { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -126,3 +177,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAppleMdm.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAppleMdm.ps1 index f351534a9..a6aa45c82 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAppleMdm.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAppleMdm.ps1 @@ -1,4 +1,112 @@ -Function Remove-JcSdkAppleMdm +<# +.Synopsis +Removes an Apple MDM configuration. + +Warning: This is a destructive operation and will remove your Apple Push Certificates. +We will no longer be able to manage your devices and the only recovery option is to re-register all devices into MDM. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +Removes an Apple MDM configuration. + +Warning: This is a destructive operation and will remove your Apple Push Certificates. +We will no longer be able to manage your devices and the only recovery option is to re-register all devices into MDM. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Remove-JcSdkAppleMdm -Id:() + + + +---- ---------- +AllowMobileUserEnrollment Boolean +ApnsCertExpiry String +ApnsPushTopic String +AppleCertCreatorAppleId String +AppleCertSerialNumber String +DefaultIosUserEnrollmentDeviceGroupId String +DefaultSystemGroupId String +DepAccessTokenExpiry String +DepEnableZeroTouchEnrollment Boolean +DepServerTokenState String +DepSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +Id String +IoDefaultDeviceGroupObjectIds String +IoEnableZeroTouchEnrollment Boolean +IoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +IoSetupOptions String +IosWelcomeScreenButton String +IosWelcomeScreenParagraph String +IosWelcomeScreenTitle String +MacoDefaultDeviceGroupObjectIds String +MacoEnableZeroTouchEnrollment Boolean +MacoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +MacoSetupOptions String +MacosWelcomeScreenButton String +MacosWelcomeScreenParagraph String +MacosWelcomeScreenTitle String +Name String +Organization String +WelcomeScreenButton String +WelcomeScreenParagraph String +WelcomeScreenTitle String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IAppleMdm +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdm.md +#> + Function Remove-JcSdkAppleMdm { [OutputType([JumpCloud.SDK.V2.Models.IAppleMdm])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -114,3 +222,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAppleMdmDevice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAppleMdmDevice.ps1 index 709e2631d..fd7d8c29d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAppleMdmDevice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAppleMdmDevice.ps1 @@ -1,4 +1,99 @@ -Function Remove-JcSdkAppleMdmDevice +<# +.Synopsis +Remove a single Apple MDM device from MDM enrollment. + +#### Sample Request +``` + curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ + -H 'accept: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +Remove a single Apple MDM device from MDM enrollment. + +#### Sample Request +``` + curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ + -H 'accept: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Remove-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() + + + +---- ---------- +CreatedAt String +DepRegistered Boolean +DeviceInformationActivationLockAllowedWhileSupervised Boolean +DeviceInformationAvailableDeviceCapacity System.Nullable[float] DeviceInformationAvailableDeviceCapacity {get;set;} +DeviceInformationDeviceCapacity System.Nullable[float] DeviceInformationDeviceCapacity {get;set;} +DeviceInformationDeviceName String +DeviceInformationIccid String +DeviceInformationImei String +DeviceInformationIsSupervised Boolean +DeviceInformationModelName String +DeviceInformationSecondIccid String +DeviceInformationSecondImei String +DeviceInformationSecondSubscriberCarrierNetwork String +DeviceInformationSubscriberCarrierNetwork String +DeviceInformationWifiMac String +Enrolled Boolean +HasActivationLockBypassCodes Boolean +Id String +OSVersion String +SecurityInfoEnrolledViaDep Boolean +SecurityInfoIsActivationLockManageable Boolean +SecurityInfoIsUserEnrollment Boolean +SecurityInfoPasscodePresent Boolean +SecurityInfoUserApprovedEnrollment Boolean +SerialNumber String +Udid String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IAppleMdmDevice +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdmDevice.md +#> + Function Remove-JcSdkAppleMdmDevice { [OutputType([JumpCloud.SDK.V2.Models.IAppleMdmDevice])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -120,3 +215,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkApplicationLogo.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkApplicationLogo.ps1 index b12430eca..a4145bee8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkApplicationLogo.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkApplicationLogo.ps1 @@ -1,4 +1,55 @@ -Function Remove-JcSdkApplicationLogo +<# +.Synopsis +Deletes the specified image from an application +.Description +Deletes the specified image from an application +.Example +PS C:\> Remove-JcSdkApplicationLogo -ApplicationId:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApplicationLogo.md +#> + Function Remove-JcSdkApplicationLogo { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -120,3 +171,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkApprovalFlow.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkApprovalFlow.ps1 index df5dacee4..d5ba3205e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkApprovalFlow.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkApprovalFlow.ps1 @@ -1,4 +1,51 @@ -Function Remove-JcSdkApprovalFlow +<# +.Synopsis +Endpoint for deleting accessworkflow by id +.Description +Endpoint for deleting accessworkflow by id +.Example +PS C:\> Remove-JcSdkApprovalFlow -ApprovalFlowId:() +.Example +{{ Add code here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IJumpcloudIngressoDeleteAccessWorkflowResponse +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApprovalFlow.md +#> + Function Remove-JcSdkApprovalFlow { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoDeleteAccessWorkflowResponse])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -121,3 +168,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAuthenticationPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAuthenticationPolicy.ps1 index ed620bf07..0b7b3dbb1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAuthenticationPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkAuthenticationPolicy.ps1 @@ -1,4 +1,90 @@ -Function Remove-JcSdkAuthenticationPolicy +<# +.Synopsis +Delete the specified authentication policy. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +Delete the specified authentication policy. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Remove-JcSdkAuthenticationPolicy -Id:() + + + +---- ---------- +Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions +Description String +Disabled Boolean +EffectAction String +Id String +MfaRequired Boolean +Name String +TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] +Type String +UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserGroupExclusions String +UserGroupInclusions String +UserInclusions String +UserVerificationRequirement String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IAuthnPolicy +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAuthenticationPolicy.md +#> + Function Remove-JcSdkAuthenticationPolicy { [OutputType([JumpCloud.SDK.V2.Models.IAuthnPolicy])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -114,3 +200,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkBulkUserState.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkBulkUserState.ps1 index 5775d970e..313d836a6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkBulkUserState.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkBulkUserState.ps1 @@ -1,4 +1,69 @@ -Function Remove-JcSdkBulkUserState +<# +.Synopsis +This endpoint deletes a scheduled statechange job. +#### Sample Request +``` +curl -X DELETE \"https://console.jumpcloud.com/api/v2/bulk/userstates/{ScheduledJob_ID}\" \\ + -H 'x-api-key: {API_KEY}' \\ + -H 'Content-Type: application/json' \\ + -H 'Accept: application/json' +``` +.Description +This endpoint deletes a scheduled statechange job. +#### Sample Request +``` +curl -X DELETE \"https://console.jumpcloud.com/api/v2/bulk/userstates/{ScheduledJob_ID}\" \\ + -H 'x-api-key: {API_KEY}' \\ + -H 'Content-Type: application/json' \\ + -H 'Accept: application/json' +``` +.Example +PS C:\> Remove-JcSdkBulkUserState -Id:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkBulkUserState.md +#> + Function Remove-JcSdkBulkUserState { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -120,3 +185,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkCustomEmailConfiguration.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkCustomEmailConfiguration.ps1 index 6184a9f13..809a6c615 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkCustomEmailConfiguration.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkCustomEmailConfiguration.ps1 @@ -1,4 +1,55 @@ -Function Remove-JcSdkCustomEmailConfiguration +<# +.Synopsis +Delete the custom email configuration for the specified custom email type +.Description +Delete the custom email configuration for the specified custom email type +.Example +PS C:\> Remove-JcSdkCustomEmailConfiguration -CustomEmailType:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkCustomEmailConfiguration.md +#> + Function Remove-JcSdkCustomEmailConfiguration { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -120,3 +171,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkDuoAccount.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkDuoAccount.ps1 index 744679f02..f9f3a67d6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkDuoAccount.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkDuoAccount.ps1 @@ -1,4 +1,77 @@ -Function Remove-JcSdkDuoAccount +<# +.Synopsis +Removes the specified Duo account, an error will be returned if the account has some Duo application used in a protected resource. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +Removes the specified Duo account, an error will be returned if the account has some Duo application used in a protected resource. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Remove-JcSdkDuoAccount -Id:() + + + +---- ---------- +Id String +Name String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IDuoAccount +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoAccount.md +#> + Function Remove-JcSdkDuoAccount { [OutputType([JumpCloud.SDK.V2.Models.IDuoAccount])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -114,3 +187,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkDuoApplication.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkDuoApplication.ps1 index 49504e814..351225dda 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkDuoApplication.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkDuoApplication.ps1 @@ -1,4 +1,79 @@ -Function Remove-JcSdkDuoApplication +<# +.Synopsis +Deletes the specified Duo application, an error will be returned if the application is used in a protected resource. + +#### Sample Request +``` + curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}'' +``` +.Description +Deletes the specified Duo application, an error will be returned if the application is used in a protected resource. + +#### Sample Request +``` + curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}'' +``` +.Example +PS C:\> Remove-JcSdkDuoApplication -AccountId:() -ApplicationId:() + + + +---- ---------- +ApiHost String +Id String +IntegrationKey String +Name String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IDuoApplication +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoApplication.md +#> + Function Remove-JcSdkDuoApplication { [OutputType([JumpCloud.SDK.V2.Models.IDuoApplication])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -120,3 +195,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkGSuiteTranslationRule.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkGSuiteTranslationRule.ps1 index 8879320a8..2de7b1150 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkGSuiteTranslationRule.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkGSuiteTranslationRule.ps1 @@ -1,4 +1,75 @@ -Function Remove-JcSdkGSuiteTranslationRule +<# +.Synopsis +This endpoint allows you to delete a translation rule for a specific G Suite instance. +These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. + +#### Sample Request + +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Description +This endpoint allows you to delete a translation rule for a specific G Suite instance. +These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. + +#### Sample Request + +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Example +PS C:\> Remove-JcSdkGSuiteTranslationRule -GsuiteId:() -Id:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkGSuiteTranslationRule.md +#> + Function Remove-JcSdkGSuiteTranslationRule { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -126,3 +197,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkIPList.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkIPList.ps1 index 94114b07f..d36df2ecf 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkIPList.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkIPList.ps1 @@ -1,4 +1,79 @@ -Function Remove-JcSdkIPList +<# +.Synopsis +Delete a specific IP list. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +Delete a specific IP list. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Remove-JcSdkIPList -Id:() + + + +---- ---------- +Description String +Id String +Ips String +Name String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IIPList +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkIPList.md +#> + Function Remove-JcSdkIPList { [OutputType([JumpCloud.SDK.V2.Models.IIPList])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -114,3 +189,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkLdapServerSambaDomain.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkLdapServerSambaDomain.ps1 index a0d46d257..3af650838 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkLdapServerSambaDomain.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkLdapServerSambaDomain.ps1 @@ -1,4 +1,71 @@ -Function Remove-JcSdkLdapServerSambaDomain +<# +.Synopsis +This endpoint allows you to delete a samba domain from an LDAP server. + +##### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +This endpoint allows you to delete a samba domain from an LDAP server. + +##### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Remove-JcSdkLdapServerSambaDomain -Id:() -LdapserverId:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.String +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkLdapServerSambaDomain.md +#> + Function Remove-JcSdkLdapServerSambaDomain { [OutputType([System.String])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -126,3 +193,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkOffice365TranslationRule.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkOffice365TranslationRule.ps1 index c5c0a8230..cc1e86891 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkOffice365TranslationRule.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkOffice365TranslationRule.ps1 @@ -1,4 +1,75 @@ -Function Remove-JcSdkOffice365TranslationRule +<# +.Synopsis +This endpoint allows you to delete a translation rule for a specific Office 365 instance. +These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. + +#### Sample Request + +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Description +This endpoint allows you to delete a translation rule for a specific Office 365 instance. +These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. + +#### Sample Request + +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Example +PS C:\> Remove-JcSdkOffice365TranslationRule -Id:() -Office365Id:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkOffice365TranslationRule.md +#> + Function Remove-JcSdkOffice365TranslationRule { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -126,3 +197,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkPolicy.ps1 index 00d5b7f5f..e7b6dd86b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkPolicy.ps1 @@ -1,4 +1,73 @@ -Function Remove-JcSdkPolicy +<# +.Synopsis +This endpoint allows you to delete a policy. + +#### Sample Request + +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/policies/5a837ecd232e110d4291e6b9 \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Description +This endpoint allows you to delete a policy. + +#### Sample Request + +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/policies/5a837ecd232e110d4291e6b9 \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` +.Example +PS C:\> Remove-JcSdkPolicy -Id:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicy.md +#> + Function Remove-JcSdkPolicy { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -120,3 +189,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkPolicyGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkPolicyGroup.ps1 index ee3f872eb..4ec70154c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkPolicyGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkPolicyGroup.ps1 @@ -1,4 +1,83 @@ -Function Remove-JcSdkPolicyGroup +<# +.Synopsis +This endpoint allows you to delete a Policy Group. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint allows you to delete a Policy Group. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Remove-JcSdkPolicyGroup -Id:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +Name String +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IPolicyGroup +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicyGroup.md +#> + Function Remove-JcSdkPolicyGroup { [OutputType([JumpCloud.SDK.V2.Models.IPolicyGroup])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -120,3 +199,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkProviderAdministrator.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkProviderAdministrator.ps1 index a21c7d171..52e46758a 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkProviderAdministrator.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkProviderAdministrator.ps1 @@ -1,4 +1,57 @@ -Function Remove-JcSdkProviderAdministrator +<# +.Synopsis +This endpoint removes an Administrator associated with the Provider. +You must be associated with the provider to use this route. +.Description +This endpoint removes an Administrator associated with the Provider. +You must be associated with the provider to use this route. +.Example +PS C:\> Remove-JcSdkProviderAdministrator -Id:() -ProviderId:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkProviderAdministrator.md +#> + Function Remove-JcSdkProviderAdministrator { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -126,3 +179,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkSoftwareApp.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkSoftwareApp.ps1 index ad08251ac..836542dbd 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkSoftwareApp.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkSoftwareApp.ps1 @@ -1,4 +1,75 @@ -Function Remove-JcSdkSoftwareApp +<# +.Synopsis +Removes a Software Application configuration. + +Warning: This is a destructive operation and will unmanage the application on all affected systems. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +Removes a Software Application configuration. + +Warning: This is a destructive operation and will unmanage the application on all affected systems. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Remove-JcSdkSoftwareApp -Id:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSoftwareApp.md +#> + Function Remove-JcSdkSoftwareApp { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -120,3 +191,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkSystemGroup.ps1 index 3baeda277..17217fe5b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkSystemGroup.ps1 @@ -1,4 +1,88 @@ -Function Remove-JcSdkSystemGroup +<# +.Synopsis +This endpoint allows you to delete a System Group. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint allows you to delete a System Group. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Remove-JcSdkSystemGroup -Id:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.ISystemGroup +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSystemGroup.md +#> + Function Remove-JcSdkSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.ISystemGroup])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -120,3 +204,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkUserGroup.ps1 index 3ea81307b..c37533a2e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkUserGroup.ps1 @@ -1,4 +1,91 @@ -Function Remove-JcSdkUserGroup +<# +.Synopsis +This endpoint allows you to delete a User Group. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Description +This endpoint allows you to delete a User Group. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` +.Example +PS C:\> Remove-JcSdkUserGroup -Id:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +SuggestionCountAdd Int +SuggestionCountRemove Int +SuggestionCountTotal Int +Type String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IUserGroup +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserGroup.md +#> + Function Remove-JcSdkUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IUserGroup])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -120,3 +207,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkUserPushEndpoint.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkUserPushEndpoint.ps1 index 99b6f34c1..7dc67bb65 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkUserPushEndpoint.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkUserPushEndpoint.ps1 @@ -1,4 +1,70 @@ -Function Remove-JcSdkUserPushEndpoint +<# +.Synopsis +This endpoint will delete a push endpoint associated with a user. +.Description +This endpoint will delete a push endpoint associated with a user. +.Example +PS C:\> Remove-JcSdkUserPushEndpoint -PushEndpointId:() -UserId:() + + + +---- ---------- +DeviceAppVersion String +DeviceMake String +DeviceModel String +DeviceOS String +DeviceOSVersion String +DeviceUvEnabled Boolean +EnrollmentDate Datetime +Id String +LastUsedDate Datetime +Name String +State String + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IPushEndpointResponse +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserPushEndpoint.md +#> + Function Remove-JcSdkUserPushEndpoint { [OutputType([JumpCloud.SDK.V2.Models.IPushEndpointResponse])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -120,3 +186,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkWorkdayAuthorization.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkWorkdayAuthorization.ps1 index 1e5daf761..b8ac589ee 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkWorkdayAuthorization.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Remove-JcSdkWorkdayAuthorization.ps1 @@ -1,4 +1,71 @@ -Function Remove-JcSdkWorkdayAuthorization +<# +.Synopsis +Removes any and all authorization methods from the workday instance + +##### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Description +Removes any and all authorization methods from the workday instance + +##### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` +.Example +PS C:\> Remove-JcSdkWorkdayAuthorization -WorkdayId:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkWorkdayAuthorization.md +#> + Function Remove-JcSdkWorkdayAuthorization { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -120,3 +187,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Restart-JcSdkAppleMdmDevice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Restart-JcSdkAppleMdmDevice.ps1 index 6c7a421de..d48561791 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Restart-JcSdkAppleMdmDevice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Restart-JcSdkAppleMdmDevice.ps1 @@ -1,4 +1,78 @@ -Function Restart-JcSdkAppleMdmDevice +<# +.Synopsis +Restarts a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/restart \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{\"kextPaths\": [\"Path1\", \"Path2\"]}' +``` +.Description +Restarts a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/restart \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{\"kextPaths\": [\"Path1\", \"Path2\"]}' +``` +.Example +PS C:\> Restart-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Body:() + + +.Example +PS C:\> Restart-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -KextPaths:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.IPaths1Whnyt3ApplemdmsAppleMdmIdDevicesDeviceIdRestartPostRequestbodyContentApplicationJsonSchema +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [KextPaths >]: The string to pass when doing a restart and performing a RebuildKernelCache. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Restart-JcSdkAppleMdmDevice.md +#> + Function Restart-JcSdkAppleMdmDevice { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='RestartExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -144,3 +218,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAccessRequest.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAccessRequest.ps1 index 9305e95e9..2363be705 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAccessRequest.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAccessRequest.ps1 @@ -1,4 +1,61 @@ -Function Set-JcSdkAccessRequest +<# +.Synopsis +Endpoint that set the workflow access request by id +.Description +Endpoint that set the workflow access request by id +.Example +PS C:\> Set-JcSdkAccessRequest -Id:() -Admin:() -ApprovedDuration:() -InternalNote:() -OrganizationObjectIdInputFile:() -Remarks:() -Status:() +.Example +PS C:\> Set-JcSdkAccessRequest -Id:() -Body:() + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.IPaths17F25RsApprovalflowrequestIdPutRequestbodyContentApplicationJsonSchema +.Outputs +JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateWorkflowAccessRequestResponse +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [Admin ]: + [ApprovedDuration ]: + [InternalNote ]: + [OrganizationObjectId ]: + [Remarks ]: + [Status ]: + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequest.md +#> + Function Set-JcSdkAccessRequest { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateWorkflowAccessRequestResponse])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -165,3 +222,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAccessRequestApproval.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAccessRequestApproval.ps1 index f2d83c7eb..364fdb821 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAccessRequestApproval.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAccessRequestApproval.ps1 @@ -1,4 +1,32 @@ -Function Set-JcSdkAccessRequestApproval +<# +.Synopsis +Endpoint for user approval +.Description +Endpoint for user approval +.Example +PS C:\> Set-JcSdkAccessRequestApproval -ApprovedDuration:() -Id:() -OrganizationObjectIdInputFile:() -Remarks:() -Status:() +.Example +PS C:\> Set-JcSdkAccessRequestApproval -Body:() + +.Inputs +JumpCloud.SDK.V2.Models.IJumpcloudIngressoUserApprovalRequest +.Outputs +JumpCloud.SDK.V2.Models.IJumpcloudIngressoUserApprovalRequestResponse +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [ApprovedDuration ]: + [Id ]: + [OrganizationObjectId ]: + [Remarks ]: + [Status ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequestApproval.md +#> + Function Set-JcSdkAccessRequestApproval { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoUserApprovalRequestResponse])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -138,3 +166,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkActiveDirectoryAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkActiveDirectoryAssociation.ps1 index 517cf4348..ffc5d92a4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkActiveDirectoryAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkActiveDirectoryAssociation.ps1 @@ -1,4 +1,94 @@ -Function Set-JcSdkActiveDirectoryAssociation +<# +.Synopsis +This endpoint allows you to manage the _direct_ associations of an Active Directory instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{AD_Instance_ID}/associations \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{User_ID}\" + }' +``` +.Description +This endpoint allows you to manage the _direct_ associations of an Active Directory instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{AD_Instance_ID}/associations \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{User_ID}\" + }' +``` +.Example +PS C:\> Set-JcSdkActiveDirectoryAssociation -ActivedirectoryId:() -Body:() + + +.Example +PS C:\> Set-JcSdkActiveDirectoryAssociation -ActivedirectoryId:() -Id:() -Op:() -Type:() -Attributes:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IGraphOperationActiveDirectoryAutoGenerated +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Id : The ObjectID of graph object being added or removed as an association. + Op : How to modify the graph connection. + Type : Targets which a "active_directory" can be associated to. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkActiveDirectoryAssociation.md +#> + Function Set-JcSdkActiveDirectoryAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -159,3 +249,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAppleMdm.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAppleMdm.ps1 index 8ddeb303f..572a5dc16 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAppleMdm.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkAppleMdm.ps1 @@ -1,4 +1,209 @@ -Function Set-JcSdkAppleMdm +<# +.Synopsis +Set an Apple MDM configuration. +This endpoint is used to supply JumpCloud with a signed certificate from Apple in order to finalize the setup and allow JumpCloud to manage your devices. +It may also be used to set the DEP Settings. + +#### Sample Request +``` + curl -X PUT https://console.jumpcloud.com/api/v2/applemdms/{ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"MDM name\", + \"appleSignedCert\": \"{CERTIFICATE}\", + \"encryptedDepServerToken\": \"{SERVER_TOKEN}\", + \"dep\": { + \"welcomeScreen\": { + \"title\": \"Welcome\", + \"paragraph\": \"In just a few steps, you will be working securely from your Mac.\", + \"button\": \"continue\", + }, + }, + }' +``` +.Description +Set an Apple MDM configuration. +This endpoint is used to supply JumpCloud with a signed certificate from Apple in order to finalize the setup and allow JumpCloud to manage your devices. +It may also be used to set the DEP Settings. + +#### Sample Request +``` + curl -X PUT https://console.jumpcloud.com/api/v2/applemdms/{ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"MDM name\", + \"appleSignedCert\": \"{CERTIFICATE}\", + \"encryptedDepServerToken\": \"{SERVER_TOKEN}\", + \"dep\": { + \"welcomeScreen\": { + \"title\": \"Welcome\", + \"paragraph\": \"In just a few steps, you will be working securely from your Mac.\", + \"button\": \"continue\", + }, + }, + }' +``` +.Example +PS C:\> Set-JcSdkAppleMdm -Id:() -Body:() + + + +---- ---------- +AllowMobileUserEnrollment Boolean +ApnsCertExpiry String +ApnsPushTopic String +AppleCertCreatorAppleId String +AppleCertSerialNumber String +DefaultIosUserEnrollmentDeviceGroupId String +DefaultSystemGroupId String +DepAccessTokenExpiry String +DepEnableZeroTouchEnrollment Boolean +DepServerTokenState String +DepSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +Id String +IoDefaultDeviceGroupObjectIds String +IoEnableZeroTouchEnrollment Boolean +IoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +IoSetupOptions String +IosWelcomeScreenButton String +IosWelcomeScreenParagraph String +IosWelcomeScreenTitle String +MacoDefaultDeviceGroupObjectIds String +MacoEnableZeroTouchEnrollment Boolean +MacoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +MacoSetupOptions String +MacosWelcomeScreenButton String +MacosWelcomeScreenParagraph String +MacosWelcomeScreenTitle String +Name String +Organization String +WelcomeScreenButton String +WelcomeScreenParagraph String +WelcomeScreenTitle String + + +.Example +PS C:\> Set-JcSdkAppleMdm -Id:() -AllowMobileUserEnrollment:() -AppleCertCreatorAppleId:() -AppleSignedCert:() -DefaultIosUserEnrollmentDeviceGroupId:() -DefaultSystemGroupId:() -DepEnableZeroTouchEnrollment:() -DepSetupAssistantOptions:() -EncryptedDepServerToken:() -IoDefaultDeviceGroupObjectIds:() -IoEnableZeroTouchEnrollment:() -IoSetupAssistantOptions:() -IoSetupOptions:() -IosWelcomeScreenButton:() -IosWelcomeScreenParagraph:() -IosWelcomeScreenTitle:() -MacoDefaultDeviceGroupObjectIds:() -MacoEnableZeroTouchEnrollment:() -MacoSetupAssistantOptions:() -MacoSetupOptions:() -MacosWelcomeScreenButton:() -MacosWelcomeScreenParagraph:() -MacosWelcomeScreenTitle:() -Name:() -WelcomeScreenButton:() -WelcomeScreenParagraph:() -WelcomeScreenTitle:() + + + +---- ---------- +AllowMobileUserEnrollment Boolean +ApnsCertExpiry String +ApnsPushTopic String +AppleCertCreatorAppleId String +AppleCertSerialNumber String +DefaultIosUserEnrollmentDeviceGroupId String +DefaultSystemGroupId String +DepAccessTokenExpiry String +DepEnableZeroTouchEnrollment Boolean +DepServerTokenState String +DepSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +Id String +IoDefaultDeviceGroupObjectIds String +IoEnableZeroTouchEnrollment Boolean +IoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +IoSetupOptions String +IosWelcomeScreenButton String +IosWelcomeScreenParagraph String +IosWelcomeScreenTitle String +MacoDefaultDeviceGroupObjectIds String +MacoEnableZeroTouchEnrollment Boolean +MacoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +MacoSetupOptions String +MacosWelcomeScreenButton String +MacosWelcomeScreenParagraph String +MacosWelcomeScreenTitle String +Name String +Organization String +WelcomeScreenButton String +WelcomeScreenParagraph String +WelcomeScreenTitle String + + + +.Inputs +JumpCloud.SDK.V2.Models.IAppleMdmPatch +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IAppleMdm +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [AllowMobileUserEnrollment ]: A toggle to allow mobile device enrollment for an organization. + [AppleCertCreatorAppleId ]: The Apple ID of the admin who created the Apple signed certificate. + [AppleSignedCert ]: A signed certificate obtained from Apple after providing Apple with the plist file provided on POST. + [DefaultIosUserEnrollmentDeviceGroupId ]: ObjectId uniquely identifying the MDM default iOS user enrollment device group. + [DefaultSystemGroupId ]: ObjectId uniquely identifying the MDM default System Group. + [DepEnableZeroTouchEnrollment ]: A toggle to determine if DEP registered devices should go through JumpCloud Zero Touch Enrollment. + [DepSetupAssistantOptions >]: + [Option ]: Options to skip screens during MacOS and iOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `actionButton` - Skips the Action Button configuration pane. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `cameraButton` - Skips the Camera Button configuration pane. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `enableLockdownMode` - Skips the Lockdown Mode pane. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `intelligence` - Skips the Intelligence pane. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `termsOfAddress` - Skips the Terms of Address pane. * `tos` - Skips terms and conditions. * `appStore` - Skips the App Store pane. * `deviceToDeviceMigration` - Skips Device to Device Migration pane. * `displayZoom` - Skips zoom setup. * `homeButton` - Skips the Meet the New Home Button screen on iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus and iPhone SE. * `imessageAndFacetime` - Skips the iMessage and FaceTime screen in iOS. * `messagingActivationUsingPhoneNumber` - Skips the iMessage pane. * `moveFromAndroid` - If the Restore pane is not skipped, removes the Move from Android option in the Restore pane on iOS.O * `passcode` - Hides and disables the passcode pane. * `restoreComplete` - Skips the Restore Completed pane. * `safety` - Skips the Safety pane. * `setupCellular` - Skips the add cellular plan pane. * `softwareUpdate` - Skips the mandatory software update screen in iOS. * `unlockWithWatch` - Skips Unlock Your Mac with your Apple Watch pane. * `updateComplete` - Skips the Software Update Complete pane. * `wallpaper` - Skips the Wallpaper setup. * `watchMigration` - Skips the screen for watch migration. * `welcome` - Skips the Get Started pane. * `additionalPrivacySettings` - Skips the Additional Privacy Settings pane. * `multitasking` - Skips the Multitasking pane. * `osShowcase` - Skips the OS Showcase pane. * `webContentFiltering` - Skips the Web Content Filtering pane. * `safetyAndHandling` - Skips the Safety and Handling pane. + [EncryptedDepServerToken ]: The S/MIME encoded DEP Server Token returned by Apple Business Manager when creating an MDM instance. + [IoDefaultDeviceGroupObjectIds >]: An array of ObjectIDs identifying the default device groups for this specific type (based on the OS family) of automated device enrollment. Currently, only a single DeviceGroupID is supported. + [IoEnableZeroTouchEnrollment ]: A toggle to determine if ADE registered devices should go through JumpCloud Zero Touch Enrollment. + [IoSetupAssistantOptions >]: A Setup Option wrapped as an object + [IoSetupOptions >]: A list of configured setup options for this enrollment. + [IosWelcomeScreenButton ]: Text to display on the button on the DEP Welcome Screen. + [IosWelcomeScreenParagraph ]: A message to display on the DEP Welcome Screen. + [IosWelcomeScreenTitle ]: The title to display on the DEP Welcome Screen. + [MacoDefaultDeviceGroupObjectIds >]: An array of ObjectIDs identifying the default device groups for this specific type (based on the OS family) of automated device enrollment. Currently, only a single DeviceGroupID is supported. + [MacoEnableZeroTouchEnrollment ]: A toggle to determine if ADE registered devices should go through JumpCloud Zero Touch Enrollment. + [MacoSetupAssistantOptions >]: A Setup Option wrapped as an object + [MacoSetupOptions >]: A list of configured setup options for this enrollment. + [MacosWelcomeScreenButton ]: Text to display on the button on the DEP Welcome Screen. + [MacosWelcomeScreenParagraph ]: A message to display on the DEP Welcome Screen. + [MacosWelcomeScreenTitle ]: The title to display on the DEP Welcome Screen. + [Name ]: A new name for the Apple MDM configuration. + [WelcomeScreenButton ]: Text to display on the button on the DEP Welcome Screen. + [WelcomeScreenParagraph ]: A message to display on the DEP Welcome Screen. + [WelcomeScreenTitle ]: The title to display on the DEP Welcome Screen. + +DEPSETUPASSISTANTOPTIONS : + [Option ]: Options to skip screens during MacOS and iOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `actionButton` - Skips the Action Button configuration pane. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `cameraButton` - Skips the Camera Button configuration pane. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `enableLockdownMode` - Skips the Lockdown Mode pane. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `intelligence` - Skips the Intelligence pane. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `termsOfAddress` - Skips the Terms of Address pane. * `tos` - Skips terms and conditions. * `appStore` - Skips the App Store pane. * `deviceToDeviceMigration` - Skips Device to Device Migration pane. * `displayZoom` - Skips zoom setup. * `homeButton` - Skips the Meet the New Home Button screen on iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus and iPhone SE. * `imessageAndFacetime` - Skips the iMessage and FaceTime screen in iOS. * `messagingActivationUsingPhoneNumber` - Skips the iMessage pane. * `moveFromAndroid` - If the Restore pane is not skipped, removes the Move from Android option in the Restore pane on iOS.O * `passcode` - Hides and disables the passcode pane. * `restoreComplete` - Skips the Restore Completed pane. * `safety` - Skips the Safety pane. * `setupCellular` - Skips the add cellular plan pane. * `softwareUpdate` - Skips the mandatory software update screen in iOS. * `unlockWithWatch` - Skips Unlock Your Mac with your Apple Watch pane. * `updateComplete` - Skips the Software Update Complete pane. * `wallpaper` - Skips the Wallpaper setup. * `watchMigration` - Skips the screen for watch migration. * `welcome` - Skips the Get Started pane. * `additionalPrivacySettings` - Skips the Additional Privacy Settings pane. * `multitasking` - Skips the Multitasking pane. * `osShowcase` - Skips the OS Showcase pane. * `webContentFiltering` - Skips the Web Content Filtering pane. * `safetyAndHandling` - Skips the Safety and Handling pane. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: + +IOSETUPASSISTANTOPTIONS : + [Option ]: Options to skip screens during MacOS and iOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `actionButton` - Skips the Action Button configuration pane. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `cameraButton` - Skips the Camera Button configuration pane. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `enableLockdownMode` - Skips the Lockdown Mode pane. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `intelligence` - Skips the Intelligence pane. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `termsOfAddress` - Skips the Terms of Address pane. * `tos` - Skips terms and conditions. * `appStore` - Skips the App Store pane. * `deviceToDeviceMigration` - Skips Device to Device Migration pane. * `displayZoom` - Skips zoom setup. * `homeButton` - Skips the Meet the New Home Button screen on iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus and iPhone SE. * `imessageAndFacetime` - Skips the iMessage and FaceTime screen in iOS. * `messagingActivationUsingPhoneNumber` - Skips the iMessage pane. * `moveFromAndroid` - If the Restore pane is not skipped, removes the Move from Android option in the Restore pane on iOS.O * `passcode` - Hides and disables the passcode pane. * `restoreComplete` - Skips the Restore Completed pane. * `safety` - Skips the Safety pane. * `setupCellular` - Skips the add cellular plan pane. * `softwareUpdate` - Skips the mandatory software update screen in iOS. * `unlockWithWatch` - Skips Unlock Your Mac with your Apple Watch pane. * `updateComplete` - Skips the Software Update Complete pane. * `wallpaper` - Skips the Wallpaper setup. * `watchMigration` - Skips the screen for watch migration. * `welcome` - Skips the Get Started pane. * `additionalPrivacySettings` - Skips the Additional Privacy Settings pane. * `multitasking` - Skips the Multitasking pane. * `osShowcase` - Skips the OS Showcase pane. * `webContentFiltering` - Skips the Web Content Filtering pane. * `safetyAndHandling` - Skips the Safety and Handling pane. + +MACOSETUPASSISTANTOPTIONS : + [Option ]: Options to skip screens during MacOS and iOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `actionButton` - Skips the Action Button configuration pane. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `cameraButton` - Skips the Camera Button configuration pane. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `enableLockdownMode` - Skips the Lockdown Mode pane. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `intelligence` - Skips the Intelligence pane. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `termsOfAddress` - Skips the Terms of Address pane. * `tos` - Skips terms and conditions. * `appStore` - Skips the App Store pane. * `deviceToDeviceMigration` - Skips Device to Device Migration pane. * `displayZoom` - Skips zoom setup. * `homeButton` - Skips the Meet the New Home Button screen on iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus and iPhone SE. * `imessageAndFacetime` - Skips the iMessage and FaceTime screen in iOS. * `messagingActivationUsingPhoneNumber` - Skips the iMessage pane. * `moveFromAndroid` - If the Restore pane is not skipped, removes the Move from Android option in the Restore pane on iOS.O * `passcode` - Hides and disables the passcode pane. * `restoreComplete` - Skips the Restore Completed pane. * `safety` - Skips the Safety pane. * `setupCellular` - Skips the add cellular plan pane. * `softwareUpdate` - Skips the mandatory software update screen in iOS. * `unlockWithWatch` - Skips Unlock Your Mac with your Apple Watch pane. * `updateComplete` - Skips the Software Update Complete pane. * `wallpaper` - Skips the Wallpaper setup. * `watchMigration` - Skips the screen for watch migration. * `welcome` - Skips the Get Started pane. * `additionalPrivacySettings` - Skips the Additional Privacy Settings pane. * `multitasking` - Skips the Multitasking pane. * `osShowcase` - Skips the OS Showcase pane. * `webContentFiltering` - Skips the Web Content Filtering pane. * `safetyAndHandling` - Skips the Safety and Handling pane. +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAppleMdm.md +#> + Function Set-JcSdkAppleMdm { [OutputType([JumpCloud.SDK.V2.Models.IAppleMdm])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -314,3 +519,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApplicationAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApplicationAssociation.ps1 index b058a2830..a3adafcd3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApplicationAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApplicationAssociation.ps1 @@ -1,4 +1,92 @@ -Function Set-JcSdkApplicationAssociation +<# +.Synopsis +This endpoint allows you to manage the _direct_ associations of an Application. +A direct association can be a non-homogeneous relationship between 2 different objects, for example Application and User Groups. + +#### Sample Request +``` +curl -X POST 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations' \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user_group\", + \"id\": \"{Group_ID}\" + }' +``` +.Description +This endpoint allows you to manage the _direct_ associations of an Application. +A direct association can be a non-homogeneous relationship between 2 different objects, for example Application and User Groups. + +#### Sample Request +``` +curl -X POST 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations' \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user_group\", + \"id\": \"{Group_ID}\" + }' +``` +.Example +PS C:\> Set-JcSdkApplicationAssociation -ApplicationId:() -Body:() + + +.Example +PS C:\> Set-JcSdkApplicationAssociation -ApplicationId:() -Id:() -Op:() -Type:() -Attributes:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IGraphOperationApplicationAutoGenerated +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Id : The ObjectID of graph object being added or removed as an association. + Op : How to modify the graph connection. + Type : Targets which a "application" can be associated to. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApplicationAssociation.md +#> + Function Set-JcSdkApplicationAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -159,3 +247,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApprovalFlow.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApprovalFlow.ps1 index 9309eeea4..9a138da73 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApprovalFlow.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApprovalFlow.ps1 @@ -1,4 +1,89 @@ -Function Set-JcSdkApprovalFlow +<# +.Synopsis +Endpoint for updating a new access workflow +.Description +Endpoint for updating a new access workflow +.Example +PS C:\> Set-JcSdkApprovalFlow -ApprovalFlowId:() -ApprovalType:() -ApproverRequirement:() -ApproverResources:() -Description:() -FixedDuration:() -IconColor:() -IconUrl:() -MultiSelectDuration:() -Name:() -NonAdminApproval:() -OrganizationObjectIdInputFile:() -ResourceId:() -SlackConfig:() -SlackEnabled:() -Status:() -TimeBasedAccess:() -TtlConfig:() -VisibleTo:() +.Example +PS C:\> Set-JcSdkApprovalFlow -ApprovalFlowId:() -Body:() + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.IPaths14Hfh8UApprovalflowsApprovalflowidPutRequestbodyContentApplicationJsonSchema +.Outputs +JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowResponse +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +APPROVERRESOURCES : + [RequireAll ]: + [ResourceId ]: + [ResourceName ]: + [ResourceOrder ]: + [ResourceType ]: + +BODY : + [ApprovalType ]: + [ApproverRequirement ]: + [ApproverResources >]: + [RequireAll ]: + [ResourceId ]: + [ResourceName ]: + [ResourceOrder ]: + [ResourceType ]: + [Description ]: + [FixedDuration ]: + [IconColor ]: + [IconUrl ]: + [MultiSelectDuration >]: + [Name ]: + [NonAdminApproval ]: + [OrganizationObjectId ]: + [ResourceId ]: + [SlackConfig >]: + [SlackResourceId ]: + [SlackEnabled ]: + [Status ]: + [TimeBasedAccess ]: + [TtlConfig ]: + [VisibleTo >]: + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: + +SLACKCONFIG : + [SlackResourceId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlow.md +#> + Function Set-JcSdkApprovalFlow { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowResponse])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -253,3 +338,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApprovalFlowSetting.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApprovalFlowSetting.ps1 index 27a9670ce..a2825a8a5 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApprovalFlowSetting.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkApprovalFlowSetting.ps1 @@ -1,4 +1,40 @@ -Function Set-JcSdkApprovalFlowSetting +<# +.Synopsis +Endpoint for updating a access workflow settings for an organization +.Description +Endpoint for updating a access workflow settings for an organization +.Example +PS C:\> Set-JcSdkApprovalFlowSetting -AdminApprovalEmail:() -ChannelEvents:() -ExposeApprovalProgress:() -OrganizationObjectIdInputFile:() -ResourceRequest:() -UserApprovalEmail:() -UserRequestEmail:() +.Example +PS C:\> Set-JcSdkApprovalFlowSetting -Body:() + +.Inputs +JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowSettingsRequest +.Outputs +JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowSettingsResponse +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [AdminApprovalEmail ]: + [ChannelEvents >]: + [ChannelObjectId ]: + [EventTypes >]: + [ExposeApprovalProgress ]: + [OrganizationObjectId ]: + [ResourceRequest ]: + [UserApprovalEmail ]: + [UserRequestEmail ]: + +CHANNELEVENTS : + [ChannelObjectId ]: + [EventTypes >]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlowSetting.md +#> + Function Set-JcSdkApprovalFlowSetting { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowSettingsResponse])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -151,3 +187,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkCommandAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkCommandAssociation.ps1 index 81fd535ce..040e76b77 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkCommandAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkCommandAssociation.ps1 @@ -1,4 +1,96 @@ -Function Set-JcSdkCommandAssociation +<# +.Synopsis +This endpoint will allow you to manage the _direct_ associations of this Command. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. + + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system_group\", + \"id\": \"Group_ID\" + }' +``` +.Description +This endpoint will allow you to manage the _direct_ associations of this Command. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. + + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system_group\", + \"id\": \"Group_ID\" + }' +``` +.Example +PS C:\> Set-JcSdkCommandAssociation -CommandId:() -Body:() + + +.Example +PS C:\> Set-JcSdkCommandAssociation -CommandId:() -Id:() -Op:() -Type:() -Attributes:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IGraphOperationCommand +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Id : The ObjectID of graph object being added or removed as an association. + Op : How to modify the graph connection. + Type : Targets which a "command" can be associated to. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCommandAssociation.md +#> + Function Set-JcSdkCommandAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -159,3 +251,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkCustomEmailConfiguration.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkCustomEmailConfiguration.ps1 index 9f6540a3d..0df0d021a 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkCustomEmailConfiguration.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkCustomEmailConfiguration.ps1 @@ -1,4 +1,94 @@ -Function Set-JcSdkCustomEmailConfiguration +<# +.Synopsis +Set the custom email configuration for the specified custom email type. + +This action is only available to paying customers. +.Description +Set the custom email configuration for the specified custom email type. + +This action is only available to paying customers. +.Example +PS C:\> Set-JcSdkCustomEmailConfiguration -CustomEmailType:() -CustomEmail:() + + + +---- ---------- +Body String +Button String +Header String +Id String +NextStepContactInfo String +Subject String +Title String +Type String + + +.Example +PS C:\> Set-JcSdkCustomEmailConfiguration -CustomEmailType:() -Subject:() -Type:() -Body:() -Button:() -Header:() -NextStepContactInfo:() -Title:() + + + +---- ---------- +Body String +Button String +Header String +Id String +NextStepContactInfo String +Subject String +Title String +Type String + + + +.Inputs +JumpCloud.SDK.V2.Models.ICustomEmail +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.ICustomEmail +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +CUSTOMEMAIL : + Subject : + Type : + [Body ]: + [Button ]: + [Header ]: + [NextStepContactInfo ]: + [Title ]: + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCustomEmailConfiguration.md +#> + Function Set-JcSdkCustomEmailConfiguration { [OutputType([JumpCloud.SDK.V2.Models.ICustomEmail])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -172,3 +262,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkDuoApplication.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkDuoApplication.ps1 index 2d416aa93..7d25e1182 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkDuoApplication.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkDuoApplication.ps1 @@ -1,4 +1,107 @@ -Function Set-JcSdkDuoApplication +<# +.Synopsis +Set the specified Duo application. + +#### Sample Request +``` + curl -X PUT https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Application Name\", + \"apiHost\": \"api-1234.duosecurity.com\", + \"integrationKey\": \"1234\", + \"secretKey\": \"5678\" + }' +``` +.Description +Set the specified Duo application. + +#### Sample Request +``` + curl -X PUT https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Application Name\", + \"apiHost\": \"api-1234.duosecurity.com\", + \"integrationKey\": \"1234\", + \"secretKey\": \"5678\" + }' +``` +.Example +PS C:\> Set-JcSdkDuoApplication -AccountId:() -ApplicationId:() -Body:() + + + +---- ---------- +ApiHost String +Id String +IntegrationKey String +Name String + + +.Example +PS C:\> Set-JcSdkDuoApplication -AccountId:() -ApplicationId:() -ApiHost:() -IntegrationKey:() -Name:() -SecretKey:() + + + +---- ---------- +ApiHost String +Id String +IntegrationKey String +Name String + + + +.Inputs +JumpCloud.SDK.V2.Models.IDuoApplicationUpdateReq +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IDuoApplication +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + ApiHost : + IntegrationKey : + Name : + [SecretKey ]: + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkDuoApplication.md +#> + Function Set-JcSdkDuoApplication { [OutputType([JumpCloud.SDK.V2.Models.IDuoApplication])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -158,3 +261,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkGSuiteAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkGSuiteAssociation.ps1 index d717602d4..bf65f5e2e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkGSuiteAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkGSuiteAssociation.ps1 @@ -1,4 +1,96 @@ -Function Set-JcSdkGSuiteAssociation +<# +.Synopsis +This endpoint returns the _direct_ associations of this G Suite instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user_group\", + \"id\": \"{Group_ID}\" + }' +``` +.Description +This endpoint returns the _direct_ associations of this G Suite instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user_group\", + \"id\": \"{Group_ID}\" + }' +``` +.Example +PS C:\> Set-JcSdkGSuiteAssociation -GsuiteId:() -Body:() + + +.Example +PS C:\> Set-JcSdkGSuiteAssociation -GsuiteId:() -Id:() -Op:() -Type:() -Attributes:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IGraphOperationGSuiteAutoGenerated +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Id : The ObjectID of graph object being added or removed as an association. + Op : How to modify the graph connection. + Type : Targets which a "g_suite" can be associated to. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkGSuiteAssociation.md +#> + Function Set-JcSdkGSuiteAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -159,3 +251,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkIPList.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkIPList.ps1 index bab515f7d..f087b4b08 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkIPList.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkIPList.ps1 @@ -1,4 +1,106 @@ -Function Set-JcSdkIPList +<# +.Synopsis +Replace a specific IP list. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Sample IP List\", + \"ips\": [ + \"192.168.10.10\" + ] + }' +``` +.Description +Replace a specific IP list. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Sample IP List\", + \"ips\": [ + \"192.168.10.10\" + ] + }' +``` +.Example +PS C:\> Set-JcSdkIPList -Id:() -Body:() + + + +---- ---------- +Description String +Id String +Ips String +Name String + + +.Example +PS C:\> Set-JcSdkIPList -Id:() -Description:() -Ips:() -Name:() + + + +---- ---------- +Description String +Id String +Ips String +Name String + + + +.Inputs +JumpCloud.SDK.V2.Models.IIPListRequest +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IIPList +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [Description ]: + [Ips >]: + [Name ]: + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkIPList.md +#> + Function Set-JcSdkIPList { [OutputType([JumpCloud.SDK.V2.Models.IIPList])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -145,3 +247,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkLdapServerAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkLdapServerAssociation.ps1 index 8c77fc273..0d07d0982 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkLdapServerAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkLdapServerAssociation.ps1 @@ -1,4 +1,94 @@ -Function Set-JcSdkLdapServerAssociation +<# +.Synopsis +This endpoint allows you to manage the _direct_ associations of a LDAP Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{User_ID}\" + }' +``` +.Description +This endpoint allows you to manage the _direct_ associations of a LDAP Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{User_ID}\" + }' +``` +.Example +PS C:\> Set-JcSdkLdapServerAssociation -LdapserverId:() -Body:() + + +.Example +PS C:\> Set-JcSdkLdapServerAssociation -LdapserverId:() -Id:() -Op:() -Type:() -Attributes:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IGraphOperationLdapServerAutoGenerated +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Id : The ObjectID of graph object being added or removed as an association. + Op : How to modify the graph connection. + Type : Targets which a "ldap_server" can be associated to. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerAssociation.md +#> + Function Set-JcSdkLdapServerAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -159,3 +249,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkLdapServerSambaDomain.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkLdapServerSambaDomain.ps1 index 5c07d4786..2ce466ec2 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkLdapServerSambaDomain.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkLdapServerSambaDomain.ps1 @@ -1,4 +1,99 @@ -Function Set-JcSdkLdapServerSambaDomain +<# +.Synopsis +This endpoint allows you to set the samba domain information for an LDAP server. + +##### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"sid\":\"{SID_ID}\", + \"name\":\"{WORKGROUP_NAME}\" + }' +``` +.Description +This endpoint allows you to set the samba domain information for an LDAP server. + +##### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"sid\":\"{SID_ID}\", + \"name\":\"{WORKGROUP_NAME}\" + }' +``` +.Example +PS C:\> Set-JcSdkLdapServerSambaDomain -Id:() -LdapserverId:() -Body:() + + + +---- ---------- +Id String +Name String +Sid String + + +.Example +PS C:\> Set-JcSdkLdapServerSambaDomain -Id:() -LdapserverId:() -Name:() -Sid:() + + + +---- ---------- +Id String +Name String +Sid String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.ISambaDomain +.Outputs +JumpCloud.SDK.V2.Models.ISambaDomain +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Name : Name of this domain's WorkGroup + Sid : Security identifier of this domain + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerSambaDomain.md +#> + Function Set-JcSdkLdapServerSambaDomain { [OutputType([JumpCloud.SDK.V2.Models.ISambaDomain])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -144,3 +239,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkOffice365Association.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkOffice365Association.ps1 index 8533372f8..755ad9b37 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkOffice365Association.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkOffice365Association.ps1 @@ -1,4 +1,94 @@ -Function Set-JcSdkOffice365Association +<# +.Synopsis +This endpoint allows you to manage the _direct_ associations of a Office 365 instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user_group\", + \"id\": \"{Group_ID}\" + }' +``` +.Description +This endpoint allows you to manage the _direct_ associations of a Office 365 instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user_group\", + \"id\": \"{Group_ID}\" + }' +``` +.Example +PS C:\> Set-JcSdkOffice365Association -Office365Id:() -Body:() + + +.Example +PS C:\> Set-JcSdkOffice365Association -Office365Id:() -Id:() -Op:() -Type:() -Attributes:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IGraphOperationOffice365AutoGenerated +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Id : The ObjectID of graph object being added or removed as an association. + Op : How to modify the graph connection. + Type : Targets which a "office_365" can be associated to. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkOffice365Association.md +#> + Function Set-JcSdkOffice365Association { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -159,3 +249,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicy.ps1 index 175179e98..e0f57cffa 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicy.ps1 @@ -1,4 +1,132 @@ -Function Set-JcSdkPolicy +<# +.Synopsis +This endpoint allows you to set a policy. +Given the amount of configurable parameters required to set a Policy, we suggest you use the JumpCloud Admin Console to set new policies. + + +##### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/policies/59fced45c9118022172547ff \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Policy_Parameters} + }' +``` +.Description +This endpoint allows you to set a policy. +Given the amount of configurable parameters required to set a Policy, we suggest you use the JumpCloud Admin Console to set new policies. + + +##### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/policies/59fced45c9118022172547ff \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Policy_Parameters} + }' +``` +.Example +PS C:\> Set-JcSdkPolicy -Id:() -Body:() + + + +---- ---------- +Id String +Name String +TemplateActivation String +TemplateAlert String +TemplateBehavior String +TemplateDeliveryTypes String +TemplateDescription String +TemplateDisplayName String +TemplateId String +TemplateName String +TemplateOSMetaFamily String +TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] +TemplateReference String +TemplateState String + + +.Example +PS C:\> Set-JcSdkPolicy -Id:() -Name:() -Notes:() -Values:() + + + +---- ---------- +Id String +Name String +TemplateActivation String +TemplateAlert String +TemplateBehavior String +TemplateDeliveryTypes String +TemplateDescription String +TemplateDisplayName String +TemplateId String +TemplateName String +TemplateOSMetaFamily String +TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] +TemplateReference String +TemplateState String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.IPolicyUpdateRequest +.Outputs +JumpCloud.SDK.V2.Models.IPolicy +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Name : The description for this specific Policy. + [Notes ]: The notes for this specific Policy. + [Values >]: + [ConfigFieldId ]: The ObjectId of the corresponding Policy Template configuration field. + [Sensitive ]: Defines if the value is sensitive or not. + [Value ]: The value for the configuration field for this Policy instance. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: + +VALUES : + [ConfigFieldId ]: The ObjectId of the corresponding Policy Template configuration field. + [Sensitive ]: Defines if the value is sensitive or not. + [Value ]: The value for the configuration field for this Policy instance. +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicy.md +#> + Function Set-JcSdkPolicy { [OutputType([JumpCloud.SDK.V2.Models.IPolicy])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -145,3 +273,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyAssociation.ps1 index a17efe2c1..049dc6333 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyAssociation.ps1 @@ -1,4 +1,94 @@ -Function Set-JcSdkPolicyAssociation +<# +.Synopsis +This endpoint allows you to manage the _direct_ associations of a Policy. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations/ \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system_group\", + \"id\": \"{Group_ID}\" + }' +``` +.Description +This endpoint allows you to manage the _direct_ associations of a Policy. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations/ \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system_group\", + \"id\": \"{Group_ID}\" + }' +``` +.Example +PS C:\> Set-JcSdkPolicyAssociation -PolicyId:() -Body:() + + +.Example +PS C:\> Set-JcSdkPolicyAssociation -PolicyId:() -Id:() -Op:() -Type:() -Attributes:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IGraphOperationPolicy +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Id : The ObjectID of graph object being added or removed as an association. + Op : How to modify the graph connection. + Type : Targets which a "policy" can be associated to. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyAssociation.md +#> + Function Set-JcSdkPolicyAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -159,3 +249,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroup.ps1 index 77566cb75..87fe247ae 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroup.ps1 @@ -1,4 +1,102 @@ -Function Set-JcSdkPolicyGroup +<# +.Synopsis +This endpoint allows you to do a full set of the Policy Group. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/policygroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"group_set + }' +``` +.Description +This endpoint allows you to do a full set of the Policy Group. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/policygroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"group_set + }' +``` +.Example +PS C:\> Set-JcSdkPolicyGroup -Id:() -Body:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +Name String +Type String + + +.Example +PS C:\> Set-JcSdkPolicyGroup -Id:() -Name:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +Name String +Type String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.IPolicyGroupData +.Outputs +JumpCloud.SDK.V2.Models.IPolicyGroup +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Name : Display name of a Policy Group. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroup.md +#> + Function Set-JcSdkPolicyGroup { [OutputType([JumpCloud.SDK.V2.Models.IPolicyGroup])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -130,3 +228,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroupAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroupAssociation.ps1 index f2b81a220..35c8ec98f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroupAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroupAssociation.ps1 @@ -1,4 +1,96 @@ -Function Set-JcSdkPolicyGroupAssociation +<# +.Synopsis +This endpoint manages the _direct_ associations of this Policy Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system\", + \"id\": \"{SystemID}\" + }' +``` +.Description +This endpoint manages the _direct_ associations of this Policy Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system\", + \"id\": \"{SystemID}\" + }' +``` +.Example +PS C:\> Set-JcSdkPolicyGroupAssociation -GroupId:() -Body:() + + +.Example +PS C:\> Set-JcSdkPolicyGroupAssociation -GroupId:() -Id:() -Op:() -Type:() -Attributes:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IGraphOperationPolicyGroup +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Id : The ObjectID of graph object being added or removed as an association. + Op : How to modify the graph connection. + Type : Targets which a "policy_group" can be associated to. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupAssociation.md +#> + Function Set-JcSdkPolicyGroupAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -159,3 +251,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroupMember.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroupMember.ps1 index 57f076b11..4fec94da5 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroupMember.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkPolicyGroupMember.ps1 @@ -1,4 +1,89 @@ -Function Set-JcSdkPolicyGroupMember +<# +.Synopsis +This endpoint allows you to manage the Policy members of a Policy Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"policy\", + \"id\": \"{Policy_ID}\" + }' +``` +.Description +This endpoint allows you to manage the Policy members of a Policy Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"policy\", + \"id\": \"{Policy_ID}\" + }' +``` +.Example +PS C:\> Set-JcSdkPolicyGroupMember -GroupId:() -Body:() + + +.Example +PS C:\> Set-JcSdkPolicyGroupMember -GroupId:() -Id:() -Op:() -Attributes:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IGraphOperationPolicyGroupMember +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Id : The ObjectID of graph object being added or removed as an association. + Op : How to modify the graph connection. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupMember.md +#> + Function Set-JcSdkPolicyGroupMember { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -151,3 +236,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkRadiusServerAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkRadiusServerAssociation.ps1 index 636d500cf..4ef82432c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkRadiusServerAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkRadiusServerAssociation.ps1 @@ -1,4 +1,98 @@ -Function Set-JcSdkRadiusServerAssociation +<# +.Synopsis +This endpoint allows you to manage the _direct_ associations of a Radius Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ +\t +\"type\":\"user\", +\"id\":\"{USER_ID}\", +\"op\":\"add\" +\t +}' +``` +.Description +This endpoint allows you to manage the _direct_ associations of a Radius Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ +\t +\"type\":\"user\", +\"id\":\"{USER_ID}\", +\"op\":\"add\" +\t +}' +``` +.Example +PS C:\> Set-JcSdkRadiusServerAssociation -RadiusserverId:() -Body:() + + +.Example +PS C:\> Set-JcSdkRadiusServerAssociation -RadiusserverId:() -Id:() -Op:() -Type:() -Attributes:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IGraphOperationRadiusServerAutoGenerated +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Id : The ObjectID of graph object being added or removed as an association. + Op : How to modify the graph connection. + Type : Targets which a "radius_server" can be associated to. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkRadiusServerAssociation.md +#> + Function Set-JcSdkRadiusServerAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -159,3 +253,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSoftwareApp.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSoftwareApp.ps1 index 440564e1a..fb4fe63c7 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSoftwareApp.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSoftwareApp.ps1 @@ -1,4 +1,350 @@ -Function Set-JcSdkSoftwareApp +<# +.Synopsis +This endpoint set a specific Software Application configuration for the organization. +displayName can be changed alone if no settings are provided. +If a setting is provided, it should include all its information since this endpoint will set all the settings' fields. +The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. + +#### Sample Request - displayName only +``` + curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"displayName\": \"My Software App\" + }' +``` + +#### Sample Request - all attributes +``` + curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"displayName\": \"My Software App\", + \"settings\": [ + { + \"packageId\": \"123456\", + \"autoset : false, + \"allowUpdateDelay\": false, + \"packageManager\": \"APPLE_VPP\", + \"locationObjectId\": \"123456789012123456789012\", + \"location\": \"123456\", + \"desiredState\": \"Install\", + \"appleVpp\": { + \"appConfiguration\": \"MyKeyMy String\", + \"assignedLicenses\": 20, + \"availableLicenses\": 10, + \"details\": {}, + \"isConfigEnabled\": true, + \"supportedDeviceFamilies\": [ + \"IPAD\", + \"MAC\" + ], + \"totalLicenses\": 30 + }, + \"packageSubtitle\": \"My package subtitle\", + \"packageVersion\": \"1.2.3\", + \"packageKind\": \"software-package\", + \"assetKind\": \"software\", + \"assetSha256Size\": 256, + \"assetSha256Strings\": [ + \"a123b123c123d123\" + ], + \"description\": \"My app description\" + } + ] + }' +``` +.Description +This endpoint set a specific Software Application configuration for the organization. +displayName can be changed alone if no settings are provided. +If a setting is provided, it should include all its information since this endpoint will set all the settings' fields. +The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. + +#### Sample Request - displayName only +``` + curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"displayName\": \"My Software App\" + }' +``` + +#### Sample Request - all attributes +``` + curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"displayName\": \"My Software App\", + \"settings\": [ + { + \"packageId\": \"123456\", + \"autoset : false, + \"allowUpdateDelay\": false, + \"packageManager\": \"APPLE_VPP\", + \"locationObjectId\": \"123456789012123456789012\", + \"location\": \"123456\", + \"desiredState\": \"Install\", + \"appleVpp\": { + \"appConfiguration\": \"MyKeyMy String\", + \"assignedLicenses\": 20, + \"availableLicenses\": 10, + \"details\": {}, + \"isConfigEnabled\": true, + \"supportedDeviceFamilies\": [ + \"IPAD\", + \"MAC\" + ], + \"totalLicenses\": 30 + }, + \"packageSubtitle\": \"My package subtitle\", + \"packageVersion\": \"1.2.3\", + \"packageKind\": \"software-package\", + \"assetKind\": \"software\", + \"assetSha256Size\": 256, + \"assetSha256Strings\": [ + \"a123b123c123d123\" + ], + \"description\": \"My app description\" + } + ] + }' +``` +.Example +PS C:\> Set-JcSdkSoftwareApp -Id:() -Body:() + + + +---- ---------- +DisplayName String +Id String +Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] + + +.Example +PS C:\> Set-JcSdkSoftwareApp -Id:() -DisplayName:() -Id1:() -Settings:() + + + +---- ---------- +DisplayName String +Id String +Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.ISoftwareApp +.Outputs +JumpCloud.SDK.V2.Models.ISoftwareApp +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [CreatedAt ]: + [DisplayName ]: + [Id ]: + [Settings >]: + [AllowUpdateDelay ]: + [AppCatalogInstallableObjectId ]: ID of the app catalog installable that created this app. + [AppFileName ]: + [AppleVppAppConfiguration ]: Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'. + [AppleVppAssignedLicenses ]: + [AppleVppAvailableLicenses ]: + [AppleVppDetails ]: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. + [(Any) ]: This indicates any property can be added to this object. + [AppleVppIsConfigEnabled ]: Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''. + [AppleVppSupportedDeviceFamilies >]: The supported device families for this VPP Application. + [AppleVppTotalLicenses ]: + [Architectures >]: + [AssetKind ]: The manifest asset kind (ex: software). + [AssetSha256Size ]: The incremental size to use for summing the package as it is downloaded. + [AssetSha256Strings >]: The array of checksums, one each for the hash size up to the total size of the package. + [AutoUpdate ]: + [BundleId ]: + [CommandLineArguments ]: Command line arguments to use with the application. + [CreatedAt ]: + [Description ]: The software app description. + [DesiredState ]: State of Install or Uninstall + [DownloadUrl ]: + [EnterpriseObjectId ]: ID of the Enterprise with which this app is associated + [Format ]: + [GoogleAndroidAppPricing ]: Whether this app is free, free with in-app purchases, or paid. + [GoogleAndroidAppVersion ]: Latest version currently available for this app. + [GoogleAndroidAuthor ]: The name of the author of this app. + [GoogleAndroidAutoUpdateMode ]: Controls the auto-update mode for the app. + [GoogleAndroidCategory ]: The app category (e.g. COMMUNICATION, SOCIAL, etc.). + [GoogleAndroidContentRating ]: The content rating for this app. + [GoogleAndroidDisplayMode ]: The display mode of the web app. + [GoogleAndroidDistributionChannel ]: How and to whom the package is made available. + [GoogleAndroidFeatures >]: The array of android features for the app. + [GoogleAndroidFullDescription ]: Full app description, if available. + [GoogleAndroidIconUrl ]: A link to an image that can be used as an icon for the app. + [GoogleAndroidInstallType ]: The type of installation to perform for an app. + [GoogleAndroidManagedConfigurationTemplateId ]: The managed configurations template for the app. + [GoogleAndroidManagedProperties ]: Indicates whether this app has managed properties or not. + [GoogleAndroidMinSdkVersion ]: The minimum Android SDK necessary to run the app. + [GoogleAndroidName ]: The name of the app in the form enterprises/{enterprise}/applications/{packageName}. + [GoogleAndroidPermissionGrants >]: + [Id ]: An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR. + [Policy ]: The policy for granting the permission. + [GoogleAndroidRuntimePermission ]: The policy for granting permission requests to apps. + [GoogleAndroidStartUrl ]: The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps. + [GoogleAndroidType ]: Type of this android application. + [GoogleAndroidUpdateTime ]: The approximate time (within 7 days) the app was last published. + [GoogleAndroidVersionCode ]: The current version of the web app. + [IconUrl ]: URL to the icon for the app. + [Location ]: Repository where the app is located within the package manager + [LocationObjectId ]: ID of the repository where the app is located within the package manager + [MicrosoftStoreDoNotUpdate ]: Indicates whether the app can be updated or not. + [MicrosoftStoreNonRemovable ]: Indicates whether the app is removable by the users or not. + [MicrosoftStorePackageFamilyName ]: Package Family Name for the app from Microsoft App Store. + [ObjectId ]: + [PackageId ]: + [PackageKind ]: The package manifest kind (ex: software-package). + [PackageManager ]: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. + [PackageSubtitle ]: The package manifest subtitle. + [PackageVersion ]: The package manifest version. + [PackageVersionUpdatedAt ]: + [Scope ]: The installation scope of the software app. + [ShortVersion ]: + [StoredPackageObjectId ]: ID of the stored package this app uses to reference the stored install media. + [StoredPackageVersions >]: + [Metadata ]: Dictionary of + [(Any) ]: This indicates any property can be added to this object. + [Name ]: + [RejectedReason ]: + [Sha256Sum ]: + [Size ]: + [Status ]: + [Version ]: + [TeamId ]: + [UpdateTool ]: + [UpdateToolArguments ]: + [UpdatedAt ]: + [VersionlessDownloadUrl ]: + [UpdatedAt ]: + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: + +SETTINGS : + [AllowUpdateDelay ]: + [AppCatalogInstallableObjectId ]: ID of the app catalog installable that created this app. + [AppFileName ]: + [AppleVppAppConfiguration ]: Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'. + [AppleVppAssignedLicenses ]: + [AppleVppAvailableLicenses ]: + [AppleVppDetails ]: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. + [(Any) ]: This indicates any property can be added to this object. + [AppleVppIsConfigEnabled ]: Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''. + [AppleVppSupportedDeviceFamilies >]: The supported device families for this VPP Application. + [AppleVppTotalLicenses ]: + [Architectures >]: + [AssetKind ]: The manifest asset kind (ex: software). + [AssetSha256Size ]: The incremental size to use for summing the package as it is downloaded. + [AssetSha256Strings >]: The array of checksums, one each for the hash size up to the total size of the package. + [AutoUpdate ]: + [BundleId ]: + [CommandLineArguments ]: Command line arguments to use with the application. + [CreatedAt ]: + [Description ]: The software app description. + [DesiredState ]: State of Install or Uninstall + [DownloadUrl ]: + [EnterpriseObjectId ]: ID of the Enterprise with which this app is associated + [Format ]: + [GoogleAndroidAppPricing ]: Whether this app is free, free with in-app purchases, or paid. + [GoogleAndroidAppVersion ]: Latest version currently available for this app. + [GoogleAndroidAuthor ]: The name of the author of this app. + [GoogleAndroidAutoUpdateMode ]: Controls the auto-update mode for the app. + [GoogleAndroidCategory ]: The app category (e.g. COMMUNICATION, SOCIAL, etc.). + [GoogleAndroidContentRating ]: The content rating for this app. + [GoogleAndroidDisplayMode ]: The display mode of the web app. + [GoogleAndroidDistributionChannel ]: How and to whom the package is made available. + [GoogleAndroidFeatures >]: The array of android features for the app. + [GoogleAndroidFullDescription ]: Full app description, if available. + [GoogleAndroidIconUrl ]: A link to an image that can be used as an icon for the app. + [GoogleAndroidInstallType ]: The type of installation to perform for an app. + [GoogleAndroidManagedConfigurationTemplateId ]: The managed configurations template for the app. + [GoogleAndroidManagedProperties ]: Indicates whether this app has managed properties or not. + [GoogleAndroidMinSdkVersion ]: The minimum Android SDK necessary to run the app. + [GoogleAndroidName ]: The name of the app in the form enterprises/{enterprise}/applications/{packageName}. + [GoogleAndroidPermissionGrants >]: + [Id ]: An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR. + [Policy ]: The policy for granting the permission. + [GoogleAndroidRuntimePermission ]: The policy for granting permission requests to apps. + [GoogleAndroidStartUrl ]: The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps. + [GoogleAndroidType ]: Type of this android application. + [GoogleAndroidUpdateTime ]: The approximate time (within 7 days) the app was last published. + [GoogleAndroidVersionCode ]: The current version of the web app. + [IconUrl ]: URL to the icon for the app. + [Location ]: Repository where the app is located within the package manager + [LocationObjectId ]: ID of the repository where the app is located within the package manager + [MicrosoftStoreDoNotUpdate ]: Indicates whether the app can be updated or not. + [MicrosoftStoreNonRemovable ]: Indicates whether the app is removable by the users or not. + [MicrosoftStorePackageFamilyName ]: Package Family Name for the app from Microsoft App Store. + [ObjectId ]: + [PackageId ]: + [PackageKind ]: The package manifest kind (ex: software-package). + [PackageManager ]: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. + [PackageSubtitle ]: The package manifest subtitle. + [PackageVersion ]: The package manifest version. + [PackageVersionUpdatedAt ]: + [Scope ]: The installation scope of the software app. + [ShortVersion ]: + [StoredPackageObjectId ]: ID of the stored package this app uses to reference the stored install media. + [StoredPackageVersions >]: + [Metadata ]: Dictionary of + [(Any) ]: This indicates any property can be added to this object. + [Name ]: + [RejectedReason ]: + [Sha256Sum ]: + [Size ]: + [Status ]: + [Version ]: + [TeamId ]: + [UpdateTool ]: + [UpdateToolArguments ]: + [UpdatedAt ]: + [VersionlessDownloadUrl ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareApp.md +#> + Function Set-JcSdkSoftwareApp { [OutputType([JumpCloud.SDK.V2.Models.ISoftwareApp])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -159,3 +505,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSoftwareAppAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSoftwareAppAssociation.ps1 index f4d291c29..33014f363 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSoftwareAppAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSoftwareAppAssociation.ps1 @@ -1,4 +1,90 @@ -Function Set-JcSdkSoftwareAppAssociation +<# +.Synopsis +This endpoint allows you to associate or disassociate a software application to a system or system group. + +#### Sample Request +``` +$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '{ + \"id\": \"\", + \"op\": \"add\", + \"type\": \"system\" + }' +``` +.Description +This endpoint allows you to associate or disassociate a software application to a system or system group. + +#### Sample Request +``` +$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '{ + \"id\": \"\", + \"op\": \"add\", + \"type\": \"system\" + }' +``` +.Example +PS C:\> Set-JcSdkSoftwareAppAssociation -SoftwareAppId:() -Body:() + + +.Example +PS C:\> Set-JcSdkSoftwareAppAssociation -SoftwareAppId:() -Id:() -Op:() -Type:() -Attributes:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IGraphOperationSoftwareApp +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Id : The ObjectID of graph object being added or removed as an association. + Op : How to modify the graph connection. + Type : Targets which a "software_app" can be associated to. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareAppAssociation.md +#> + Function Set-JcSdkSoftwareAppAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -159,3 +245,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemAssociation.ps1 index 73941bc9c..d0ecb41a9 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemAssociation.ps1 @@ -1,4 +1,110 @@ -Function Set-JcSdkSystemAssociation +<# +.Synopsis +This endpoint allows you to manage the _direct_ associations of a System. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"attributes\": { + \"sudo\": { + \"enabled\": true, + \"withoutPassword\": false + } + }, + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"UserID\" + }' +``` +.Description +This endpoint allows you to manage the _direct_ associations of a System. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"attributes\": { + \"sudo\": { + \"enabled\": true, + \"withoutPassword\": false + } + }, + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"UserID\" + }' +``` +.Example +PS C:\> Set-JcSdkSystemAssociation -SystemId:() -Body:() + + +.Example +PS C:\> Set-JcSdkSystemAssociation -SystemId:() -Id:() -Op:() -Type:() -Attributes:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IGraphOperationSystem +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Id : The ObjectID of graph object being added or removed as an association. + Op : How to modify the graph connection. + Type : Targets which a "system" can be associated to. + [Attributes ]: + [(Any) ]: This indicates any property can be added to this object. + [SudoEnabled ]: Enables sudo + [SudoWithoutPassword ]: Enable sudo without password (requires 'enabled' to be true) + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemAssociation.md +#> + Function Set-JcSdkSystemAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -171,3 +277,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroup.ps1 index 7ccd9c4ec..16010e76d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroup.ps1 @@ -1,4 +1,135 @@ -Function Set-JcSdkSystemGroup +<# +.Synopsis +This endpoint allows you to do a full set of the System Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Name_set + }' +``` +.Description +This endpoint allows you to do a full set of the System Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Name_set + }' +``` +.Example +PS C:\> Set-JcSdkSystemGroup -Id:() -Body:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +Type String + + +.Example +PS C:\> Set-JcSdkSystemGroup -Id:() -Name:() -Attributes:() -Description:() -Email:() -MemberQueryExemptions:() -MemberQueryFilters:() -MemberQueryType:() -MemberSuggestionsNotify:() -MembershipMethod:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +Type String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.ISystemGroupPut +.Outputs +JumpCloud.SDK.V2.Models.ISystemGroup +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Name : Display name of a System Group. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + [Description ]: Description of a System Group + [Email ]: Email address of a System Group + [MemberQueryExemptions >]: Array of GraphObjects exempted from the query + Id : The ObjectID of the graph object. + Type : The type of graph object. + [Attributes ]: The graph attributes. + [MemberQueryFilters >]: For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. + [MemberQuerySearchFilters ]: For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. + [MemberQueryType ]: + [MemberSuggestionsNotify ]: True if notification emails are to be sent for membership suggestions. + [MembershipMethod ]: The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED. Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices). Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: + +MEMBERQUERYEXEMPTIONS : + Id : The ObjectID of the graph object. + Type : The type of graph object. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroup.md +#> + Function Set-JcSdkSystemGroup { [OutputType([JumpCloud.SDK.V2.Models.ISystemGroup])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -197,3 +328,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroupAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroupAssociation.ps1 index 65939f829..208cf2072 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroupAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroupAssociation.ps1 @@ -1,4 +1,96 @@ -Function Set-JcSdkSystemGroupAssociation +<# +.Synopsis +This endpoint allows you to manage the _direct_ associations of a System Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{UserID}\" + }' +``` +.Description +This endpoint allows you to manage the _direct_ associations of a System Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{UserID}\" + }' +``` +.Example +PS C:\> Set-JcSdkSystemGroupAssociation -GroupId:() -Body:() + + +.Example +PS C:\> Set-JcSdkSystemGroupAssociation -GroupId:() -Id:() -Op:() -Type:() -Attributes:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IGraphOperationSystemGroup +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Id : The ObjectID of graph object being added or removed as an association. + Op : How to modify the graph connection. + Type : Targets which a "system_group" can be associated to. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupAssociation.md +#> + Function Set-JcSdkSystemGroupAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -159,3 +251,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroupMember.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroupMember.ps1 index 34d459498..883be300d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroupMember.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkSystemGroupMember.ps1 @@ -1,4 +1,89 @@ -Function Set-JcSdkSystemGroupMember +<# +.Synopsis +This endpoint allows you to manage the system members of a System Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system\", + \"id\": \"{System_ID}\" + }' +``` +.Description +This endpoint allows you to manage the system members of a System Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system\", + \"id\": \"{System_ID}\" + }' +``` +.Example +PS C:\> Set-JcSdkSystemGroupMember -GroupId:() -Body:() + + +.Example +PS C:\> Set-JcSdkSystemGroupMember -GroupId:() -Id:() -Op:() -Attributes:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IGraphOperationSystemGroupMember +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Id : The ObjectID of graph object being added or removed as an association. + Op : How to modify the graph connection. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupMember.md +#> + Function Set-JcSdkSystemGroupMember { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -163,3 +248,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserAssociation.ps1 index 93b307129..e732dd6e9 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserAssociation.ps1 @@ -1,4 +1,110 @@ -Function Set-JcSdkUserAssociation +<# +.Synopsis +This endpoint allows you to manage the _direct_ associations of a User. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"attributes\": { + \"sudo\": { + \"enabled\": true, + \"withoutPassword\": false + } + }, + \"op\": \"add\", + \"type\": \"system_group\", + \"id\": \"{GroupID}\" + }' +``` +.Description +This endpoint allows you to manage the _direct_ associations of a User. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"attributes\": { + \"sudo\": { + \"enabled\": true, + \"withoutPassword\": false + } + }, + \"op\": \"add\", + \"type\": \"system_group\", + \"id\": \"{GroupID}\" + }' +``` +.Example +PS C:\> Set-JcSdkUserAssociation -UserId:() -Body:() + + +.Example +PS C:\> Set-JcSdkUserAssociation -UserId:() -Id:() -Op:() -Type:() -Attributes:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IGraphOperationUser +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Id : The ObjectID of graph object being added or removed as an association. + Op : How to modify the graph connection. + Type : Targets which a "user" can be associated to. + [Attributes ]: + [(Any) ]: This indicates any property can be added to this object. + [SudoEnabled ]: Enables sudo + [SudoWithoutPassword ]: Enable sudo without password (requires 'enabled' to be true) + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserAssociation.md +#> + Function Set-JcSdkUserAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -159,3 +265,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroup.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroup.ps1 index 6a5c61a38..77ab8252b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroup.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroup.ps1 @@ -1,4 +1,153 @@ -Function Set-JcSdkUserGroup +<# +.Synopsis +This endpoint allows you to do a full set of the User Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"group_set + }' +``` +.Description +This endpoint allows you to do a full set of the User Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"group_set + }' +``` +.Example +PS C:\> Set-JcSdkUserGroup -Id:() -Body:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +SuggestionCountAdd Int +SuggestionCountRemove Int +SuggestionCountTotal Int +Type String + + +.Example +PS C:\> Set-JcSdkUserGroup -Id:() -Name:() -Attributes:() -Description:() -Email:() -MemberQueryExemptions:() -MemberQueryFilters:() -MemberQueryType:() -MemberSuggestionsNotify:() -MembershipMethod:() + + + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +SuggestionCountAdd Int +SuggestionCountRemove Int +SuggestionCountTotal Int +Type String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.IUserGroupPut +.Outputs +JumpCloud.SDK.V2.Models.IUserGroup +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Name : Display name of a User Group. + [Attributes ]: The graph attributes for a UserGroup. + [(Any) ]: This indicates any property can be added to this object. + [SudoEnabled ]: Enables sudo + [SudoWithoutPassword ]: Enable sudo without password (requires 'enabled' to be true) + [LdapGroups >]: + [Name ]: + [PosixGroups >]: + Id : + Name : + [RadiusReply >]: + Name : + Value : + [SambaEnabled ]: + [Description ]: Description of a User Group + [Email ]: Email address of a User Group + [MemberQueryExemptions >]: Array of GraphObjects exempted from the query + Id : The ObjectID of the graph object. + Type : The type of graph object. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + [MemberQueryFilters >]: For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. + [MemberQuerySearchFilters ]: For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. + [MemberQueryType ]: + [MemberSuggestionsNotify ]: True if notification emails are to be sent for membership suggestions. + [MembershipMethod ]: The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED. Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices). Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: + +MEMBERQUERYEXEMPTIONS : + Id : The ObjectID of the graph object. + Type : The type of graph object. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroup.md +#> + Function Set-JcSdkUserGroup { [OutputType([JumpCloud.SDK.V2.Models.IUserGroup])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -197,3 +346,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroupAssociation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroupAssociation.ps1 index 511bd5c43..6a95db108 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroupAssociation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroupAssociation.ps1 @@ -1,4 +1,96 @@ -Function Set-JcSdkUserGroupAssociation +<# +.Synopsis +This endpoint manages the _direct_ associations of this User Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system\", + \"id\": \"{SystemID}\" + }' +``` +.Description +This endpoint manages the _direct_ associations of this User Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system\", + \"id\": \"{SystemID}\" + }' +``` +.Example +PS C:\> Set-JcSdkUserGroupAssociation -GroupId:() -Body:() + + +.Example +PS C:\> Set-JcSdkUserGroupAssociation -GroupId:() -Id:() -Op:() -Type:() -Attributes:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IGraphOperationUserGroup +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Id : The ObjectID of graph object being added or removed as an association. + Op : How to modify the graph connection. + Type : Targets which a "user_group" can be associated to. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupAssociation.md +#> + Function Set-JcSdkUserGroupAssociation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -159,3 +251,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroupMember.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroupMember.ps1 index 18e3ea200..9e9679f84 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroupMember.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkUserGroupMember.ps1 @@ -1,4 +1,89 @@ -Function Set-JcSdkUserGroupMember +<# +.Synopsis +This endpoint allows you to manage the user members of a User Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{User_ID}\" + }' +``` +.Description +This endpoint allows you to manage the user members of a User Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{User_ID}\" + }' +``` +.Example +PS C:\> Set-JcSdkUserGroupMember -GroupId:() -Body:() + + +.Example +PS C:\> Set-JcSdkUserGroupMember -GroupId:() -Id:() -Op:() -Attributes:() + + + +.Inputs +JumpCloud.SDK.V2.Models.IGraphOperationUserGroupMember +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + Id : The ObjectID of graph object being added or removed as an association. + Op : How to modify the graph connection. + [Attributes ]: The graph attributes. + [(Any) ]: This indicates any property can be added to this object. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupMember.md +#> + Function Set-JcSdkUserGroupMember { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -151,3 +236,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkWorkday.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkWorkday.ps1 index 497ff4c65..28935afac 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkWorkday.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Set-JcSdkWorkday.ps1 @@ -1,4 +1,117 @@ -Function Set-JcSdkWorkday +<# +.Synopsis +This endpoint allows you to set the name and Custom Report URL for a Workday Instance. + +Currently, the name can not be changed from the default of `Workday Import`. + +##### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/workdays/{WorkdayID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ +\t\"reportUrl\":\"{Report_URL}\", +\t\"name\":\"{Name}\" +}\t' +``` +.Description +This endpoint allows you to set the name and Custom Report URL for a Workday Instance. + +Currently, the name can not be changed from the default of `Workday Import`. + +##### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/workdays/{WorkdayID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ +\t\"reportUrl\":\"{Report_URL}\", +\t\"name\":\"{Name}\" +}\t' +``` +.Example +PS C:\> Set-JcSdkWorkday -Id:() -Body:() + + + +---- ---------- +BasicExpiry String +BasicIsValid Boolean +BasicMessage String +Id String +LastImport String +Name String +OauthExpiry String +OauthIsValid Boolean +OauthMessage String +ReportUrl String + + +.Example +PS C:\> Set-JcSdkWorkday -Id:() -Name:() -ReportUrl:() + + + +---- ---------- +BasicExpiry String +BasicIsValid Boolean +BasicMessage String +Id String +LastImport String +Name String +OauthExpiry String +OauthIsValid Boolean +OauthMessage String +ReportUrl String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.IWorkdayFields +.Outputs +JumpCloud.SDK.V2.Models.IWorkdayOutput +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [Name ]: + [ReportUrl ]: + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkWorkday.md +#> + Function Set-JcSdkWorkday { [OutputType([JumpCloud.SDK.V2.Models.IWorkdayOutput])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -137,3 +250,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Stop-JcSdkAppleMdmDevice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Stop-JcSdkAppleMdmDevice.ps1 index 38271e6fa..c93c1d05c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Stop-JcSdkAppleMdmDevice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Stop-JcSdkAppleMdmDevice.ps1 @@ -1,4 +1,73 @@ -Function Stop-JcSdkAppleMdmDevice +<# +.Synopsis +Shuts down a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/shutdown \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` +.Description +Shuts down a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/shutdown \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` +.Example +PS C:\> Stop-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Stop-JcSdkAppleMdmDevice.md +#> + Function Stop-JcSdkAppleMdmDevice { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Stop', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -126,3 +195,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Sync-JcSdkAppleMdmDevice.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Sync-JcSdkAppleMdmDevice.ps1 index 5fa03a80c..731e0a197 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Sync-JcSdkAppleMdmDevice.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Sync-JcSdkAppleMdmDevice.ps1 @@ -1,4 +1,73 @@ -Function Sync-JcSdkAppleMdmDevice +<# +.Synopsis +Refreshes the list of devices that a JumpCloud admin has added to their virtual MDM in Apple Business Manager - ABM so that they can be DEP enrolled with JumpCloud. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/refreshdepdevices \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` +.Description +Refreshes the list of devices that a JumpCloud admin has added to their virtual MDM in Apple Business Manager - ABM so that they can be DEP enrolled with JumpCloud. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/refreshdepdevices \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` +.Example +PS C:\> Sync-JcSdkAppleMdmDevice -AppleMdmId:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Sync-JcSdkAppleMdmDevice.md +#> + Function Sync-JcSdkAppleMdmDevice { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Sync', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -120,3 +189,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkAppleMdmDeviceLockInformation.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkAppleMdmDeviceLockInformation.ps1 index aa9c40c9f..72d96f854 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkAppleMdmDeviceLockInformation.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkAppleMdmDeviceLockInformation.ps1 @@ -1,4 +1,75 @@ -Function Update-JcSdkAppleMdmDeviceLockInformation +<# +.Synopsis +Refreshes the activation lock information for a device + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/refreshActivationLockInformation \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` +.Description +Refreshes the activation lock information for a device + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/refreshActivationLockInformation \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` +.Example +PS C:\> Update-JcSdkAppleMdmDeviceLockInformation -AppleMdmId:() -DeviceId:() + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +System.Boolean +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAppleMdmDeviceLockInformation.md +#> + Function Update-JcSdkAppleMdmDeviceLockInformation { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Refresh', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -126,3 +197,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkAuthenticationPolicy.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkAuthenticationPolicy.ps1 index 046025dab..821e90221 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkAuthenticationPolicy.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkAuthenticationPolicy.ps1 @@ -1,4 +1,160 @@ -Function Update-JcSdkAuthenticationPolicy +<# +.Synopsis +Patch the specified authentication policy. + +#### Sample Request +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ \"disabled\": false }' +``` +.Description +Patch the specified authentication policy. + +#### Sample Request +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ \"disabled\": false }' +``` +.Example +PS C:\> Update-JcSdkAuthenticationPolicy -Id:() -Body:() + + + +---- ---------- +Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions +Description String +Disabled Boolean +EffectAction String +Id String +MfaRequired Boolean +Name String +TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] +Type String +UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserGroupExclusions String +UserGroupInclusions String +UserInclusions String +UserVerificationRequirement String + + +.Example +PS C:\> Update-JcSdkAuthenticationPolicy -Id:() -Conditions:() -Description:() -Disabled:() -EffectAction:() -MfaRequired:() -Name:() -TargetResources:() -Type:() -UserAttributeExclusions:() -UserAttributeInclusions:() -UserGroupExclusions:() -UserGroupInclusions:() -UserInclusions:() -UserVerificationRequirement:() + + + +---- ---------- +Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions +Description String +Disabled Boolean +EffectAction String +Id String +MfaRequired Boolean +Name String +TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] +Type String +UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserGroupExclusions String +UserGroupInclusions String +UserInclusions String +UserVerificationRequirement String + + + +.Inputs +JumpCloud.SDK.V2.Models.IAuthnPolicy +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IAuthnPolicy +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [Conditions ]: Dictionary of + [(Any) ]: This indicates any property can be added to this object. + [CustomErrorMessage ]: The custom error message to be displayed when the policy is applied. + [CustomErrorMessageEnabled ]: Indicates whether the custom error message is enabled or not. + [Description ]: + [Disabled ]: + [EffectAction ]: + [MfaRequired ]: + [Name ]: + [ObligationMfaFactors >]: + [Type ]: + [PrimaryHelpText ]: The text to be displayed for the help link. + [PrimaryHelpUrl ]: The URL to be opened when the help link is clicked. + [SecondaryHelpText ]: The text to be displayed for the help link. + [SecondaryHelpUrl ]: The URL to be opened when the help link is clicked. + [TargetResources >]: + Type : + [Id ]: Object ID of the resource target. If undefined, then all resources of the given type are targeted. + [Type ]: AuthnPolicyType + [UserAttributeExclusions >]: + [Field ]: The only field that is currently supported is ldap_binding_user + [Operator ]: + [Value ]: Can be any value - string, number, boolean, array or object. + [UserAttributeInclusions >]: + [UserGroupExclusions >]: + [UserGroupInclusions >]: + [UserInclusions >]: + [UserVerificationRequirement ]: + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: + +OBLIGATIONMFAFACTORS : + [Type ]: + +TARGETRESOURCES : + Type : + [Id ]: Object ID of the resource target. If undefined, then all resources of the given type are targeted. + +USERATTRIBUTEEXCLUSIONS : + [Field ]: The only field that is currently supported is ldap_binding_user + [Operator ]: + [Value ]: Can be any value - string, number, boolean, array or object. + +USERATTRIBUTEINCLUSIONS : + [Field ]: The only field that is currently supported is ldap_binding_user + [Operator ]: + [Value ]: Can be any value - string, number, boolean, array or object. +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAuthenticationPolicy.md +#> + Function Update-JcSdkAuthenticationPolicy { [OutputType([JumpCloud.SDK.V2.Models.IAuthnPolicy])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -279,3 +435,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkBulkUser.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkBulkUser.ps1 index f2061eece..43deb7d0b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkBulkUser.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkBulkUser.ps1 @@ -1,4 +1,156 @@ -Function Update-JcSdkBulkUser +<# +.Synopsis +The endpoint allows you to update a bulk job to asynchronously update users. +See [update a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_put) for full list of attributes. + +#### Sample Request +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '[ +\t{ +\t \"id\":\"5be9fb4ddb01290001e85109\", +\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", +\t\t\"department\":\"{UPDATED_DEPARTMENT}\", +\t\t\"attributes\":[ +\t\t\t{\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} +\t\t] +\t}, +\t{ +\t \"id\":\"5be9fb4ddb01290001e85109\", +\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", +\t\t\"costCenter\":\"{UPDATED_COST_CENTER}\", +\t\t\"phoneNumbers\":[ +\t\t\t{\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, +\t\t\t{\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} +\t\t] +\t} +] +``` +.Description +The endpoint allows you to update a bulk job to asynchronously update users. +See [update a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_put) for full list of attributes. + +#### Sample Request +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '[ +\t{ +\t \"id\":\"5be9fb4ddb01290001e85109\", +\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", +\t\t\"department\":\"{UPDATED_DEPARTMENT}\", +\t\t\"attributes\":[ +\t\t\t{\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} +\t\t] +\t}, +\t{ +\t \"id\":\"5be9fb4ddb01290001e85109\", +\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", +\t\t\"costCenter\":\"{UPDATED_COST_CENTER}\", +\t\t\"phoneNumbers\":[ +\t\t\t{\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, +\t\t\t{\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} +\t\t] +\t} +] +``` +.Example +PS C:\> Update-JcSdkBulkUser + + +.Example +PS C:\> {{ Add code here }} + +{{ Add output here }} + +.Inputs +System.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserUpdate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] +.Outputs +JumpCloud.SDK.V2.Models.IJobIdResult +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY >: + [AccountLocked ]: + [Addresses >]: type, poBox, extendedAddress, streetAddress, locality, region, postalCode, country + [Country ]: + [ExtendedAddress ]: + [Locality ]: + [PoBox ]: + [PostalCode ]: + [Region ]: + [StreetAddress ]: + [Type ]: + [AllowPublicKey ]: + [AlternateEmail ]: + [Attributes >]: + [Name ]: + [Value ]: + [Company ]: + [CostCenter ]: + [DelegatedAuthorityId ]: ObjectId of the target Active Directory connection + [DelegatedAuthorityName ]: Authority name + [Department ]: + [Description ]: + [DisableDeviceMaxLoginAttempts ]: + [Displayname ]: + [Email ]: + [EmployeeIdentifier ]: Must be unique per user. + [EmployeeType ]: + [EnableManagedUid ]: + [EnableUserPortalMultifactor ]: + [ExternalDn ]: + [ExternalPasswordExpirationDate ]: + [ExternalSourceType ]: + [ExternallyManaged ]: + [Firstname ]: + [Id ]: Object ID of the user being updated + [JobTitle ]: + [Lastname ]: + [LdapBindingUser ]: + [Location ]: + [ManagedAppleId ]: + [Manager ]: Relation with another systemuser to identify the last as a manager. + [MfaConfigured ]: + [MfaExclusion ]: + [MfaExclusionDays ]: + [MfaExclusionUntil ]: + [Middlename ]: + [Organization ]: Organization object id of the user + [Password ]: + [PasswordNeverExpires ]: + [PasswordlessSudo ]: + [PhoneNumbers >]: + [Number ]: + [Type ]: + [PublicKey ]: + [Relationships >]: + [Type ]: + [Value ]: + [RestrictedField ]: + [RestrictedFieldId ]: + [RestrictedFieldType ]: + [SambaServiceUser ]: + [SshKeys >]: + Name : The name of the SSH key. + PublicKey : The Public SSH key. + [State ]: + [Sudo ]: + [Suspended ]: + [UnixGuid ]: + [UnixUid ]: + [Username ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkBulkUser.md +#> + Function Update-JcSdkBulkUser { [OutputType([JumpCloud.SDK.V2.Models.IJobIdResult])] [CmdletBinding(DefaultParameterSetName='Update', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -120,3 +272,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkGSuite.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkGSuite.ps1 index 0805ad972..00adeadf7 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkGSuite.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkGSuite.ps1 @@ -1,4 +1,164 @@ -Function Update-JcSdkGSuite +<# +.Synopsis +This endpoint allows updating some attributes of a G Suite. + +##### Sample Request + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"userLockoutAction\": \"suspend\", + \"userPasswordExpirationAction\": \"maintain\" + }' +``` +Sample Request, set a default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": { + \"id\": \"{domainObjectID}\" + } + }' +``` + +Sample Request, unset the default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": {} + }' +``` +.Description +This endpoint allows updating some attributes of a G Suite. + +##### Sample Request + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"userLockoutAction\": \"suspend\", + \"userPasswordExpirationAction\": \"maintain\" + }' +``` +Sample Request, set a default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": { + \"id\": \"{domainObjectID}\" + } + }' +``` + +Sample Request, unset the default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": {} + }' +``` +.Example +PS C:\> Update-JcSdkGSuite -Id:() -Body:() + + + +---- ---------- +DefaultDomainDomain String +DefaultDomainId String +GroupsEnabled Boolean +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + + +.Example +PS C:\> Update-JcSdkGSuite -Id:() -DefaultDomainId:() -GroupsEnabled:() -Name:() -UserLockoutAction:() -UserPasswordExpirationAction:() + + + +---- ---------- +DefaultDomainDomain String +DefaultDomainId String +GroupsEnabled Boolean +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + + + +.Inputs +JumpCloud.SDK.V2.Models.IGsuite +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IGsuite +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [DefaultDomainId ]: + [GroupsEnabled ]: + [ImportFilter ]: + [Name ]: + [OrganizationObjectId ]: OrganizationObjectId is the object id of the organization that the account belongs to. + [UserLockoutAction ]: + [UserPasswordExpirationAction ]: + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkGSuite.md +#> + Function Update-JcSdkGSuite { [OutputType([JumpCloud.SDK.V2.Models.IGsuite])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -172,3 +332,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkIPList.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkIPList.ps1 index f84060bce..00ac46fe5 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkIPList.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkIPList.ps1 @@ -1,4 +1,96 @@ -Function Update-JcSdkIPList +<# +.Synopsis +Update a specific IP list. + +#### Sample Request +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{\"name\": \"New IP List Name\"}' +``` +.Description +Update a specific IP list. + +#### Sample Request +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{\"name\": \"New IP List Name\"}' +``` +.Example +PS C:\> Update-JcSdkIPList -Id:() -Body:() + + + +---- ---------- +Description String +Id String +Ips String +Name String + + +.Example +PS C:\> Update-JcSdkIPList -Id:() -Description:() -Ips:() -Name:() + + + +---- ---------- +Description String +Id String +Ips String +Name String + + + +.Inputs +JumpCloud.SDK.V2.Models.IIPListRequest +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Outputs +JumpCloud.SDK.V2.Models.IIPList +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [Description ]: + [Ips >]: + [Name ]: + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkIPList.md +#> + Function Update-JcSdkIPList { [OutputType([JumpCloud.SDK.V2.Models.IIPList])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -145,3 +237,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkLdapServer.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkLdapServer.ps1 index f88c7d806..fc1db0fbf 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkLdapServer.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkLdapServer.ps1 @@ -1,4 +1,104 @@ -Function Update-JcSdkLdapServer +<# +.Synopsis +This endpoint allows updating some attributes of an LDAP server. + +Sample Request + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"userLockoutAction\": \"remove\", + \"userPasswordExpirationAction\": \"disable\" + }' +``` +.Description +This endpoint allows updating some attributes of an LDAP server. + +Sample Request + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"userLockoutAction\": \"remove\", + \"userPasswordExpirationAction\": \"disable\" + }' +``` +.Example +PS C:\> Update-JcSdkLdapServer -Id:() -Body:() + + + +---- ---------- +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + + +.Example +PS C:\> Update-JcSdkLdapServer -Id:() -Id1:() -UserLockoutAction:() -UserPasswordExpirationAction:() + + + +---- ---------- +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.IPaths1Ka5IlhLdapserversIdPatchRequestbodyContentApplicationJsonSchema +.Outputs +JumpCloud.SDK.V2.Models.IPaths1Dvt4UsLdapserversIdPatchResponses200ContentApplicationJsonSchema +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [Id ]: + [UserLockoutAction ]: LDAP Server Action + [UserPasswordExpirationAction ]: LDAP Server Action + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkLdapServer.md +#> + Function Update-JcSdkLdapServer { [OutputType([JumpCloud.SDK.V2.Models.IPaths1Dvt4UsLdapserversIdPatchResponses200ContentApplicationJsonSchema])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -144,3 +244,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkOffice365.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkOffice365.ps1 index 5d25f7849..ef72cb478 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkOffice365.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkOffice365.ps1 @@ -1,4 +1,168 @@ -Function Update-JcSdkOffice365 +<# +.Synopsis +This endpoint allows updating some attributes of an Office 365 instance. + +##### + +Sample Request + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"userLockoutAction\": \"maintain\", + \"userPasswordExpirationAction\": \"suspend\", + }' +``` + +Sample Request, set a default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": { + \"id\": \"{domainObjectID}\" + } + }' +``` + +Sample Request, unset the default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": {} + }' +``` +.Description +This endpoint allows updating some attributes of an Office 365 instance. + +##### + +Sample Request + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"userLockoutAction\": \"maintain\", + \"userPasswordExpirationAction\": \"suspend\", + }' +``` + +Sample Request, set a default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": { + \"id\": \"{domainObjectID}\" + } + }' +``` + +Sample Request, unset the default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": {} + }' +``` +.Example +PS C:\> Update-JcSdkOffice365 -Office365Id:() -Body:() + + + +---- ---------- +DefaultDomainDomain String +DefaultDomainId String +GroupsEnabled Boolean +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + + +.Example +PS C:\> Update-JcSdkOffice365 -Office365Id:() -DefaultDomainId:() -GroupsEnabled:() -Name:() -UserLockoutAction:() -UserPasswordExpirationAction:() + + + +---- ---------- +DefaultDomainDomain String +DefaultDomainId String +GroupsEnabled Boolean +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.IOffice365 +.Outputs +JumpCloud.SDK.V2.Models.IOffice365 +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [DefaultDomainId ]: + [GroupsEnabled ]: + [Name ]: + [UserLockoutAction ]: + [UserPasswordExpirationAction ]: + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkOffice365.md +#> + Function Update-JcSdkOffice365 { [OutputType([JumpCloud.SDK.V2.Models.IOffice365])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -158,3 +322,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkUserPushEndpoint.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkUserPushEndpoint.ps1 index 442b7cab8..b339b722a 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkUserPushEndpoint.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/generated/Update-JcSdkUserPushEndpoint.ps1 @@ -1,4 +1,91 @@ -Function Update-JcSdkUserPushEndpoint +<# +.Synopsis +This endpoint will update a push endpoint associated with a user. +.Description +This endpoint will update a push endpoint associated with a user. +.Example +PS C:\> Update-JcSdkUserPushEndpoint -PushEndpointId:() -UserId:() -Body:() + + + +---- ---------- +DeviceAppVersion String +DeviceMake String +DeviceModel String +DeviceOS String +DeviceOSVersion String +DeviceUvEnabled Boolean +EnrollmentDate Datetime +Id String +LastUsedDate Datetime +Name String +State String + + +.Example +PS C:\> Update-JcSdkUserPushEndpoint -PushEndpointId:() -UserId:() -Name:() -State:() + + + +---- ---------- +DeviceAppVersion String +DeviceMake String +DeviceModel String +DeviceOS String +DeviceOSVersion String +DeviceUvEnabled Boolean +EnrollmentDate Datetime +Id String +LastUsedDate Datetime +Name String +State String + + + +.Inputs +JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +.Inputs +JumpCloud.SDK.V2.Models.IPathsO4Si39UsersUserIdPushendpointsPushEndpointIdPatchRequestbodyContentApplicationJsonSchema +.Outputs +JumpCloud.SDK.V2.Models.IPushEndpointResponse +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +BODY : + [Name ]: + [State ]: + +INPUTOBJECT : + [AccountId ]: + [ActivedirectoryId ]: + [AdministratorId ]: + [AgentId ]: + [AppleMdmId ]: + [ApplicationId ]: ObjectID of the Application. + [ApprovalFlowId ]: + [CommandId ]: ObjectID of the Command. + [CustomEmailType ]: + [DeviceId ]: + [GroupId ]: ObjectID of the Policy Group. + [GsuiteId ]: ObjectID of the G Suite instance. + [Id ]: ObjectID of this Active Directory instance. + [JobId ]: + [LdapserverId ]: ObjectID of the LDAP Server. + [Office365Id ]: ObjectID of the Office 365 instance. + [PolicyId ]: ObjectID of the Policy. + [ProviderId ]: + [PushEndpointId ]: + [RadiusserverId ]: ObjectID of the Radius Server. + [SoftwareAppId ]: ObjectID of the Software App. + [SystemId ]: ObjectID of the System. + [UserId ]: ObjectID of the User. + [WorkdayId ]: +.Link +https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkUserPushEndpoint.md +#> + Function Update-JcSdkUserPushEndpoint { [OutputType([JumpCloud.SDK.V2.Models.IPushEndpointResponse])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] @@ -144,3 +231,5 @@ Return $Results } } + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMembership.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMembership.md index d419dbe60..8a20b42f5 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMembership.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMembership.md @@ -8,15 +8,7 @@ schema: 2.0.0 # Get-JcSdkPolicyGroupMembership ## SYNOPSIS -This endpoint returns all Policy members that are a member of this Policy Group. -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/membership \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## SYNTAX @@ -33,15 +25,7 @@ Get-JcSdkPolicyGroupMembership -ConsoleHost -InputObject :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -110,7 +80,7 @@ Accept wildcard characters: False ``` ### -GroupId -ObjectID of the Policy Group. + ```yaml Type: System.String @@ -125,7 +95,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -140,11 +110,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -173,7 +142,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystem.md index d5e86ed17..75e7a66c1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystem.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystem.md @@ -8,23 +8,7 @@ schema: 2.0.0 # Get-JcSdkPolicyGroupTraverseSystem ## SYNOPSIS -This endpoint will return all Systems bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Policy Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systems \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## SYNTAX @@ -41,23 +25,7 @@ Get-JcSdkPolicyGroupTraverseSystem -ConsoleHost -InputObject :\:\`. - -**field** = Populate with a valid field from an endpoint response. -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -126,7 +80,7 @@ Accept wildcard characters: False ``` ### -GroupId -ObjectID of the Policy Group. + ```yaml Type: System.String @@ -141,7 +95,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -173,7 +127,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystemGroup.md index 94fc752b6..b6f72778c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystemGroup.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystemGroup.md @@ -8,23 +8,7 @@ schema: 2.0.0 # Get-JcSdkPolicyGroupTraverseSystemGroup ## SYNOPSIS -This endpoint will return all System Groups bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Policy Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## SYNTAX @@ -41,23 +25,7 @@ Get-JcSdkPolicyGroupTraverseSystemGroup -ConsoleHost -InputObject :\:\`. - -**field** = Populate with a valid field from an endpoint response. -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -126,7 +80,7 @@ Accept wildcard characters: False ``` ### -GroupId -ObjectID of the Policy Group. + ```yaml Type: System.String @@ -141,7 +95,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -173,7 +127,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyResult.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyResult.md index 514fd097c..818b24bb4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyResult.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyResult.md @@ -8,15 +8,7 @@ schema: 2.0.0 # Get-JcSdkPolicyResult ## SYNOPSIS -This endpoint will return the policy results for a specific policy. -##### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policyresults/{Policy_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` ## SYNTAX @@ -37,15 +29,7 @@ Get-JcSdkPolicyResult -ConsoleHost -PolicyId [-Fields :\:\`. - -**field** = Populate with a valid field from an endpoint response. -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: List Aliases: @@ -148,7 +117,7 @@ Accept wildcard characters: False ``` ### -Id -ObjectID of the Policy Result. + ```yaml Type: System.String @@ -163,7 +132,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -178,7 +147,7 @@ Accept wildcard characters: False ``` ### -PolicyId -. + ```yaml Type: System.String @@ -193,11 +162,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: List Aliases: @@ -226,7 +194,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyStatus.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyStatus.md index e1d31b2ae..9ed2f14ab 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyStatus.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyStatus.md @@ -8,16 +8,7 @@ schema: 2.0.0 # Get-JcSdkPolicyStatus ## SYNOPSIS -This endpoint returns the latest policy results for a specific policy. -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` ## SYNTAX @@ -27,16 +18,7 @@ Get-JcSdkPolicyStatus -ConsoleHost -PolicyId [-Fields :\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -128,7 +95,7 @@ Accept wildcard characters: False ``` ### -PolicyId -. + ```yaml Type: System.String @@ -143,11 +110,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTemplate.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTemplate.md index 12312f556..54aee174e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTemplate.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTemplate.md @@ -8,15 +8,7 @@ schema: 2.0.0 # Get-JcSdkPolicyTemplate ## SYNOPSIS -This endpoint returns a specific policy template. -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/policytemplates/{Policy_Template_ID}\\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## SYNTAX @@ -37,15 +29,7 @@ Get-JcSdkPolicyTemplate -ConsoleHost -InputObject :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: List Aliases: @@ -150,7 +119,7 @@ Accept wildcard characters: False ``` ### -Id -ObjectID of the Policy Template. + ```yaml Type: System.String @@ -165,7 +134,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -180,11 +149,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: List Aliases: @@ -215,7 +183,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystem.md index c8d1a3616..7cae91573 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystem.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystem.md @@ -8,23 +8,7 @@ schema: 2.0.0 # Get-JcSdkPolicyTraverseSystem ## SYNOPSIS -This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## SYNTAX @@ -41,23 +25,7 @@ Get-JcSdkPolicyTraverseSystem -ConsoleHost -InputObject :\:\`. - -**field** = Populate with a valid field from an endpoint response. -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -126,7 +80,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -141,7 +95,7 @@ Accept wildcard characters: False ``` ### -PolicyId -ObjectID of the Command. + ```yaml Type: System.String @@ -173,7 +127,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystemGroup.md index ef1dbf745..1d31799d1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystemGroup.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystemGroup.md @@ -8,23 +8,7 @@ schema: 2.0.0 # Get-JcSdkPolicyTraverseSystemGroup ## SYNOPSIS -This endpoint will return all Systems Groups bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Policy to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## SYNTAX @@ -41,23 +25,7 @@ Get-JcSdkPolicyTraverseSystemGroup -ConsoleHost -InputObject :\:\`. - -**field** = Populate with a valid field from an endpoint response. -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -126,7 +80,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -141,7 +95,7 @@ Accept wildcard characters: False ``` ### -PolicyId -ObjectID of the Command. + ```yaml Type: System.String @@ -173,7 +127,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderAdministrator.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderAdministrator.md index 1911fd1b3..26c79e4cd 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderAdministrator.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderAdministrator.md @@ -8,8 +8,7 @@ schema: 2.0.0 # Get-JcSdkProviderAdministrator ## SYNOPSIS -This endpoint returns a list of the Administrators associated with the Provider. -You must be associated with the provider to use this route. + ## SYNTAX @@ -19,8 +18,7 @@ Get-JcSdkProviderAdministrator -ConsoleHost -ProviderId [-Fiel ``` ## DESCRIPTION -This endpoint returns a list of the Administrators associated with the Provider. -You must be associated with the provider to use this route. + ## EXAMPLES @@ -43,8 +41,7 @@ TotalCount Int ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -59,11 +56,10 @@ Accept wildcard characters: False ``` ### -Fields -The comma separated fields included in the returned records. -If omitted, the default list of fields will be returned. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -75,23 +71,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -103,7 +86,7 @@ Accept wildcard characters: False ``` ### -ProviderId -. + ```yaml Type: System.String @@ -118,11 +101,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -134,11 +116,10 @@ Accept wildcard characters: False ``` ### -SortIgnoreCase -The comma separated fields used to sort the collection, ignoring case. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderOrganization.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderOrganization.md index a4a9c83d2..95e021fec 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderOrganization.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderOrganization.md @@ -8,8 +8,7 @@ schema: 2.0.0 # Get-JcSdkProviderOrganization ## SYNOPSIS -This endpoint returns a list of the Organizations associated with the Provider. -You must be associated with the provider to use this route. + ## SYNTAX @@ -19,8 +18,7 @@ Get-JcSdkProviderOrganization -ConsoleHost -ProviderId [-Field ``` ## DESCRIPTION -This endpoint returns a list of the Organizations associated with the Provider. -You must be associated with the provider to use this route. + ## EXAMPLES @@ -43,8 +41,7 @@ TotalCount Int ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -59,11 +56,10 @@ Accept wildcard characters: False ``` ### -Fields -The comma separated fields included in the returned records. -If omitted, the default list of fields will be returned. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -75,23 +71,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -103,7 +86,7 @@ Accept wildcard characters: False ``` ### -ProviderId -. + ```yaml Type: System.String @@ -118,11 +101,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -134,11 +116,10 @@ Accept wildcard characters: False ``` ### -SortIgnoreCase -The comma separated fields used to sort the collection, ignoring case. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProvidersInvoice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProvidersInvoice.md index 2946674ea..1c2e2fcdd 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProvidersInvoice.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProvidersInvoice.md @@ -8,8 +8,7 @@ schema: 2.0.0 # Get-JcSdkProvidersInvoice ## SYNOPSIS -Retrieves a list of invoices for this provider. -You must be associated to the provider to use this endpoint. + ## SYNTAX @@ -26,8 +25,7 @@ Get-JcSdkProvidersInvoice -ConsoleHost -InputObject :\:\`. - -**field** = Populate with a valid field from an endpoint response. -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -94,7 +78,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -109,7 +93,7 @@ Accept wildcard characters: False ``` ### -ProviderId -. + ```yaml Type: System.String @@ -124,11 +108,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -157,7 +140,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerAssociation.md index d3300c760..33c48e2e4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerAssociation.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerAssociation.md @@ -8,17 +8,7 @@ schema: 2.0.0 # Get-JcSdkRadiusServerAssociation ## SYNOPSIS -This endpoint returns the _direct_ associations of a Radius Server. -A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations?targets=user_group \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## SYNTAX @@ -35,17 +25,7 @@ Get-JcSdkRadiusServerAssociation -ConsoleHost -InputObject `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUser.md index 49d6f526a..fb5f7f774 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUser.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUser.md @@ -8,24 +8,7 @@ schema: 2.0.0 # Get-JcSdkRadiusServerTraverseUser ## SYNOPSIS -This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. - -See `/members` and `/associations` endpoints to manage those collections. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` ## SYNTAX @@ -42,25 +25,8 @@ Get-JcSdkRadiusServerTraverseUser -ConsoleHost -InputObject :\:\`. - -**field** = Populate with a valid field from an endpoint response. -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -128,7 +80,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -143,7 +95,7 @@ Accept wildcard characters: False ``` ### -RadiusserverId -ObjectID of the Radius Server. + ```yaml Type: System.String @@ -175,7 +127,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUserGroup.md index 96bca9495..fb8a15be9 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUserGroup.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUserGroup.md @@ -8,23 +8,7 @@ schema: 2.0.0 # Get-JcSdkRadiusServerTraverseUserGroup ## SYNOPSIS -This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## SYNTAX @@ -41,23 +25,7 @@ Get-JcSdkRadiusServerTraverseUserGroup -ConsoleHost -InputObject :\:\`. - -**field** = Populate with a valid field from an endpoint response. -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -126,7 +80,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -141,7 +95,7 @@ Accept wildcard characters: False ``` ### -RadiusserverId -ObjectID of the Radius Server. + ```yaml Type: System.String @@ -173,7 +127,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareApp.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareApp.md index 1528e36ad..1fd23a98c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareApp.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareApp.md @@ -8,16 +8,7 @@ schema: 2.0.0 # Get-JcSdkSoftwareApp ## SYNOPSIS -Retrieves a Software Application. -The optional isConfigEnabled and appConfiguration apple_vpp attributes are populated in this response. -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## SYNTAX @@ -38,16 +29,7 @@ Get-JcSdkSoftwareApp -ConsoleHost -InputObject ``` ## DESCRIPTION -Retrieves a Software Application. -The optional isConfigEnabled and appConfiguration apple_vpp attributes are populated in this response. -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## EXAMPLES @@ -74,8 +56,7 @@ Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -90,23 +71,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: List Aliases: @@ -118,7 +86,7 @@ Accept wildcard characters: False ``` ### -Id -. + ```yaml Type: System.String @@ -133,7 +101,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -148,11 +116,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: List Aliases: @@ -181,7 +148,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppAssociation.md index f670194ec..dfd071c3e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppAssociation.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppAssociation.md @@ -8,18 +8,8 @@ schema: 2.0.0 # Get-JcSdkSoftwareAppAssociation ## SYNOPSIS -This endpoint will return the _direct_ associations of a Software Application. -A direct association can be a non-homogeneous relationship between 2 different objects, for example Software Application and System Groups. -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations?targets=system_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - ## SYNTAX ### Get (Default) @@ -35,18 +25,8 @@ Get-JcSdkSoftwareAppAssociation -ConsoleHost -InputObject `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppStatus.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppStatus.md index c51723f0e..98ab974ed 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppStatus.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppStatus.md @@ -8,15 +8,7 @@ schema: 2.0.0 # Get-JcSdkSoftwareAppStatus ## SYNOPSIS -This endpoint allows you to get the status of the provided Software Application on associated JumpCloud systems. -#### Sample Request -``` -$ curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/statuses \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ -``` ## SYNTAX @@ -33,15 +25,7 @@ Get-JcSdkSoftwareAppStatus -ConsoleHost -InputObject :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -114,7 +84,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -129,7 +99,7 @@ Accept wildcard characters: False ``` ### -SoftwareAppId -ObjectID of the Software App. + ```yaml Type: System.String @@ -144,11 +114,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -177,7 +146,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystem.md index e3aaa0abb..f6d14f4eb 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystem.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystem.md @@ -8,23 +8,7 @@ schema: 2.0.0 # Get-JcSdkSoftwareAppTraverseSystem ## SYNOPSIS -This endpoint will return all Systems bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Software App to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Software App. - -See `/associations` endpoint to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systems \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## SYNTAX @@ -41,23 +25,7 @@ Get-JcSdkSoftwareAppTraverseSystem -ConsoleHost -InputObject :\:\`. - -**field** = Populate with a valid field from an endpoint response. -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -126,7 +80,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -141,7 +95,7 @@ Accept wildcard characters: False ``` ### -SoftwareAppId -ObjectID of the Software App. + ```yaml Type: System.String @@ -173,7 +127,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystemGroup.md index 3844f53fe..a61c7dda2 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystemGroup.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystemGroup.md @@ -8,23 +8,7 @@ schema: 2.0.0 # Get-JcSdkSoftwareAppTraverseSystemGroup ## SYNOPSIS -This endpoint will return all Systems Groups bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Software App to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Software App. - -See `/associations` endpoint to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## SYNTAX @@ -41,23 +25,7 @@ Get-JcSdkSoftwareAppTraverseSystemGroup -ConsoleHost -InputObject :\:\`. - -**field** = Populate with a valid field from an endpoint response. -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -126,7 +80,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -141,7 +95,7 @@ Accept wildcard characters: False ``` ### -SoftwareAppId -ObjectID of the Software App. + ```yaml Type: System.String @@ -173,7 +127,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSubscription.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSubscription.md index 22b176bcf..b5cf2fd47 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSubscription.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSubscription.md @@ -8,16 +8,7 @@ schema: 2.0.0 # Get-JcSdkSubscription ## SYNOPSIS -This endpoint returns all pricing & packaging subscriptions. -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/subscriptions \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` ## SYNTAX @@ -26,16 +17,7 @@ Get-JcSdkSubscription -ConsoleHost [] ``` ## DESCRIPTION -This endpoint returns all pricing & packaging subscriptions. -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/subscriptions \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` ## EXAMPLES @@ -62,8 +44,7 @@ UpgradeRecommendation String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemAssociation.md index 55aa2e4e1..83e2d7aae 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemAssociation.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemAssociation.md @@ -8,19 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemAssociation ## SYNOPSIS -This endpoint returns the _direct_ associations of a System. -A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations?targets=user \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` ## SYNTAX @@ -37,19 +25,7 @@ Get-JcSdkSystemAssociation -ConsoleHost -InputObject `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemFdeKey.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemFdeKey.md index 87c6d84f1..2a70597d3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemFdeKey.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemFdeKey.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemFdeKey ## SYNOPSIS -This endpoint will return the current (latest) fde key saved for a system. + ## SYNTAX @@ -23,7 +23,7 @@ Get-JcSdkSystemFdeKey -ConsoleHost -InputObject ``` ## DESCRIPTION -This endpoint will return the current (latest) fde key saved for a system. + ## EXAMPLES @@ -44,8 +44,7 @@ Get-JcSdkSystemFdeKey -SystemId:() ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -60,7 +59,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -75,7 +74,7 @@ Accept wildcard characters: False ``` ### -SystemId -. + ```yaml Type: System.String @@ -107,7 +106,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroup.md index f777bd22c..f0d392384 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroup.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroup.md @@ -8,15 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemGroup ## SYNOPSIS -This endpoint returns the details of a System Group. -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## SYNTAX @@ -37,15 +29,7 @@ Get-JcSdkSystemGroup -ConsoleHost -InputObject ``` ## DESCRIPTION -This endpoint returns the details of a System Group. -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## EXAMPLES @@ -88,8 +72,7 @@ Type String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -104,11 +87,10 @@ Accept wildcard characters: False ``` ### -Fields -The comma separated fields included in the returned records. -If omitted, the default list of fields will be returned. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: List Aliases: @@ -120,23 +102,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: List Aliases: @@ -148,7 +117,7 @@ Accept wildcard characters: False ``` ### -Id -ObjectID of the System Group. + ```yaml Type: System.String @@ -163,7 +132,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -178,11 +147,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: List Aliases: @@ -211,7 +179,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupAssociation.md index 7e9d843f1..3571704e8 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupAssociation.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupAssociation.md @@ -8,18 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemGroupAssociation ## SYNOPSIS -This endpoint returns the _direct_ associations of a System Group. -A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations?targets=user \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## SYNTAX @@ -35,18 +24,7 @@ Get-JcSdkSystemGroupAssociation -ConsoleHost -InputObject `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMember.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMember.md index 4ebd45950..503c757e7 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMember.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMember.md @@ -8,16 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemGroupMember ## SYNOPSIS -This endpoint returns the system members of a System Group. -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` ## SYNTAX @@ -32,16 +23,7 @@ Get-JcSdkSystemGroupMember -ConsoleHost -InputObject `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMembership.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMembership.md index a9ccd2ea2..edbb964dd 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMembership.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMembership.md @@ -8,16 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemGroupMembership ## SYNOPSIS -This endpoint returns all Systems that are a member of this System Group. -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID/membership \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` ## SYNTAX @@ -34,16 +25,7 @@ Get-JcSdkSystemGroupMembership -ConsoleHost -InputObject :\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -112,7 +80,7 @@ Accept wildcard characters: False ``` ### -GroupId -ObjectID of the System Group. + ```yaml Type: System.String @@ -127,7 +95,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -142,11 +110,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -175,7 +142,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseCommand.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseCommand.md index 58f54c35a..37afe7b1c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseCommand.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseCommand.md @@ -8,23 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemGroupTraverseCommand ## SYNOPSIS -This endpoint will return all Commands bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/commands \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## SYNTAX @@ -41,23 +25,7 @@ Get-JcSdkSystemGroupTraverseCommand -ConsoleHost -InputObject :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -150,7 +104,7 @@ Accept wildcard characters: False ``` ### -GroupId -ObjectID of the System Group. + ```yaml Type: System.String @@ -165,7 +119,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -197,7 +151,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicy.md index 121b2349e..279c15bd3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicy.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicy.md @@ -8,25 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemGroupTraversePolicy ## SYNOPSIS -This endpoint will return all Policies bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -This endpoint is not public yet as we haven't finished the code. - -##### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policies \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## SYNTAX @@ -43,25 +25,7 @@ Get-JcSdkSystemGroupTraversePolicy -ConsoleHost -InputObject :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -130,7 +80,7 @@ Accept wildcard characters: False ``` ### -GroupId -ObjectID of the System Group. + ```yaml Type: System.String @@ -145,7 +95,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -177,7 +127,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicyGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicyGroup.md index 4a3497df3..912d40242 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicyGroup.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicyGroup.md @@ -8,24 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemGroupTraversePolicyGroup ## SYNOPSIS -This endpoint will return all Policy Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policygroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` ## SYNTAX @@ -42,24 +25,7 @@ Get-JcSdkSystemGroupTraversePolicyGroup -ConsoleHost -InputObject :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -128,7 +80,7 @@ Accept wildcard characters: False ``` ### -GroupId -ObjectID of the System Group. + ```yaml Type: System.String @@ -143,7 +95,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -175,7 +127,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUser.md index b090ff5b3..a9c44e54c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUser.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUser.md @@ -8,23 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemGroupTraverseUser ## SYNOPSIS -This endpoint will return all Users bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` ## SYNTAX @@ -41,23 +25,7 @@ Get-JcSdkSystemGroupTraverseUser -ConsoleHost -InputObject :\:\`. - -**field** = Populate with a valid field from an endpoint response. -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -126,7 +80,7 @@ Accept wildcard characters: False ``` ### -GroupId -ObjectID of the System Group. + ```yaml Type: System.String @@ -141,7 +95,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -173,7 +127,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUserGroup.md index fea80a971..bfa383022 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUserGroup.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUserGroup.md @@ -8,24 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemGroupTraverseUserGroup ## SYNOPSIS -This endpoint will return all User Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` ## SYNTAX @@ -42,24 +25,7 @@ Get-JcSdkSystemGroupTraverseUserGroup -ConsoleHost -InputObject :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -128,7 +80,7 @@ Accept wildcard characters: False ``` ### -GroupId -ObjectID of the System Group. + ```yaml Type: System.String @@ -143,7 +95,7 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter + ```yaml Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity @@ -175,7 +127,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -`INPUTOBJECT `: Identity Parameter +`INPUTOBJECT `: - `[AccountId ]`: - `[ActivedirectoryId ]`: - `[AdministratorId ]`: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlf.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlf.md index c77505314..1a8d0228b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlf.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlf.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightAlf ## SYNOPSIS -Valid filter fields are `system_id` and `global_state`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightAlf -ConsoleHost [-Filter >] [-Sort ``` ## DESCRIPTION -Valid filter fields are `system_id` and `global_state`. + ## EXAMPLES @@ -48,8 +48,7 @@ Version String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -64,23 +63,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -92,11 +78,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfException.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfException.md index 753c95a9e..3c331326c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfException.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfException.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightAlfException ## SYNOPSIS -Valid filter fields are `system_id` and `state`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightAlfException -ConsoleHost [-Filter > ``` ## DESCRIPTION -Valid filter fields are `system_id` and `state`. + ## EXAMPLES @@ -43,8 +43,7 @@ SystemId String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -59,23 +58,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -87,11 +73,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfExplicitAuth.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfExplicitAuth.md index 46bbd89be..c38072d01 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfExplicitAuth.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfExplicitAuth.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightAlfExplicitAuth ## SYNOPSIS -Valid filter fields are `system_id` and `process`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightAlfExplicitAuth -ConsoleHost [-Filter :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -86,11 +72,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightApp.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightApp.md index 778f15374..49ba1ce65 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightApp.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightApp.md @@ -8,10 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightApp ## SYNOPSIS -Lists all apps for macOS devices. -For Windows devices, use [List System Insights Programs](#operation/systeminsights_list_programs). -Valid filter fields are `system_id` and `bundle_name`. ## SYNTAX @@ -21,10 +18,7 @@ Get-JcSdkSystemInsightApp -ConsoleHost [-Filter >] [-Sort ``` ## DESCRIPTION -Lists all apps for macOS devices. -For Windows devices, use [List System Insights Programs](#operation/systeminsights_list_programs). -Valid filter fields are `system_id` and `bundle_name`. ## EXAMPLES @@ -66,8 +60,7 @@ SystemId String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -82,23 +75,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -110,11 +90,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAppCompatShim.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAppCompatShim.md index cb15494a0..e3fb68602 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAppCompatShim.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAppCompatShim.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightAppCompatShim ## SYNOPSIS -Valid filter fields are `system_id` and `enabled`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightAppCompatShim -ConsoleHost [-Filter ``` ## DESCRIPTION -Valid filter fields are `system_id` and `enabled`. + ## EXAMPLES @@ -47,8 +47,7 @@ Type String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -63,23 +62,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -91,11 +77,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAuthorizedKey.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAuthorizedKey.md index 886d564b7..b1e59f780 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAuthorizedKey.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAuthorizedKey.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightAuthorizedKey ## SYNOPSIS -Valid filter fields are `system_id` and `uid`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightAuthorizedKey -ConsoleHost [-Filter ``` ## DESCRIPTION -Valid filter fields are `system_id` and `uid`. + ## EXAMPLES @@ -45,8 +45,7 @@ Uid String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -61,23 +60,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -89,11 +75,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceMetadata.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceMetadata.md index 2221a48aa..80092cf4d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceMetadata.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceMetadata.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightAzureInstanceMetadata ## SYNOPSIS -Valid filter fields are `system_id`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightAzureInstanceMetadata -ConsoleHost [-Filter :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -101,11 +87,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceTag.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceTag.md index 1b5b3a671..411415e16 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceTag.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceTag.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightAzureInstanceTag ## SYNOPSIS -Valid filter fields are `system_id`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightAzureInstanceTag -ConsoleHost [-Filter :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -88,11 +74,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBattery.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBattery.md index e46086e64..e342f683e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBattery.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBattery.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightBattery ## SYNOPSIS -Valid filter fields are `system_id` and `health`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightBattery -ConsoleHost [-Filter >] [-S ``` ## DESCRIPTION -Valid filter fields are `system_id` and `health`. + ## EXAMPLES @@ -59,8 +59,7 @@ Voltage Int ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -75,23 +74,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -103,11 +89,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBitlockerInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBitlockerInfo.md index b7a3e9573..1b9c849ad 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBitlockerInfo.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBitlockerInfo.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightBitlockerInfo ## SYNOPSIS -Valid filter fields are `system_id` and `protection_status`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightBitlockerInfo -ConsoleHost [-Filter ``` ## DESCRIPTION -Valid filter fields are `system_id` and `protection_status`. + ## EXAMPLES @@ -47,8 +47,7 @@ SystemId String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -63,23 +62,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -91,11 +77,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBrowserPlugin.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBrowserPlugin.md index 83b0b091a..aac22cbd9 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBrowserPlugin.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBrowserPlugin.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightBrowserPlugin ## SYNOPSIS -Valid filter fields are `system_id` and `name`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightBrowserPlugin -ConsoleHost [-Filter ``` ## DESCRIPTION -Valid filter fields are `system_id` and `name`. + ## EXAMPLES @@ -51,8 +51,7 @@ Version String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -67,23 +66,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -95,11 +81,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCertificate.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCertificate.md index 0298cb3f0..d98e0cf5d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCertificate.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCertificate.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightCertificate ## SYNOPSIS -Valid filter fields are `system_id` and `common_name`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightCertificate -ConsoleHost [-Filter >] ``` ## DESCRIPTION -Valid filter fields are `system_id` and `common_name`. + ## EXAMPLES @@ -61,8 +61,7 @@ Username String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -77,23 +76,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -105,11 +91,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChassisInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChassisInfo.md index e7a8e3ae5..c8a31c072 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChassisInfo.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChassisInfo.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightChassisInfo ## SYNOPSIS -Valid filter fields are `system_id`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightChassisInfo -ConsoleHost [-Filter >] ``` ## DESCRIPTION -Valid filter fields are `system_id`. + ## EXAMPLES @@ -54,8 +54,7 @@ VisibleAlarm String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -70,23 +69,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -98,11 +84,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChromeExtension.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChromeExtension.md index 9748f4703..66e567577 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChromeExtension.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChromeExtension.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightChromeExtension ## SYNOPSIS -Valid filter fields are `system_id` and `name`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightChromeExtension -ConsoleHost [-Filter :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -96,11 +82,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightConnectivity.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightConnectivity.md index 278be22f8..84dbdb4cd 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightConnectivity.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightConnectivity.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightConnectivity ## SYNOPSIS -The only valid filter field is `system_id`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightConnectivity -ConsoleHost [-Filter > ``` ## DESCRIPTION -The only valid filter field is `system_id`. + ## EXAMPLES @@ -50,8 +50,7 @@ SystemId String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -66,23 +65,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -94,11 +80,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCrash.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCrash.md index 6acfda816..357b475c2 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCrash.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCrash.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightCrash ## SYNOPSIS -Valid filter fields are `system_id` and `identifier`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightCrash -ConsoleHost [-Filter >] [-Sor ``` ## DESCRIPTION -Valid filter fields are `system_id` and `identifier`. + ## EXAMPLES @@ -57,8 +57,7 @@ Version String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -73,23 +72,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -101,11 +87,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCupDestination.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCupDestination.md index 3b32d1232..6e871eaa1 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCupDestination.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCupDestination.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightCupDestination ## SYNOPSIS -Valid filter fields are `system_id` and `name`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightCupDestination -ConsoleHost [-Filter :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -87,11 +73,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskEncryption.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskEncryption.md index debc892ab..db2662ba3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskEncryption.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskEncryption.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightDiskEncryption ## SYNOPSIS -Valid filter fields are `system_id` and `encryption_status`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightDiskEncryption -ConsoleHost [-Filter :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -92,11 +78,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskInfo.md index ed25d306b..2f70b499c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskInfo.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskInfo.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightDiskInfo ## SYNOPSIS -Valid filter fields are `system_id` and `disk_index`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightDiskInfo -ConsoleHost [-Filter >] [- ``` ## DESCRIPTION -Valid filter fields are `system_id` and `disk_index`. + ## EXAMPLES @@ -52,8 +52,7 @@ Type String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -68,23 +67,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -96,11 +82,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDnsResolver.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDnsResolver.md index f2045beb9..a83088a64 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDnsResolver.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDnsResolver.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightDnsResolver ## SYNOPSIS -Valid filter fields are `system_id` and `type`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightDnsResolver -ConsoleHost [-Filter >] ``` ## DESCRIPTION -Valid filter fields are `system_id` and `type`. + ## EXAMPLES @@ -46,8 +46,7 @@ Type String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -62,23 +61,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -90,11 +76,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightEtcHost.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightEtcHost.md index 4635d4fac..95f3ad80e 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightEtcHost.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightEtcHost.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightEtcHost ## SYNOPSIS -Valid filter fields are `system_id` and `address`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightEtcHost -ConsoleHost [-Filter >] [-S ``` ## DESCRIPTION -Valid filter fields are `system_id` and `address`. + ## EXAMPLES @@ -43,8 +43,7 @@ SystemId String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -59,23 +58,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -87,11 +73,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightFirefoxAddon.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightFirefoxAddon.md index 8497bb514..c58d26e5c 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightFirefoxAddon.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightFirefoxAddon.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightFirefoxAddon ## SYNOPSIS -Valid filter fields are `system_id` and `name`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightFirefoxAddon -ConsoleHost [-Filter > ``` ## DESCRIPTION -Valid filter fields are `system_id` and `name`. + ## EXAMPLES @@ -55,8 +55,7 @@ Visible Int ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -71,23 +70,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -99,11 +85,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightGroup.md index 928bb64d6..f0f6c732f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightGroup.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightGroup.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightGroup ## SYNOPSIS -Valid filter fields are `system_id` and `groupname`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightGroup -ConsoleHost [-Filter >] [-Sor ``` ## DESCRIPTION -Valid filter fields are `system_id` and `groupname`. + ## EXAMPLES @@ -46,8 +46,7 @@ SystemId String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -62,23 +61,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -90,11 +76,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightIeExtension.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightIeExtension.md index 551cf48d4..985ac59c7 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightIeExtension.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightIeExtension.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightIeExtension ## SYNOPSIS -Valid filter fields are `system_id` and `name`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightIeExtension -ConsoleHost [-Filter >] ``` ## DESCRIPTION -Valid filter fields are `system_id` and `name`. + ## EXAMPLES @@ -45,8 +45,7 @@ Version String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -61,23 +60,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -89,11 +75,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceAddress.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceAddress.md index b396eb411..e62008d25 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceAddress.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceAddress.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightInterfaceAddress ## SYNOPSIS -Valid filter fields are `system_id` and `address`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightInterfaceAddress -ConsoleHost [-Filter :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -92,11 +78,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceDetail.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceDetail.md index a97db0197..ce0c0daa7 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceDetail.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceDetail.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightInterfaceDetail ## SYNOPSIS -Valid filter fields are `system_id` and `interface`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightInterfaceDetail -ConsoleHost [-Filter :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -119,11 +105,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightKernelInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightKernelInfo.md index 2e29cbdbd..8a04534bc 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightKernelInfo.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightKernelInfo.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightKernelInfo ## SYNOPSIS -Valid filter fields are `system_id` and `version`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightKernelInfo -ConsoleHost [-Filter >] ``` ## DESCRIPTION -Valid filter fields are `system_id` and `version`. + ## EXAMPLES @@ -45,8 +45,7 @@ Version String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -61,23 +60,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -89,11 +75,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLaunchd.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLaunchd.md index 48c1ca428..072754225 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLaunchd.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLaunchd.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightLaunchd ## SYNOPSIS -Valid filter fields are `system_id` and `name`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightLaunchd -ConsoleHost [-Filter >] [-S ``` ## DESCRIPTION -Valid filter fields are `system_id` and `name`. + ## EXAMPLES @@ -62,8 +62,7 @@ WorkingDirectory String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -78,23 +77,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -106,11 +92,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLinuxPackage.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLinuxPackage.md index 0c3835ba9..69964534d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLinuxPackage.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLinuxPackage.md @@ -8,11 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightLinuxPackage ## SYNOPSIS -Lists all programs for Linux devices. -For macOS devices, use [List System Insights System Apps](#operation/systeminsights_list_apps). -For windows devices, use [List System Insights System Apps](#operation/systeminsights_list_programs). -Valid filter fields are `name` and `package_format`. ## SYNTAX @@ -22,11 +18,7 @@ Get-JcSdkSystemInsightLinuxPackage -ConsoleHost [-Filter > ``` ## DESCRIPTION -Lists all programs for Linux devices. -For macOS devices, use [List System Insights System Apps](#operation/systeminsights_list_apps). -For windows devices, use [List System Insights System Apps](#operation/systeminsights_list_programs). -Valid filter fields are `name` and `package_format`. ## EXAMPLES @@ -59,8 +51,7 @@ Version String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -75,23 +66,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -103,11 +81,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLoggedinUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLoggedinUser.md index 1a8ff3ac1..fff488212 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLoggedinUser.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLoggedinUser.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightLoggedinUser ## SYNOPSIS -Valid filter fields are `system_id` and `user`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightLoggedinUser -ConsoleHost [-Filter > ``` ## DESCRIPTION -Valid filter fields are `system_id` and `user`. + ## EXAMPLES @@ -47,8 +47,7 @@ User String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -63,23 +62,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -91,11 +77,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLogicalDrive.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLogicalDrive.md index 5da60c80a..f2fd876d3 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLogicalDrive.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLogicalDrive.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightLogicalDrive ## SYNOPSIS -Valid filter fields are `system_id` and `device_id`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightLogicalDrive -ConsoleHost [-Filter > ``` ## DESCRIPTION -Valid filter fields are `system_id` and `device_id`. + ## EXAMPLES @@ -47,8 +47,7 @@ Type String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -63,23 +62,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -91,11 +77,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightManagedPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightManagedPolicy.md index dafab18cb..048d9698d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightManagedPolicy.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightManagedPolicy.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightManagedPolicy ## SYNOPSIS -Valid filter fields are `system_id` and `domain`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightManagedPolicy -ConsoleHost [-Filter ``` ## DESCRIPTION -Valid filter fields are `system_id` and `domain`. + ## EXAMPLES @@ -47,8 +47,7 @@ Value String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -63,23 +62,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -91,11 +77,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightMount.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightMount.md index 3720450b1..cc4cab665 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightMount.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightMount.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightMount ## SYNOPSIS -Valid filter fields are `system_id` and `path`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightMount -ConsoleHost [-Filter >] [-Sor ``` ## DESCRIPTION -Valid filter fields are `system_id` and `path`. + ## EXAMPLES @@ -52,8 +52,7 @@ Type String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -68,23 +67,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -96,11 +82,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightOSVersion.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightOSVersion.md index 6b27897a8..75b97b5e0 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightOSVersion.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightOSVersion.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightOSVersion ## SYNOPSIS -Valid filter fields are `system_id` and `version`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightOSVersion -ConsoleHost [-Filter >] [ ``` ## DESCRIPTION -Valid filter fields are `system_id` and `version`. + ## EXAMPLES @@ -51,8 +51,7 @@ Version String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -67,23 +66,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -95,11 +81,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPatch.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPatch.md index 66b2809c9..2f68d87b9 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPatch.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPatch.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightPatch ## SYNOPSIS -Valid filter fields are `system_id` and `hotfix_id`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightPatch -ConsoleHost [-Filter >] [-Sor ``` ## DESCRIPTION -Valid filter fields are `system_id` and `hotfix_id`. + ## EXAMPLES @@ -49,8 +49,7 @@ SystemId String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -65,23 +64,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -93,11 +79,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightProgram.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightProgram.md index c5aa947b7..2ce896bff 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightProgram.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightProgram.md @@ -8,10 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightProgram ## SYNOPSIS -Lists all programs for Windows devices. -For macOS devices, use [List System Insights Apps](#operation/systeminsights_list_apps). -Valid filter fields are `system_id` and `name`. ## SYNTAX @@ -21,10 +18,7 @@ Get-JcSdkSystemInsightProgram -ConsoleHost [-Filter >] [-S ``` ## DESCRIPTION -Lists all programs for Windows devices. -For macOS devices, use [List System Insights Apps](#operation/systeminsights_list_apps). -Valid filter fields are `system_id` and `name`. ## EXAMPLES @@ -56,8 +50,7 @@ Version String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -72,23 +65,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -100,11 +80,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPythonPackage.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPythonPackage.md index 455b53283..c9f30b0a6 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPythonPackage.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPythonPackage.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightPythonPackage ## SYNOPSIS -Valid filter fields are `system_id` and `name`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightPythonPackage -ConsoleHost [-Filter ``` ## DESCRIPTION -Valid filter fields are `system_id` and `name`. + ## EXAMPLES @@ -47,8 +47,7 @@ Version String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -63,23 +62,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -91,11 +77,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSafariExtension.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSafariExtension.md index 1cb83bdc7..5c9da7a1f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSafariExtension.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSafariExtension.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightSafariExtension ## SYNOPSIS -Valid filter fields are `system_id` and `name`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightSafariExtension -ConsoleHost [-Filter :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -95,11 +81,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightScheduledTask.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightScheduledTask.md index b83d15a67..8895123f7 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightScheduledTask.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightScheduledTask.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightScheduledTask ## SYNOPSIS -Valid filter fields are `system_id` and `enabled`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightScheduledTask -ConsoleHost [-Filter ``` ## DESCRIPTION -Valid filter fields are `system_id` and `enabled`. + ## EXAMPLES @@ -50,8 +50,7 @@ SystemId String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -66,23 +65,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -94,11 +80,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSecureboot.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSecureboot.md index c79ca5913..51cd7f535 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSecureboot.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSecureboot.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightSecureboot ## SYNOPSIS -Valid filter fields are `system_id`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightSecureboot -ConsoleHost [-Filter >] ``` ## DESCRIPTION -Valid filter fields are `system_id`. + ## EXAMPLES @@ -43,8 +43,7 @@ SystemId String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -59,23 +58,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -87,11 +73,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightService.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightService.md index 7595fd6ee..0ddb5d230 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightService.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightService.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightService ## SYNOPSIS -Valid filter fields are `system_id` and `name`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightService -ConsoleHost [-Filter >] [-S ``` ## DESCRIPTION -Valid filter fields are `system_id` and `name`. + ## EXAMPLES @@ -52,8 +52,7 @@ Win32ExitCode Int ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -68,23 +67,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -96,11 +82,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightShadow.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightShadow.md index ec96c81cf..bcbcbc1d0 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightShadow.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightShadow.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightShadow ## SYNOPSIS -Valid filter fields are `system_id` and `username`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightShadow -ConsoleHost [-Filter >] [-So ``` ## DESCRIPTION -Valid filter fields are `system_id` and `username`. + ## EXAMPLES @@ -51,8 +51,7 @@ Warning String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -67,23 +66,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -95,11 +81,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedFolder.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedFolder.md index d004d8e62..be2474f40 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedFolder.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedFolder.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightSharedFolder ## SYNOPSIS -Valid filter fields are `system_id` and `name`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightSharedFolder -ConsoleHost [-Filter > ``` ## DESCRIPTION -Valid filter fields are `system_id` and `name`. + ## EXAMPLES @@ -43,8 +43,7 @@ SystemId String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -59,23 +58,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -87,11 +73,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedResource.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedResource.md index a2f277c02..358967bcd 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedResource.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedResource.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightSharedResource ## SYNOPSIS -Valid filter fields are `system_id` and `type`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightSharedResource -ConsoleHost [-Filter :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -93,11 +79,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharingPreference.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharingPreference.md index 666763ce3..bcbbc4a81 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharingPreference.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharingPreference.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightSharingPreference ## SYNOPSIS -Only valid filed field is `system_id`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightSharingPreference -ConsoleHost [-Filter :\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -95,11 +81,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSipConfig.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSipConfig.md index 39198e975..b712bd220 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSipConfig.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSipConfig.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightSipConfig ## SYNOPSIS -Valid filter fields are `system_id` and `enabled`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightSipConfig -ConsoleHost [-Filter >] [ ``` ## DESCRIPTION -Valid filter fields are `system_id` and `enabled`. + ## EXAMPLES @@ -44,8 +44,7 @@ SystemId String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -60,23 +59,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -88,11 +74,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightStartupItem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightStartupItem.md index 77fdb4ac6..ccbe6c001 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightStartupItem.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightStartupItem.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightStartupItem ## SYNOPSIS -Valid filter fields are `system_id` and `name`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightStartupItem -ConsoleHost [-Filter >] ``` ## DESCRIPTION -Valid filter fields are `system_id` and `name`. + ## EXAMPLES @@ -47,8 +47,7 @@ Username String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -63,23 +62,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -91,11 +77,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemControl.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemControl.md index 7a1d29734..218536a8d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemControl.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemControl.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightSystemControl ## SYNOPSIS -Valid filter fields are `system_id` and `name`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightSystemControl -ConsoleHost [-Filter ``` ## DESCRIPTION -Valid filter fields are `system_id` and `name`. + ## EXAMPLES @@ -48,8 +48,7 @@ Type String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -64,23 +63,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -92,11 +78,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemInfo.md index b7a7eab1b..c818fa152 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemInfo.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemInfo.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightSystemInfo ## SYNOPSIS -Valid filter fields are `system_id` and `cpu_subtype`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightSystemInfo -ConsoleHost [-Filter >] ``` ## DESCRIPTION -Valid filter fields are `system_id` and `cpu_subtype`. + ## EXAMPLES @@ -56,8 +56,7 @@ Uuid String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -72,23 +71,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -100,11 +86,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightTpmInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightTpmInfo.md index dfd0cd546..1ab9955d2 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightTpmInfo.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightTpmInfo.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightTpmInfo ## SYNOPSIS -Valid filter fields are `system_id`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightTpmInfo -ConsoleHost [-Filter >] [-S ``` ## DESCRIPTION -Valid filter fields are `system_id`. + ## EXAMPLES @@ -50,8 +50,7 @@ SystemId String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -66,23 +65,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -94,11 +80,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUptime.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUptime.md index 4e061deef..2ab3f3636 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUptime.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUptime.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightUptime ## SYNOPSIS -Valid filter fields are `system_id` and `days`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightUptime -ConsoleHost [-Filter >] [-So ``` ## DESCRIPTION -Valid filter fields are `system_id` and `days`. + ## EXAMPLES @@ -46,8 +46,7 @@ TotalSeconds String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -62,23 +61,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -90,11 +76,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUsbDevice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUsbDevice.md index 711a463ce..0003491ea 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUsbDevice.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUsbDevice.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightUsbDevice ## SYNOPSIS -Valid filter fields are `system_id` and `model`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightUsbDevice -ConsoleHost [-Filter >] [ ``` ## DESCRIPTION -Valid filter fields are `system_id` and `model`. + ## EXAMPLES @@ -53,8 +53,7 @@ Version String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -69,23 +68,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -97,11 +83,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUser.md index f0cadc1e7..ab822d92b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUser.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUser.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightUser ## SYNOPSIS -Valid filter fields are `system_id` and `username`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightUser -ConsoleHost [-Filter >] [-Sort ``` ## DESCRIPTION -Valid filter fields are `system_id` and `username`. + ## EXAMPLES @@ -57,8 +57,7 @@ Uuid String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -73,23 +72,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -101,11 +87,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserAssist.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserAssist.md index dd35eb372..6dfa91fda 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserAssist.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserAssist.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightUserAssist ## SYNOPSIS -Valid filter fields are `system_id`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightUserAssist -ConsoleHost [-Filter >] ``` ## DESCRIPTION -Valid filter fields are `system_id`. + ## EXAMPLES @@ -45,8 +45,7 @@ SystemId String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -61,23 +60,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -89,11 +75,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserGroup.md index 462defdc1..e9b577ab9 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserGroup.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserGroup.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightUserGroup ## SYNOPSIS -Only valid filter field is `system_id`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightUserGroup -ConsoleHost [-Filter >] [ ``` ## DESCRIPTION -Only valid filter field is `system_id`. + ## EXAMPLES @@ -43,8 +43,7 @@ Uid String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -59,23 +58,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -87,11 +73,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserSshKey.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserSshKey.md index 91274f49b..50bc45f93 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserSshKey.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserSshKey.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightUserSshKey ## SYNOPSIS -Valid filter fields are `system_id` and `uid`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightUserSshKey -ConsoleHost [-Filter >] ``` ## DESCRIPTION -Valid filter fields are `system_id` and `uid`. + ## EXAMPLES @@ -44,8 +44,7 @@ Uid String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -60,23 +59,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -88,11 +74,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiNetwork.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiNetwork.md index 8b1f893c3..8cf18954d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiNetwork.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiNetwork.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightWifiNetwork ## SYNOPSIS -Valid filter fields are `system_id` and `security_type`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightWifiNetwork -ConsoleHost [-Filter >] ``` ## DESCRIPTION -Valid filter fields are `system_id` and `security_type`. + ## EXAMPLES @@ -53,8 +53,7 @@ TemporarilyDisabled System.Nullable[float] TemporarilyDisabled {get;set;} ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -69,23 +68,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -97,11 +83,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiStatus.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiStatus.md index f3775be15..3cc3b4a28 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiStatus.md +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiStatus.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-JcSdkSystemInsightWifiStatus ## SYNOPSIS -Valid filter fields are `system_id` and `security_type`. + ## SYNTAX @@ -18,7 +18,7 @@ Get-JcSdkSystemInsightWifiStatus -ConsoleHost [-Filter >] ``` ## DESCRIPTION -Valid filter fields are `system_id` and `security_type`. + ## EXAMPLES @@ -54,8 +54,7 @@ TransmitRate String ## PARAMETERS ### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. + ```yaml Type: System.String @@ -70,23 +69,10 @@ Accept wildcard characters: False ``` ### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -98,11 +84,10 @@ Accept wildcard characters: False ``` ### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. + ```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: From 360c2478cbe719ea3e43d356a1d1b7aa7c7a22d9 Mon Sep 17 00:00:00 2001 From: Joe Workman Date: Mon, 11 May 2026 08:57:00 -0600 Subject: [PATCH 04/11] generate --- .../exports/Get-JcSdkPolicyGroupMembership.md | 172 - .../Get-JcSdkPolicyGroupTraverseSystem.md | 157 - ...Get-JcSdkPolicyGroupTraverseSystemGroup.md | 157 - .../docs/exports/Get-JcSdkPolicyResult.md | 224 -- .../docs/exports/Get-JcSdkPolicyStatus.md | 139 - .../docs/exports/Get-JcSdkPolicyTemplate.md | 213 -- .../exports/Get-JcSdkPolicyTraverseSystem.md | 157 - .../Get-JcSdkPolicyTraverseSystemGroup.md | 157 - .../exports/Get-JcSdkProviderAdministrator.md | 145 - .../exports/Get-JcSdkProviderOrganization.md | 145 - .../docs/exports/Get-JcSdkProvidersInvoice.md | 170 - .../Get-JcSdkRadiusServerAssociation.md | 160 - .../Get-JcSdkRadiusServerTraverseUser.md | 157 - .../Get-JcSdkRadiusServerTraverseUserGroup.md | 157 - .../docs/exports/Get-JcSdkSoftwareApp.md | 178 - .../Get-JcSdkSoftwareAppAssociation.md | 160 - .../exports/Get-JcSdkSoftwareAppStatus.md | 176 - .../Get-JcSdkSoftwareAppTraverseSystem.md | 157 - ...Get-JcSdkSoftwareAppTraverseSystemGroup.md | 157 - .../docs/exports/Get-JcSdkSubscription.md | 73 - .../exports/Get-JcSdkSystemAssociation.md | 190 - .../docs/exports/Get-JcSdkSystemFdeKey.md | 136 - .../docs/exports/Get-JcSdkSystemGroup.md | 209 -- .../Get-JcSdkSystemGroupAssociation.md | 159 - .../exports/Get-JcSdkSystemGroupMember.md | 143 - .../exports/Get-JcSdkSystemGroupMembership.md | 172 - .../Get-JcSdkSystemGroupTraverseCommand.md | 181 - .../Get-JcSdkSystemGroupTraversePolicy.md | 157 - ...Get-JcSdkSystemGroupTraversePolicyGroup.md | 157 - .../Get-JcSdkSystemGroupTraverseUser.md | 157 - .../Get-JcSdkSystemGroupTraverseUserGroup.md | 157 - .../docs/exports/Get-JcSdkSystemInsightAlf.md | 107 - .../Get-JcSdkSystemInsightAlfException.md | 102 - .../Get-JcSdkSystemInsightAlfExplicitAuth.md | 101 - .../docs/exports/Get-JcSdkSystemInsightApp.md | 119 - .../Get-JcSdkSystemInsightAppCompatShim.md | 106 - .../Get-JcSdkSystemInsightAuthorizedKey.md | 104 - ...JcSdkSystemInsightAzureInstanceMetadata.md | 116 - .../Get-JcSdkSystemInsightAzureInstanceTag.md | 103 - .../exports/Get-JcSdkSystemInsightBattery.md | 118 - .../Get-JcSdkSystemInsightBitlockerInfo.md | 106 - .../Get-JcSdkSystemInsightBrowserPlugin.md | 110 - .../Get-JcSdkSystemInsightCertificate.md | 120 - .../Get-JcSdkSystemInsightChassisInfo.md | 113 - .../Get-JcSdkSystemInsightChromeExtension.md | 111 - .../Get-JcSdkSystemInsightConnectivity.md | 109 - .../exports/Get-JcSdkSystemInsightCrash.md | 116 - .../Get-JcSdkSystemInsightCupDestination.md | 102 - .../Get-JcSdkSystemInsightDiskEncryption.md | 107 - .../exports/Get-JcSdkSystemInsightDiskInfo.md | 111 - .../Get-JcSdkSystemInsightDnsResolver.md | 105 - .../exports/Get-JcSdkSystemInsightEtcHost.md | 102 - .../Get-JcSdkSystemInsightFirefoxAddon.md | 114 - .../exports/Get-JcSdkSystemInsightGroup.md | 105 - .../Get-JcSdkSystemInsightIeExtension.md | 104 - .../Get-JcSdkSystemInsightInterfaceAddress.md | 107 - .../Get-JcSdkSystemInsightInterfaceDetail.md | 134 - .../Get-JcSdkSystemInsightKernelInfo.md | 104 - .../exports/Get-JcSdkSystemInsightLaunchd.md | 121 - .../Get-JcSdkSystemInsightLinuxPackage.md | 110 - .../Get-JcSdkSystemInsightLoggedinUser.md | 106 - .../Get-JcSdkSystemInsightLogicalDrive.md | 106 - .../Get-JcSdkSystemInsightManagedPolicy.md | 106 - .../exports/Get-JcSdkSystemInsightMount.md | 111 - .../Get-JcSdkSystemInsightOSVersion.md | 110 - .../exports/Get-JcSdkSystemInsightPatch.md | 108 - .../exports/Get-JcSdkSystemInsightProgram.md | 109 - .../Get-JcSdkSystemInsightPythonPackage.md | 106 - .../Get-JcSdkSystemInsightSafariExtension.md | 110 - .../Get-JcSdkSystemInsightScheduledTask.md | 109 - .../Get-JcSdkSystemInsightSecureboot.md | 102 - .../exports/Get-JcSdkSystemInsightService.md | 111 - .../exports/Get-JcSdkSystemInsightShadow.md | 110 - .../Get-JcSdkSystemInsightSharedFolder.md | 102 - .../Get-JcSdkSystemInsightSharedResource.md | 108 - ...Get-JcSdkSystemInsightSharingPreference.md | 110 - .../Get-JcSdkSystemInsightSipConfig.md | 103 - .../Get-JcSdkSystemInsightStartupItem.md | 106 - .../Get-JcSdkSystemInsightSystemControl.md | 107 - .../Get-JcSdkSystemInsightSystemInfo.md | 115 - .../exports/Get-JcSdkSystemInsightTpmInfo.md | 109 - .../exports/Get-JcSdkSystemInsightUptime.md | 105 - .../Get-JcSdkSystemInsightUsbDevice.md | 112 - .../exports/Get-JcSdkSystemInsightUser.md | 116 - .../Get-JcSdkSystemInsightUserAssist.md | 104 - .../Get-JcSdkSystemInsightUserGroup.md | 102 - .../Get-JcSdkSystemInsightUserSshKey.md | 103 - .../Get-JcSdkSystemInsightWifiNetwork.md | 112 - .../Get-JcSdkSystemInsightWifiStatus.md | 113 - ...JcSdkSystemInsightWindowsSecurityCenter.md | 122 - ...cSdkSystemInsightWindowsSecurityProduct.md | 121 - .../docs/exports/Get-JcSdkSystemMember.md | 235 -- .../exports/Get-JcSdkSystemPolicyStatus.md | 175 - .../exports/Get-JcSdkSystemTraverseCommand.md | 229 -- .../exports/Get-JcSdkSystemTraversePolicy.md | 211 -- .../Get-JcSdkSystemTraversePolicyGroup.md | 235 -- .../exports/Get-JcSdkSystemTraverseUser.md | 235 -- .../Get-JcSdkSystemTraverseUserGroup.md | 235 -- .../docs/exports/Get-JcSdkUserAssociation.md | 184 - .../docs/exports/Get-JcSdkUserGroup.md | 247 -- .../exports/Get-JcSdkUserGroupAssociation.md | 182 - .../docs/exports/Get-JcSdkUserGroupMember.md | 160 - .../exports/Get-JcSdkUserGroupMembership.md | 203 - ...t-JcSdkUserGroupTraverseActiveDirectory.md | 199 - .../Get-JcSdkUserGroupTraverseApplication.md | 203 - .../Get-JcSdkUserGroupTraverseDirectory.md | 205 - .../Get-JcSdkUserGroupTraverseGSuite.md | 205 - .../Get-JcSdkUserGroupTraverseLdapServer.md | 203 - .../Get-JcSdkUserGroupTraverseOffice365.md | 203 - .../Get-JcSdkUserGroupTraverseRadiusServer.md | 205 - .../Get-JcSdkUserGroupTraverseSystem.md | 203 - .../Get-JcSdkUserGroupTraverseSystemGroup.md | 203 - .../docs/exports/Get-JcSdkUserMember.md | 203 - .../docs/exports/Get-JcSdkUserPushEndpoint.md | 179 - .../Get-JcSdkUserTraverseActiveDirectory.md | 203 - .../Get-JcSdkUserTraverseApplication.md | 203 - .../exports/Get-JcSdkUserTraverseDirectory.md | 203 - .../exports/Get-JcSdkUserTraverseGSuite.md | 203 - .../Get-JcSdkUserTraverseLdapServer.md | 203 - .../exports/Get-JcSdkUserTraverseOffice365.md | 203 - .../Get-JcSdkUserTraverseRadiusServer.md | 203 - .../exports/Get-JcSdkUserTraverseSystem.md | 203 - .../Get-JcSdkUserTraverseSystemGroup.md | 203 - .../docs/exports/Get-JcSdkWorkday.md | 241 -- .../docs/exports/Get-JcSdkWorkdayWorker.md | 181 - .../docs/exports/Grant-JcSdkWorkday.md | 312 -- .../docs/exports/Import-JcSdkScim.md | 263 -- .../docs/exports/Import-JcSdkWorkday.md | 297 -- .../docs/exports/Import-JcSdkWorkdayResult.md | 175 - .../Invoke-JcSdkReclaimSoftwareAppLicense.md | 190 - .../docs/exports/JumpCloud.SDK.V2.md | 3316 ----------------- .../docs/exports/Lock-JcSdkAppleMdmDevice.md | 267 -- .../docs/exports/New-JcSdkActiveDirectory.md | 243 -- .../exports/New-JcSdkActiveDirectoryAgent.md | 251 -- .../New-JcSdkAdministratorOrganization.md | 221 -- .../docs/exports/New-JcSdkApprovalFlow.md | 464 --- .../exports/New-JcSdkAuthenticationPolicy.md | 583 --- .../docs/exports/New-JcSdkBulkUser.md | 321 -- .../docs/exports/New-JcSdkBulkUserState.md | 247 -- .../New-JcSdkCustomEmailConfiguration.md | 264 -- .../docs/exports/New-JcSdkDuoAccount.md | 123 - .../docs/exports/New-JcSdkDuoApplication.md | 301 -- .../exports/New-JcSdkGSuiteTranslationRule.md | 263 -- .../docs/exports/New-JcSdkIPList.md | 218 -- .../exports/New-JcSdkLdapServerSambaDomain.md | 263 -- .../New-JcSdkOffice365TranslationRule.md | 263 -- .../docs/exports/New-JcSdkPolicy.md | 260 -- .../docs/exports/New-JcSdkPolicyGroup.md | 179 - .../exports/New-JcSdkProviderAdministrator.md | 409 -- .../docs/exports/New-JcSdkSoftwareApp.md | 402 -- .../docs/exports/New-JcSdkSystemGroup.md | 353 -- .../docs/exports/New-JcSdkUserGroup.md | 369 -- .../docs/exports/New-JcSdkWorkday.md | 280 -- .../exports/Remove-JcSdkActiveDirectory.md | 189 - .../Remove-JcSdkActiveDirectoryAgent.md | 216 -- .../Remove-JcSdkAdministratorOrganization.md | 200 - .../docs/exports/Remove-JcSdkAppleMdm.md | 222 -- .../exports/Remove-JcSdkAppleMdmDevice.md | 225 -- .../exports/Remove-JcSdkApplicationLogo.md | 185 - .../docs/exports/Remove-JcSdkApprovalFlow.md | 185 - .../Remove-JcSdkAuthenticationPolicy.md | 200 - .../docs/exports/Remove-JcSdkBulkUserState.md | 199 - .../Remove-JcSdkCustomEmailConfiguration.md | 185 - .../docs/exports/Remove-JcSdkDuoAccount.md | 187 - .../exports/Remove-JcSdkDuoApplication.md | 205 - .../Remove-JcSdkGSuiteTranslationRule.md | 220 -- .../docs/exports/Remove-JcSdkIPList.md | 189 - .../Remove-JcSdkLdapServerSambaDomain.md | 216 -- .../Remove-JcSdkOffice365TranslationRule.md | 220 -- .../docs/exports/Remove-JcSdkPolicy.md | 202 - .../docs/exports/Remove-JcSdkPolicyGroup.md | 209 -- .../Remove-JcSdkProviderAdministrator.md | 202 - .../docs/exports/Remove-JcSdkSoftwareApp.md | 205 - .../docs/exports/Remove-JcSdkSystemGroup.md | 214 -- .../docs/exports/Remove-JcSdkUserGroup.md | 216 -- .../exports/Remove-JcSdkUserPushEndpoint.md | 196 - .../Remove-JcSdkWorkdayAuthorization.md | 201 - .../exports/Restart-JcSdkAppleMdmDevice.md | 267 -- .../docs/exports/Set-JcSdkAccessRequest.md | 301 -- .../exports/Set-JcSdkAccessRequestApproval.md | 212 -- .../Set-JcSdkActiveDirectoryAssociation.md | 313 -- .../docs/exports/Set-JcSdkAppleMdm.md | 755 ---- .../Set-JcSdkApplicationAssociation.md | 310 -- .../docs/exports/Set-JcSdkApprovalFlow.md | 517 --- .../exports/Set-JcSdkApprovalFlowSetting.md | 251 -- .../exports/Set-JcSdkCommandAssociation.md | 314 -- .../Set-JcSdkCustomEmailConfiguration.md | 335 -- .../docs/exports/Set-JcSdkDuoApplication.md | 316 -- .../exports/Set-JcSdkGSuiteAssociation.md | 314 -- .../docs/exports/Set-JcSdkIPList.md | 285 -- .../exports/Set-JcSdkLdapServerAssociation.md | 312 -- .../exports/Set-JcSdkLdapServerSambaDomain.md | 278 -- .../exports/Set-JcSdkOffice365Association.md | 312 -- .../docs/exports/Set-JcSdkPolicy.md | 311 -- .../exports/Set-JcSdkPolicyAssociation.md | 312 -- .../docs/exports/Set-JcSdkPolicyGroup.md | 251 -- .../Set-JcSdkPolicyGroupAssociation.md | 314 -- .../exports/Set-JcSdkPolicyGroupMember.md | 291 -- .../Set-JcSdkRadiusServerAssociation.md | 316 -- .../docs/exports/Set-JcSdkSoftwareApp.md | 561 --- .../Set-JcSdkSoftwareAppAssociation.md | 308 -- .../exports/Set-JcSdkSystemAssociation.md | 360 -- .../docs/exports/Set-JcSdkSystemGroup.md | 425 --- .../Set-JcSdkSystemGroupAssociation.md | 314 -- .../exports/Set-JcSdkSystemGroupMember.md | 323 -- .../docs/exports/Set-JcSdkUserAssociation.md | 327 -- .../docs/exports/Set-JcSdkUserGroup.md | 443 --- .../exports/Set-JcSdkUserGroupAssociation.md | 314 -- .../docs/exports/Set-JcSdkUserGroupMember.md | 291 -- .../docs/exports/Set-JcSdkWorkday.md | 281 -- .../docs/exports/Stop-JcSdkAppleMdmDevice.md | 218 -- .../docs/exports/Sync-JcSdkAppleMdmDevice.md | 203 - ...date-JcSdkAppleMdmDeviceLockInformation.md | 220 -- .../Update-JcSdkAuthenticationPolicy.md | 626 ---- .../docs/exports/Update-JcSdkBulkUser.md | 268 -- .../docs/exports/Update-JcSdkGSuite.md | 407 -- .../docs/exports/Update-JcSdkIPList.md | 275 -- .../docs/exports/Update-JcSdkLdapServer.md | 286 -- .../docs/exports/Update-JcSdkOffice365.md | 379 -- .../exports/Update-JcSdkUserPushEndpoint.md | 272 -- .../JumpCloud.SDK.V2/test-module.ps1 | 494 +-- .../JumpCloud.SDK.V2/test/loadEnv.ps1 | 15 +- 222 files changed, 8 insertions(+), 49355 deletions(-) delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMembership.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystem.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystemGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyResult.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyStatus.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTemplate.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystem.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystemGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderAdministrator.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderOrganization.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProvidersInvoice.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUser.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUserGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareApp.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppStatus.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystem.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystemGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSubscription.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemFdeKey.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMember.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMembership.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseCommand.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicy.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicyGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUser.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUserGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlf.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfException.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfExplicitAuth.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightApp.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAppCompatShim.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAuthorizedKey.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceMetadata.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceTag.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBattery.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBitlockerInfo.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBrowserPlugin.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCertificate.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChassisInfo.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChromeExtension.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightConnectivity.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCrash.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCupDestination.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskEncryption.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskInfo.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDnsResolver.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightEtcHost.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightFirefoxAddon.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightIeExtension.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceAddress.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceDetail.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightKernelInfo.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLaunchd.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLinuxPackage.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLoggedinUser.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLogicalDrive.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightManagedPolicy.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightMount.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightOSVersion.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPatch.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightProgram.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPythonPackage.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSafariExtension.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightScheduledTask.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSecureboot.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightService.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightShadow.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedFolder.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedResource.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharingPreference.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSipConfig.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightStartupItem.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemControl.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemInfo.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightTpmInfo.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUptime.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUsbDevice.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUser.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserAssist.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserSshKey.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiNetwork.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiStatus.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityCenter.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityProduct.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemMember.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemPolicyStatus.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseCommand.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicy.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicyGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUser.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUserGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMember.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMembership.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseActiveDirectory.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseApplication.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseDirectory.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseGSuite.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseLdapServer.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseOffice365.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseRadiusServer.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystem.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystemGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserMember.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserPushEndpoint.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseActiveDirectory.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseApplication.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseDirectory.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseGSuite.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseLdapServer.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseOffice365.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseRadiusServer.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystem.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystemGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkday.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkdayWorker.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Grant-JcSdkWorkday.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkScim.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkday.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkdayResult.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Invoke-JcSdkReclaimSoftwareAppLicense.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/JumpCloud.SDK.V2.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Lock-JcSdkAppleMdmDevice.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectory.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectoryAgent.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAdministratorOrganization.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkApprovalFlow.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAuthenticationPolicy.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUser.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUserState.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkCustomEmailConfiguration.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoAccount.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoApplication.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkGSuiteTranslationRule.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkIPList.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkLdapServerSambaDomain.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkOffice365TranslationRule.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicy.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicyGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkProviderAdministrator.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSoftwareApp.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSystemGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkUserGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkWorkday.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectory.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectoryAgent.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAdministratorOrganization.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdm.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdmDevice.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApplicationLogo.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApprovalFlow.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAuthenticationPolicy.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkBulkUserState.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkCustomEmailConfiguration.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoAccount.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoApplication.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkGSuiteTranslationRule.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkIPList.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkLdapServerSambaDomain.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkOffice365TranslationRule.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicy.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicyGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkProviderAdministrator.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSoftwareApp.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSystemGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserPushEndpoint.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkWorkdayAuthorization.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Restart-JcSdkAppleMdmDevice.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequest.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequestApproval.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkActiveDirectoryAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAppleMdm.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApplicationAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlow.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlowSetting.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCommandAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCustomEmailConfiguration.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkDuoApplication.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkGSuiteAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkIPList.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerSambaDomain.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkOffice365Association.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicy.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupMember.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkRadiusServerAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareApp.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareAppAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupMember.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroup.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupAssociation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupMember.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkWorkday.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Stop-JcSdkAppleMdmDevice.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Sync-JcSdkAppleMdmDevice.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAppleMdmDeviceLockInformation.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAuthenticationPolicy.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkBulkUser.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkGSuite.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkIPList.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkLdapServer.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkOffice365.md delete mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkUserPushEndpoint.md diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMembership.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMembership.md deleted file mode 100644 index 8a20b42f5..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMembership.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMembership.md -schema: 2.0.0 ---- - -# Get-JcSdkPolicyGroupMembership - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkPolicyGroupMembership -ConsoleHost -GroupId [-Filter >] - [-Sort >] [] -``` - -### GetViaIdentity -``` -Get-JcSdkPolicyGroupMembership -ConsoleHost -InputObject - [-Filter >] [-Sort >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkPolicyGroupMembership -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystem.md deleted file mode 100644 index 75e7a66c1..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystem.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystem.md -schema: 2.0.0 ---- - -# Get-JcSdkPolicyGroupTraverseSystem - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkPolicyGroupTraverseSystem -ConsoleHost -GroupId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkPolicyGroupTraverseSystem -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkPolicyGroupTraverseSystem -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystemGroup.md deleted file mode 100644 index b6f72778c..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystemGroup.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystemGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkPolicyGroupTraverseSystemGroup - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkPolicyGroupTraverseSystemGroup -ConsoleHost -GroupId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkPolicyGroupTraverseSystemGroup -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkPolicyGroupTraverseSystemGroup -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyResult.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyResult.md deleted file mode 100644 index 818b24bb4..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyResult.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyResult.md -schema: 2.0.0 ---- - -# Get-JcSdkPolicyResult - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkPolicyResult -ConsoleHost -Id [] -``` - -### GetViaIdentity -``` -Get-JcSdkPolicyResult -ConsoleHost -InputObject [] -``` - -### List -``` -Get-JcSdkPolicyResult -ConsoleHost -PolicyId [-Fields >] - [-Filter >] [-Sort >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkPolicyResult -Id:() -``` - ----- ---------- -Detail String -EndedAt Datetime -ExitStatus System.Nullable[long] ExitStatus {get;set;} -Id String -PolicyId String -StartedAt Datetime -State String -StdErr String -StdOut String -Success Boolean -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkPolicyResult -PolicyId:() -Fields:() -Filter:() -Sort:() -``` - ----- ---------- -Detail String -EndedAt Datetime -ExitStatus System.Nullable[long] ExitStatus {get;set;} -Id String -PolicyId String -StartedAt Datetime -State String -StdErr String -StdOut String -Success Boolean -SystemId String - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PolicyId - - -```yaml -Type: System.String -Parameter Sets: List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPolicyResult - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyStatus.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyStatus.md deleted file mode 100644 index 9ed2f14ab..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyStatus.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyStatus.md -schema: 2.0.0 ---- - -# Get-JcSdkPolicyStatus - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkPolicyStatus -ConsoleHost -PolicyId [-Fields >] - [-Filter >] [-Sort >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkPolicyStatus -``` - ----- ---------- -Detail String -EndedAt Datetime -ExitStatus System.Nullable[long] ExitStatus {get;set;} -Id String -PolicyId String -StartedAt Datetime -State String -StdErr String -StdOut String -Success Boolean -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyId - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPolicyResult - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTemplate.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTemplate.md deleted file mode 100644 index 54aee174e..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTemplate.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTemplate.md -schema: 2.0.0 ---- - -# Get-JcSdkPolicyTemplate - -## SYNOPSIS - - -## SYNTAX - -### List (Default) -``` -Get-JcSdkPolicyTemplate -ConsoleHost [-Fields >] [-Filter >] - [-Sort >] [] -``` - -### Get -``` -Get-JcSdkPolicyTemplate -ConsoleHost -Id [] -``` - -### GetViaIdentity -``` -Get-JcSdkPolicyTemplate -ConsoleHost -InputObject [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkPolicyTemplate -Fields:() -Filter:() -Sort:() -``` - ----- ---------- -Activation String -Alert String -Behavior String -DeliveryTypes String -Description String -DisplayName String -Id String -Name String -OSMetaFamily String -OSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] -Reference String -State String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkPolicyTemplate -Id:() -``` - ----- ---------- -Activation String -Alert String -Behavior String -DeliveryTypes String -Description String -DisplayName String -Id String -Name String -OSMetaFamily String -OSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] -Reference String -State String - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPolicyTemplate - -### JumpCloud.SDK.V2.Models.IPolicyTemplateWithDetails - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystem.md deleted file mode 100644 index 7cae91573..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystem.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystem.md -schema: 2.0.0 ---- - -# Get-JcSdkPolicyTraverseSystem - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkPolicyTraverseSystem -ConsoleHost -PolicyId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkPolicyTraverseSystem -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkPolicyTraverseSystem -PolicyId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PolicyId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystemGroup.md deleted file mode 100644 index 1d31799d1..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystemGroup.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystemGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkPolicyTraverseSystemGroup - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkPolicyTraverseSystemGroup -ConsoleHost -PolicyId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkPolicyTraverseSystemGroup -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkPolicyTraverseSystemGroup -PolicyId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PolicyId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderAdministrator.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderAdministrator.md deleted file mode 100644 index 26c79e4cd..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderAdministrator.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderAdministrator.md -schema: 2.0.0 ---- - -# Get-JcSdkProviderAdministrator - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkProviderAdministrator -ConsoleHost -ProviderId [-Fields >] - [-Filter >] [-Sort >] [-SortIgnoreCase >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkProviderAdministrator -``` - ----- ---------- -Results JumpCloud.SDK.V2.Models.Administrator[] -TotalCount Int - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderId - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortIgnoreCase - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPathsYwlyndProvidersProviderIdAdministratorsGetResponses200ContentApplicationJsonSchema - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderOrganization.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderOrganization.md deleted file mode 100644 index 95e021fec..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderOrganization.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderOrganization.md -schema: 2.0.0 ---- - -# Get-JcSdkProviderOrganization - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkProviderOrganization -ConsoleHost -ProviderId [-Fields >] - [-Filter >] [-Sort >] [-SortIgnoreCase >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkProviderOrganization -``` - ----- ---------- -Results JumpCloud.SDK.V2.Models.Organization[] -TotalCount Int - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderId - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortIgnoreCase - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPaths1O3J7V8ProvidersProviderIdOrganizationsGetResponses200ContentApplicationJsonSchema - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProvidersInvoice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProvidersInvoice.md deleted file mode 100644 index 1c2e2fcdd..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProvidersInvoice.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProvidersInvoice.md -schema: 2.0.0 ---- - -# Get-JcSdkProvidersInvoice - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkProvidersInvoice -ConsoleHost -ProviderId [-Filter >] - [-Sort >] [] -``` - -### GetViaIdentity -``` -Get-JcSdkProvidersInvoice -ConsoleHost -InputObject [-Filter >] - [-Sort >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkProvidersInvoice -ProviderId:() -``` - ----- ---------- -Records JumpCloud.SDK.V2.Models.ProviderInvoice[] -TotalCount Int - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProviderId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IProviderInvoiceResponse - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerAssociation.md deleted file mode 100644 index 33c48e2e4..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerAssociation.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerAssociation.md -schema: 2.0.0 ---- - -# Get-JcSdkRadiusServerAssociation - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkRadiusServerAssociation -ConsoleHost -RadiusserverId -Targets - [] -``` - -### GetViaIdentity -``` -Get-JcSdkRadiusServerAssociation -ConsoleHost -InputObject -Targets - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkRadiusServerAssociation -RadiusserverId:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RadiusserverId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Targets - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphConnection - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUser.md deleted file mode 100644 index fb5f7f774..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUser.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUser.md -schema: 2.0.0 ---- - -# Get-JcSdkRadiusServerTraverseUser - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkRadiusServerTraverseUser -ConsoleHost -RadiusserverId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkRadiusServerTraverseUser -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkRadiusServerTraverseUser -RadiusserverId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RadiusserverId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUserGroup.md deleted file mode 100644 index fb8a15be9..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUserGroup.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUserGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkRadiusServerTraverseUserGroup - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkRadiusServerTraverseUserGroup -ConsoleHost -RadiusserverId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkRadiusServerTraverseUserGroup -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkRadiusServerTraverseUserGroup -RadiusserverId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RadiusserverId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareApp.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareApp.md deleted file mode 100644 index 1fd23a98c..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareApp.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareApp.md -schema: 2.0.0 ---- - -# Get-JcSdkSoftwareApp - -## SYNOPSIS - - -## SYNTAX - -### List (Default) -``` -Get-JcSdkSoftwareApp -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -### Get -``` -Get-JcSdkSoftwareApp -ConsoleHost -Id [] -``` - -### GetViaIdentity -``` -Get-JcSdkSoftwareApp -ConsoleHost -InputObject [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSoftwareApp -Filter:() -Sort:() -``` - ----- ---------- -DisplayName String -Id String -Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkSoftwareApp -Id:() -``` - ----- ---------- -DisplayName String -Id String -Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISoftwareApp - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppAssociation.md deleted file mode 100644 index dfd071c3e..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppAssociation.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppAssociation.md -schema: 2.0.0 ---- - -# Get-JcSdkSoftwareAppAssociation - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSoftwareAppAssociation -ConsoleHost -SoftwareAppId -Targets - [] -``` - -### GetViaIdentity -``` -Get-JcSdkSoftwareAppAssociation -ConsoleHost -InputObject -Targets - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSoftwareAppAssociation -SoftwareAppId:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SoftwareAppId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Targets - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphConnection - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppStatus.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppStatus.md deleted file mode 100644 index 98ab974ed..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppStatus.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppStatus.md -schema: 2.0.0 ---- - -# Get-JcSdkSoftwareAppStatus - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSoftwareAppStatus -ConsoleHost -SoftwareAppId [-Filter >] - [-Sort >] [] -``` - -### GetViaIdentity -``` -Get-JcSdkSoftwareAppStatus -ConsoleHost -InputObject [-Filter >] - [-Sort >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSoftwareAppStatus -SoftwareAppId:() -``` - ----- ---------- -Code Int -Details String -Id String -SoftwareAppId String -State String -SystemId String -Timestamp String -Version String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SoftwareAppId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISoftwareAppStatus - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystem.md deleted file mode 100644 index f6d14f4eb..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystem.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystem.md -schema: 2.0.0 ---- - -# Get-JcSdkSoftwareAppTraverseSystem - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSoftwareAppTraverseSystem -ConsoleHost -SoftwareAppId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkSoftwareAppTraverseSystem -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSoftwareAppTraverseSystem -SoftwareAppId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SoftwareAppId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystemGroup.md deleted file mode 100644 index a61c7dda2..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystemGroup.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystemGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkSoftwareAppTraverseSystemGroup - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSoftwareAppTraverseSystemGroup -ConsoleHost -SoftwareAppId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkSoftwareAppTraverseSystemGroup -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSoftwareAppTraverseSystemGroup -SoftwareAppId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SoftwareAppId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSubscription.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSubscription.md deleted file mode 100644 index b5cf2fd47..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSubscription.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSubscription.md -schema: 2.0.0 ---- - -# Get-JcSdkSubscription - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSubscription -ConsoleHost [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSubscription -``` - ----- ---------- -AnnualPrice float AnnualPrice {get;set;} -DisplayName String -Features JumpCloud.SDK.V2.Models.Feature[] -ListPrice float ListPrice {get;set;} -ProductCode String -UpgradeRecommendation String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISubscription - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemAssociation.md deleted file mode 100644 index 83e2d7aae..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemAssociation.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemAssociation.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemAssociation - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSystemAssociation -ConsoleHost -SystemId -Targets - [-Authorization ] [-Date ] [] -``` - -### GetViaIdentity -``` -Get-JcSdkSystemAssociation -ConsoleHost -InputObject -Targets - [-Authorization ] [-Date ] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemAssociation -SystemId:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -Authorization - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Date - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SystemId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Targets - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphConnection - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemFdeKey.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemFdeKey.md deleted file mode 100644 index 2a70597d3..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemFdeKey.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemFdeKey.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemFdeKey - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSystemFdeKey -ConsoleHost -SystemId [] -``` - -### GetViaIdentity -``` -Get-JcSdkSystemFdeKey -ConsoleHost -InputObject [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemFdeKey -SystemId:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SystemId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemfdekey - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroup.md deleted file mode 100644 index f0d392384..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroup.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemGroup - -## SYNOPSIS - - -## SYNTAX - -### List (Default) -``` -Get-JcSdkSystemGroup -ConsoleHost [-Fields >] [-Filter >] - [-Sort >] [] -``` - -### Get -``` -Get-JcSdkSystemGroup -ConsoleHost -Id [] -``` - -### GetViaIdentity -``` -Get-JcSdkSystemGroup -ConsoleHost -InputObject [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemGroup -Fields:() -Filter:() -Sort:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkSystemGroup -Id:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -Type String - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemGroup - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupAssociation.md deleted file mode 100644 index 3571704e8..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupAssociation.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupAssociation.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemGroupAssociation - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSystemGroupAssociation -ConsoleHost -GroupId -Targets [] -``` - -### GetViaIdentity -``` -Get-JcSdkSystemGroupAssociation -ConsoleHost -InputObject -Targets - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemGroupAssociation -GroupId:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Targets - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphConnection - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMember.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMember.md deleted file mode 100644 index 503c757e7..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMember.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMember.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemGroupMember - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSystemGroupMember -ConsoleHost -GroupId [] -``` - -### GetViaIdentity -``` -Get-JcSdkSystemGroupMember -ConsoleHost -InputObject [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemGroupMember -GroupId:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphConnection - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMembership.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMembership.md deleted file mode 100644 index edbb964dd..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMembership.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMembership.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemGroupMembership - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSystemGroupMembership -ConsoleHost -GroupId [-Filter >] - [-Sort >] [] -``` - -### GetViaIdentity -``` -Get-JcSdkSystemGroupMembership -ConsoleHost -InputObject - [-Filter >] [-Sort >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemGroupMembership -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseCommand.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseCommand.md deleted file mode 100644 index 37afe7b1c..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseCommand.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseCommand.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemGroupTraverseCommand - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSystemGroupTraverseCommand -ConsoleHost -GroupId [-Details ] - [-Filter >] [] -``` - -### GetViaIdentity -``` -Get-JcSdkSystemGroupTraverseCommand -ConsoleHost -InputObject - [-Details ] [-Filter >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemGroupTraverseCommand -GroupId:() -``` - ----- ---------- -Command String -CommandType String -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -LaunchType String -Name String -Organization String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Schedule String -ScheduleRepeatType String -Timeout String -TimeToLiveSeconds Int -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Details - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ICommandsGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicy.md deleted file mode 100644 index 279c15bd3..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicy.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicy.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemGroupTraversePolicy - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSystemGroupTraversePolicy -ConsoleHost -GroupId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkSystemGroupTraversePolicy -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemGroupTraversePolicy -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicyGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicyGroup.md deleted file mode 100644 index 912d40242..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicyGroup.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicyGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemGroupTraversePolicyGroup - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSystemGroupTraversePolicyGroup -ConsoleHost -GroupId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkSystemGroupTraversePolicyGroup -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemGroupTraversePolicyGroup -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUser.md deleted file mode 100644 index a9c44e54c..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUser.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUser.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemGroupTraverseUser - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSystemGroupTraverseUser -ConsoleHost -GroupId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkSystemGroupTraverseUser -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemGroupTraverseUser -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUserGroup.md deleted file mode 100644 index bfa383022..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUserGroup.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUserGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemGroupTraverseUserGroup - -## SYNOPSIS - - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSystemGroupTraverseUserGroup -ConsoleHost -GroupId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkSystemGroupTraverseUserGroup -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemGroupTraverseUserGroup -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId - - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlf.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlf.md deleted file mode 100644 index 1a8d0228b..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlf.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlf.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightAlf - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightAlf -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightAlf -``` - ----- ---------- -AllowSignedEnabled Int -CollectionTime String -FirewallUnload Int -GlobalState Int -LoggingEnabled Int -LoggingOption Int -StealthEnabled Int -SystemId String -Version String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsAlf - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfException.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfException.md deleted file mode 100644 index 3c331326c..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfException.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfException.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightAlfException - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightAlfException -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightAlfException -``` - ----- ---------- -CollectionTime String -Path String -State System.Nullable[float] State {get;set;} -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsAlfExceptions - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfExplicitAuth.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfExplicitAuth.md deleted file mode 100644 index c38072d01..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfExplicitAuth.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfExplicitAuth.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightAlfExplicitAuth - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightAlfExplicitAuth -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightAlfExplicitAuth -``` - ----- ---------- -CollectionTime String -Process String -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsAlfExplicitAuths - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightApp.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightApp.md deleted file mode 100644 index 49ba1ce65..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightApp.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightApp.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightApp - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightApp -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightApp -``` - ----- ---------- -ApplescriptEnabled String -BundleExecutable String -BundleIdentifier String -BundleName String -BundlePackageType String -BundleShortVersion String -BundleVersion String -Category String -CollectionTime String -Compiler String -Copyright String -DevelopmentRegion String -DisplayName String -Element String -Environment String -InfoString -LastOpenedTime System.Nullable[float] LastOpenedTime {get;set;} -MinimumSystemVersion String -Name String -Path String -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsApps - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAppCompatShim.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAppCompatShim.md deleted file mode 100644 index e3fb68602..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAppCompatShim.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAppCompatShim.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightAppCompatShim - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightAppCompatShim -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightAppCompatShim -``` - ----- ---------- -CollectionTime String -Description String -Executable String -InstallTime System.Nullable[float] InstallTime {get;set;} -Path String -SdbId String -SystemId String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsAppcompatShims - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAuthorizedKey.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAuthorizedKey.md deleted file mode 100644 index b1e59f780..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAuthorizedKey.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAuthorizedKey.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightAuthorizedKey - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightAuthorizedKey -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightAuthorizedKey -``` - ----- ---------- -Algorithm String -CollectionTime String -Key String -KeyFile String -SystemId String -Uid String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsAuthorizedKeys - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceMetadata.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceMetadata.md deleted file mode 100644 index 80092cf4d..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceMetadata.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceMetadata.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightAzureInstanceMetadata - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightAzureInstanceMetadata -ConsoleHost [-Filter >] - [-Sort >] [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightAzureInstanceMetadata -``` - ----- ---------- -CollectionTime String -Location String -Name String -Offer String -OSType String -PlacementGroupId String -PlatformFaultDomain String -PlatformUpdateDomain String -Publisher String -ResourceGroupName String -Sku String -SubscriptionId String -SystemId String -Version String -VMId String -VMScaleSetName String -VMSize String -Zone String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsAzureInstanceMetadata - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceTag.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceTag.md deleted file mode 100644 index 411415e16..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceTag.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceTag.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightAzureInstanceTag - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightAzureInstanceTag -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightAzureInstanceTag -``` - ----- ---------- -CollectionTime String -Key String -SystemId String -Value String -VMId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsAzureInstanceTags - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBattery.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBattery.md deleted file mode 100644 index e342f683e..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBattery.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBattery.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightBattery - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightBattery -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightBattery -``` - ----- ---------- -Amperage Int -Charged Int -Charging Int -CollectionTime String -Condition String -CurrentCapacity Int -CycleCount Int -DesignedCapacity Int -Health String -ManufactureDate Int -Manufacturer String -MaxCapacity Int -MinutesToFullCharge Int -MinutesUntilEmpty Int -Model String -PercentRemaining Int -SerialNumber String -State String -SystemId String -Voltage Int - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsBattery - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBitlockerInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBitlockerInfo.md deleted file mode 100644 index 1b9c849ad..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBitlockerInfo.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBitlockerInfo.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightBitlockerInfo - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightBitlockerInfo -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightBitlockerInfo -``` - ----- ---------- -CollectionTime String -ConversionStatus Int -DeviceId String -DriveLetter String -EncryptionMethod String -PersistentVolumeId String -ProtectionStatus Int -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsBitlockerInfo - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBrowserPlugin.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBrowserPlugin.md deleted file mode 100644 index aac22cbd9..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBrowserPlugin.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBrowserPlugin.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightBrowserPlugin - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightBrowserPlugin -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightBrowserPlugin -``` - ----- ---------- -CollectionTime String -Description String -DevelopmentRegion String -Disabled Int -Identifier String -Name String -Native Int -Path String -Sdk String -SystemId String -Uid String -Version String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsBrowserPlugins - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCertificate.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCertificate.md deleted file mode 100644 index d98e0cf5d..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCertificate.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCertificate.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightCertificate - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightCertificate -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightCertificate -``` - ----- ---------- -AuthorityKeyId String -Ca Int -CommonName String -Issuer String -KeyAlgorithm String -KeyStrength String -KeyUsage String -NotValidAfter String -NotValidBefore String -Path String -SelfSigned Int -Serial String -Sha1 String -Sid String -SigningAlgorithm String -Store String -StoreId String -StoreLocation String -Subject String -SubjectKeyId String -SystemId String -Username String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsCertificates - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChassisInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChassisInfo.md deleted file mode 100644 index c8a31c072..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChassisInfo.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChassisInfo.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightChassisInfo - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightChassisInfo -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightChassisInfo -``` - ----- ---------- -AudibleAlarm String -BreachDescription String -ChassisTypes String -CollectionTime String -Description String -Lock String -Manufacturer String -Model String -SecurityBreach String -Serial String -Sku String -SmbiosTag String -Status String -SystemId String -VisibleAlarm String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsChassisInfo - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChromeExtension.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChromeExtension.md deleted file mode 100644 index 66e567577..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChromeExtension.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChromeExtension.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightChromeExtension - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightChromeExtension -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightChromeExtension -``` - ----- ---------- -Author String -CollectionTime String -Description String -Identifier String -Locale String -Name String -Path String -Permissions String -Persistent Int -SystemId String -Uid String -UpdateUrl String -Version String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsChromeExtensions - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightConnectivity.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightConnectivity.md deleted file mode 100644 index 84dbdb4cd..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightConnectivity.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightConnectivity.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightConnectivity - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightConnectivity -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightConnectivity -``` - ----- ---------- -CollectionTime String -Disconnected Int -Ipv4Internet Int -Ipv4LocalNetwork Int -Ipv4NoTraffic Int -Ipv4Subnet Int -Ipv6Internet Int -Ipv6LocalNetwork Int -Ipv6NoTraffic Int -Ipv6Subnet Int -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsConnectivity - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCrash.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCrash.md deleted file mode 100644 index 357b475c2..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCrash.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCrash.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightCrash - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightCrash -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightCrash -``` - ----- ---------- -CollectionTime String -CrashedThread String -CrashPath String -Datetime String -ExceptionCodes String -ExceptionNotes String -ExceptionType String -Identifier String -Parent String -Path String -Pid String -Registers String -Responsible String -StackTrace String -SystemId String -Type String -Uid Int -Version String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsCrashes - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCupDestination.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCupDestination.md deleted file mode 100644 index 6e871eaa1..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCupDestination.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCupDestination.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightCupDestination - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightCupDestination -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightCupDestination -``` - ----- ---------- -Name String -OptionName String -OptionValue String -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsCupsDestinations - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskEncryption.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskEncryption.md deleted file mode 100644 index db2662ba3..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskEncryption.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskEncryption.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightDiskEncryption - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightDiskEncryption -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightDiskEncryption -``` - ----- ---------- -CollectionTime String -Encrypted Int -EncryptionStatus String -Name String -SystemId String -Type String -Uid String -UserUuid String -Uuid String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsDiskEncryption - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskInfo.md deleted file mode 100644 index 2f70b499c..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskInfo.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskInfo.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightDiskInfo - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightDiskInfo -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightDiskInfo -``` - ----- ---------- -CollectionTime String -Description String -DiskIndex Int -DiskSize String -HardwareModel String -Id String -Manufacturer String -Name String -Partitions Int -PnpDeviceId String -Serial String -SystemId String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsDiskInfo - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDnsResolver.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDnsResolver.md deleted file mode 100644 index a83088a64..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDnsResolver.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDnsResolver.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightDnsResolver - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightDnsResolver -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightDnsResolver -``` - ----- ---------- -Address String -CollectionTime String -Id System.Nullable[float] Id {get;set;} -Netmask String -Options String -SystemId String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsDnsResolvers - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightEtcHost.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightEtcHost.md deleted file mode 100644 index 95f3ad80e..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightEtcHost.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightEtcHost.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightEtcHost - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightEtcHost -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightEtcHost -``` - ----- ---------- -Address String -CollectionTime String -Hostnames String -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsEtcHosts - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightFirefoxAddon.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightFirefoxAddon.md deleted file mode 100644 index c58d26e5c..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightFirefoxAddon.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightFirefoxAddon.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightFirefoxAddon - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightFirefoxAddon -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightFirefoxAddon -``` - ----- ---------- -Active Int -Autoupdate Int -CollectionTime String -Creator String -Description String -Disabled Int -Identifier String -Location String -Name String -Path String -SourceUrl String -SystemId String -Type String -Uid String -Version String -Visible Int - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsFirefoxAddons - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightGroup.md deleted file mode 100644 index f0f6c732f..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightGroup.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightGroup - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightGroup -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightGroup -``` - ----- ---------- -CollectionTime String -Comment String -Gid String -GidSigned String -Groupname String -GroupSid String -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsGroups - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightIeExtension.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightIeExtension.md deleted file mode 100644 index 985ac59c7..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightIeExtension.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightIeExtension.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightIeExtension - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightIeExtension -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightIeExtension -``` - ----- ---------- -CollectionTime String -Name String -Path String -RegistryPath String -SystemId String -Version String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsIeExtensions - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceAddress.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceAddress.md deleted file mode 100644 index e62008d25..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceAddress.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceAddress.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightInterfaceAddress - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightInterfaceAddress -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightInterfaceAddress -``` - ----- ---------- -Address String -Broadcast String -CollectionTime String -FriendlyName String -Interface String -Mask String -PointToPoint String -SystemId String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsInterfaceAddresses - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceDetail.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceDetail.md deleted file mode 100644 index ce0c0daa7..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceDetail.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceDetail.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightInterfaceDetail - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightInterfaceDetail -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightInterfaceDetail -``` - ----- ---------- -Collisions String -ConnectionId String -ConnectionStatus String -Description String -DhcpEnabled Int -DhcpLeaseExpires String -DhcpLeaseObtained String -DhcpServer String -DnsDomain String -DnsDomainSuffixSearchOrder String -DnsHostName String -DnsServerSearchOrder String -Enabled Int -Flags Int -FriendlyName String -Ibytes String -Idrops String -Ierrors String -Interface String -Ipackets String -LastChange String -LinkSpeed String -Mac String -Manufacturer String -Metric Int -Mtu Int -Obytes String -Odrops String -Oerrors String -Opackets String -PciSlot String -PhysicalAdapter Int -Service String -Speed Int -SystemId String -Type Int - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsInterfaceDetails - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightKernelInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightKernelInfo.md deleted file mode 100644 index 8a04534bc..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightKernelInfo.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightKernelInfo.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightKernelInfo - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightKernelInfo -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightKernelInfo -``` - ----- ---------- -Arguments String -CollectionTime String -Device String -Path String -SystemId String -Version String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsKernelInfo - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLaunchd.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLaunchd.md deleted file mode 100644 index 072754225..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLaunchd.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLaunchd.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightLaunchd - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightLaunchd -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightLaunchd -``` - ----- ---------- -CollectionTime String -Disabled String -Groupname String -InetdCompatibility String -KeepAlive String -Label String -Name String -OnDemand String -Path String -ProcessType String -Program String -ProgramArguments String -QueueDirectories String -RootDirectory String -RunAtLoad String -StartInterval String -StartOnMount String -StderrPath String -StdoutPath String -SystemId String -Username String -WatchPaths String -WorkingDirectory String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsLaunchd - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLinuxPackage.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLinuxPackage.md deleted file mode 100644 index 69964534d..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLinuxPackage.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLinuxPackage.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightLinuxPackage - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightLinuxPackage -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightLinuxPackage -``` - ----- ---------- -Arch String -InstallTime Int -MaintainerOrVendor String -MountNamespaceId String -Name String -PackageFormat String -PackageGroupOrSection String -PidWithNamespace Int -ReleaseOrRevision String -Size String -SystemId String -Version String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsLinuxPackages - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLoggedinUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLoggedinUser.md deleted file mode 100644 index fff488212..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLoggedinUser.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLoggedinUser.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightLoggedinUser - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightLoggedinUser -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightLoggedinUser -``` - ----- ---------- -CollectionTime String -Host String -Pid Int -SystemId String -Time Int -Tty String -Type String -User String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsLoggedInUsers - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLogicalDrive.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLogicalDrive.md deleted file mode 100644 index f2fd876d3..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLogicalDrive.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLogicalDrive.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightLogicalDrive - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightLogicalDrive -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightLogicalDrive -``` - ----- ---------- -BootPartition Int -CollectionTime String -DeviceId String -FileSystem String -FreeSpace String -Size String -SystemId String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsLogicalDrives - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightManagedPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightManagedPolicy.md deleted file mode 100644 index 048d9698d..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightManagedPolicy.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightManagedPolicy.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightManagedPolicy - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightManagedPolicy -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightManagedPolicy -``` - ----- ---------- -CollectionTime String -Domain String -Manual Int -Name String -SystemId String -Username String -Uuid String -Value String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsManagedPolicies - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightMount.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightMount.md deleted file mode 100644 index cc4cab665..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightMount.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightMount.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightMount - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightMount -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightMount -``` - ----- ---------- -Blocks String -BlocksAvailable String -BlocksFree String -BlocksSize String -CollectionTime String -Device String -DeviceAlias String -Flags String -Inodes String -InodesFree String -Path String -SystemId String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsMounts - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightOSVersion.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightOSVersion.md deleted file mode 100644 index 75b97b5e0..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightOSVersion.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightOSVersion.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightOSVersion - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightOSVersion -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightOSVersion -``` - ----- ---------- -Build String -Codename String -CollectionTime String -InstallDate String -Major Int -Minor Int -Name String -Patch Int -Platform String -PlatformLike String -SystemId String -Version String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsOSVersion - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPatch.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPatch.md deleted file mode 100644 index 2f68d87b9..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPatch.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPatch.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightPatch - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightPatch -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightPatch -``` - ----- ---------- -Caption String -CollectionTime String -Csname String -Description String -FixComments String -HotfixId String -InstallDate String -InstalledBy String -InstalledOn String -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsPatches - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightProgram.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightProgram.md deleted file mode 100644 index 2ce896bff..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightProgram.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightProgram.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightProgram - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightProgram -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightProgram -``` - ----- ---------- -CollectionTime String -IdentifyingNumber String -InstallDate String -InstallLocation String -InstallSource String -Language String -Name String -Publisher String -SystemId String -UninstallString -Version String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsPrograms - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPythonPackage.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPythonPackage.md deleted file mode 100644 index c9f30b0a6..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPythonPackage.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPythonPackage.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightPythonPackage - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightPythonPackage -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightPythonPackage -``` - ----- ---------- -Auther String -Directory String -License String -Name String -Path String -Summary String -SystemId String -Version String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsPythonPackages - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSafariExtension.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSafariExtension.md deleted file mode 100644 index 5c9da7a1f..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSafariExtension.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSafariExtension.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightSafariExtension - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightSafariExtension -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightSafariExtension -``` - ----- ---------- -Author String -CollectionTime String -Description String -DeveloperId String -Identifier String -Name String -Path String -Sdk String -SystemId String -Uid String -UpdateUrl String -Version String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsSafariExtensions - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightScheduledTask.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightScheduledTask.md deleted file mode 100644 index 8895123f7..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightScheduledTask.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightScheduledTask.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightScheduledTask - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightScheduledTask -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightScheduledTask -``` - ----- ---------- -Action String -Enabled Int -Hidden Int -LastRunCode String -LastRunMessage String -LastRunTime String -Name String -NextRunTime String -Path String -State String -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsScheduledTasks - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSecureboot.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSecureboot.md deleted file mode 100644 index 51cd7f535..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSecureboot.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSecureboot.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightSecureboot - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightSecureboot -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightSecureboot -``` - ----- ---------- -CollectionTime String -SecureBoot System.Nullable[float] SecureBoot {get;set;} -SetupMode System.Nullable[float] SetupMode {get;set;} -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsSecureboot - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightService.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightService.md deleted file mode 100644 index 0ddb5d230..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightService.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightService.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightService - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightService -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightService -``` - ----- ---------- -Description String -DisplayName String -ModulePath String -Name String -Path String -Pid Int -ServiceExitCode Int -ServiceType String -StartType String -Status String -SystemId String -UserAccount String -Win32ExitCode Int - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsServices - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightShadow.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightShadow.md deleted file mode 100644 index bcbcbc1d0..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightShadow.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightShadow.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightShadow - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightShadow -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightShadow -``` - ----- ---------- -CollectionTime String -Expire String -Flag String -HashAlg String -Inactive String -LastChange String -Max String -Min String -PasswordStatus String -SystemId String -Username String -Warning String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsShadow - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedFolder.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedFolder.md deleted file mode 100644 index be2474f40..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedFolder.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedFolder.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightSharedFolder - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightSharedFolder -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightSharedFolder -``` - ----- ---------- -CollectionTime String -Name String -Path String -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsSharedFolders - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedResource.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedResource.md deleted file mode 100644 index 358967bcd..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedResource.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedResource.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightSharedResource - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightSharedResource -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightSharedResource -``` - ----- ---------- -AllowMaximum Int -CollectionTime String -Description String -InstallDate String -MaximumAllowed String -Name String -Path String -Status String -SystemId String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsSharedResources - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharingPreference.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharingPreference.md deleted file mode 100644 index bcbbc4a81..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharingPreference.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharingPreference.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightSharingPreference - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightSharingPreference -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightSharingPreference -``` - ----- ---------- -BluetoothSharing Int -CollectionTime String -ContentCaching Int -DiscSharing Int -FileSharing Int -InternetSharing Int -PrinterSharing Int -RemoteAppleEvents Int -RemoteLogin Int -RemoteManagement Int -ScreenSharing Int -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsSharingPreferences - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSipConfig.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSipConfig.md deleted file mode 100644 index b712bd220..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSipConfig.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSipConfig.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightSipConfig - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightSipConfig -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightSipConfig -``` - ----- ---------- -CollectionTime String -ConfigFlag String -Enabled Int -EnabledNvram Int -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsSipConfig - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightStartupItem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightStartupItem.md deleted file mode 100644 index ccbe6c001..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightStartupItem.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightStartupItem.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightStartupItem - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightStartupItem -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightStartupItem -``` - ----- ---------- -Args String -Name String -Path String -Source String -Status String -SystemId String -Type String -Username String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsStartupItems - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemControl.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemControl.md deleted file mode 100644 index 218536a8d..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemControl.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemControl.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightSystemControl - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightSystemControl -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightSystemControl -``` - ----- ---------- -CollectionTime String -ConfigValue String -CurrentValue String -FieldName String -Name String -Oid String -Subsystem String -SystemId String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsSystemControls - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemInfo.md deleted file mode 100644 index c818fa152..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemInfo.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemInfo.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightSystemInfo - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightSystemInfo -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightSystemInfo -``` - ----- ---------- -CollectionTime String -ComputerName String -CpuBrand String -CpuLogicalCores Int -CpuMicrocode String -CpuPhysicalCores Int -CpuSubtype String -CpuType String -HardwareModel String -HardwareSerial String -HardwareVendor String -HardwareVersion String -Hostname String -LocalHostname String -PhysicalMemory String -SystemId String -Uuid String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsSystemInfo - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightTpmInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightTpmInfo.md deleted file mode 100644 index 1ab9955d2..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightTpmInfo.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightTpmInfo.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightTpmInfo - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightTpmInfo -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightTpmInfo -``` - ----- ---------- -Activated System.Nullable[float] Activated {get;set;} -CollectionTime String -Enabled System.Nullable[float] Enabled {get;set;} -ManufacturerId System.Nullable[float] ManufacturerId {get;set;} -ManufacturerName String -ManufacturerVersion String -Owned System.Nullable[float] Owned {get;set;} -PhysicalPresenceVersion String -ProductName String -SpecVersion String -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsTpmInfo - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUptime.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUptime.md deleted file mode 100644 index 2ab3f3636..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUptime.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUptime.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightUptime - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightUptime -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightUptime -``` - ----- ---------- -CollectionTime String -Days Int -Hours Int -Minutes Int -Seconds Int -SystemId String -TotalSeconds String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsUptime - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUsbDevice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUsbDevice.md deleted file mode 100644 index 0003491ea..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUsbDevice.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUsbDevice.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightUsbDevice - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightUsbDevice -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightUsbDevice -``` - ----- ---------- -Class String -CollectionTime String -Model String -ModelId String -Protocol String -Removable Int -Serial String -Subclass String -SystemId String -UsbAddress Int -UsbPort Int -Vendor String -VendorId String -Version String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsUsbDevices - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUser.md deleted file mode 100644 index ab822d92b..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUser.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUser.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightUser - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightUser -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightUser -``` - ----- ---------- -AdManaged Boolean -Admin Boolean -CollectionTime String -Description String -Directory String -Gid String -GidSigned String -LastLogin String -Managed Boolean -RealUser Boolean -Shell String -Suspended Boolean -SystemId String -Type String -Uid String -UidSigned String -Username String -Uuid String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsUsers - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserAssist.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserAssist.md deleted file mode 100644 index 6dfa91fda..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserAssist.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserAssist.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightUserAssist - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightUserAssist -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightUserAssist -``` - ----- ---------- -CollectionTime String -Count System.Nullable[float] Count {get;set;} -LastExecutionTime System.Nullable[float] LastExecutionTime {get;set;} -Path String -Sid String -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsUserassist - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserGroup.md deleted file mode 100644 index e9b577ab9..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserGroup.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightUserGroup - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightUserGroup -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightUserGroup -``` - ----- ---------- -CollectionTime String -Gid String -SystemId String -Uid String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsUserGroups - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserSshKey.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserSshKey.md deleted file mode 100644 index 50bc45f93..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserSshKey.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserSshKey.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightUserSshKey - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightUserSshKey -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightUserSshKey -``` - ----- ---------- -CollectionTime String -Encrypted Int -Path String -SystemId String -Uid String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsUserSshKeys - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiNetwork.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiNetwork.md deleted file mode 100644 index 8cf18954d..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiNetwork.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiNetwork.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightWifiNetwork - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightWifiNetwork -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightWifiNetwork -``` - ----- ---------- -AutoLogin System.Nullable[float] AutoLogin {get;set;} -CaptivePortal System.Nullable[float] CaptivePortal {get;set;} -CollectionTime String -Disabled System.Nullable[float] Disabled {get;set;} -LastConnected System.Nullable[float] LastConnected {get;set;} -NetworkName String -Passpoint System.Nullable[float] Passpoint {get;set;} -PossiblyHidden System.Nullable[float] PossiblyHidden {get;set;} -Roaming System.Nullable[float] Roaming {get;set;} -RoamingProfile String -SecurityType String -Ssid String -SystemId String -TemporarilyDisabled System.Nullable[float] TemporarilyDisabled {get;set;} - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsWifiNetworks - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiStatus.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiStatus.md deleted file mode 100644 index 3cc3b4a28..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiStatus.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiStatus.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightWifiStatus - -## SYNOPSIS - - -## SYNTAX - -``` -Get-JcSdkSystemInsightWifiStatus -ConsoleHost [-Filter >] [-Sort >] - [] -``` - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightWifiStatus -``` - ----- ---------- -Bssid String -Channel System.Nullable[float] Channel {get;set;} -ChannelBand System.Nullable[float] ChannelBand {get;set;} -ChannelWidth System.Nullable[float] ChannelWidth {get;set;} -CollectionTime String -CountryCode String -Interface String -Mode String -NetworkName String -Noise System.Nullable[float] Noise {get;set;} -Rssi System.Nullable[float] Rssi {get;set;} -SecurityType String -Ssid String -SystemId String -TransmitRate String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort - - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsWifiStatus - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityCenter.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityCenter.md deleted file mode 100644 index 50a226be7..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityCenter.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityCenter.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightWindowsSecurityCenter - -## SYNOPSIS -Valid filter fields are `system_id`. - -## SYNTAX - -``` -Get-JcSdkSystemInsightWindowsSecurityCenter -ConsoleHost [-Filter >] - [-Sort >] [] -``` - -## DESCRIPTION -Valid filter fields are `system_id`. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightWindowsSecurityCenter -``` - ----- ---------- -Antispyware String -Antivirus String -Autoupdate String -CollectionTime String -Firewall String -InternetSettings String -SystemId String -UserAccountControl String -WindowsSecurityCenterService String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsWindowsSecurityCenter - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityProduct.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityProduct.md deleted file mode 100644 index e8aedaeb7..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityProduct.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityProduct.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemInsightWindowsSecurityProduct - -## SYNOPSIS -Valid filter fields are `system_id` and `state`. - -## SYNTAX - -``` -Get-JcSdkSystemInsightWindowsSecurityProduct -ConsoleHost [-Filter >] - [-Sort >] [] -``` - -## DESCRIPTION -Valid filter fields are `system_id` and `state`. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemInsightWindowsSecurityProduct -``` - ----- ---------- -CollectionTime String -Name String -RemediationPath String -SignaturesUpToDate System.Nullable[float] SignaturesUpToDate {get;set;} -State String -StateTimestamp String -SystemId String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemInsightsWindowsSecurityProducts - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemMember.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemMember.md deleted file mode 100644 index ec061d0aa..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemMember.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemMember.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemMember - -## SYNOPSIS -This endpoint returns all the System Groups a System is a member of. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/memberof \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSystemMember -ConsoleHost -SystemId [-Filter >] [-Sort >] - [-Authorization ] [-Date ] [] -``` - -### GetViaIdentity -``` -Get-JcSdkSystemMember -ConsoleHost -InputObject [-Filter >] - [-Sort >] [-Authorization ] [-Date ] [] -``` - -## DESCRIPTION -This endpoint returns all the System Groups a System is a member of. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/memberof \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemMember -SystemId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -Authorization -Authorization header for the System Context API - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Date -Current date header for the System Context API - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SystemId -ObjectID of the System. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemPolicyStatus.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemPolicyStatus.md deleted file mode 100644 index de5fc7af0..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemPolicyStatus.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemPolicyStatus.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemPolicyStatus - -## SYNOPSIS -This endpoint returns the policy results for a particular system. - -##### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## SYNTAX - -``` -Get-JcSdkSystemPolicyStatus -ConsoleHost -SystemId [-Fields >] - [-Filter >] [-Sort >] [] -``` - -## DESCRIPTION -This endpoint returns the policy results for a particular system. - -##### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemPolicyStatus -``` - ----- ---------- -Detail String -EndedAt Datetime -ExitStatus System.Nullable[long] ExitStatus {get;set;} -Id String -PolicyId String -StartedAt Datetime -State String -StdErr String -StdOut String -Success Boolean -SystemId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields -The comma separated fields included in the returned records. -If omitted, the default list of fields will be returned. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SystemId -ObjectID of the System. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPolicyResult - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseCommand.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseCommand.md deleted file mode 100644 index 69c51553a..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseCommand.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseCommand.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemTraverseCommand - -## SYNOPSIS -This endpoint will return all Commands bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/commands \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSystemTraverseCommand -ConsoleHost -SystemId [-Details ] - [-Filter >] [] -``` - -### GetViaIdentity -``` -Get-JcSdkSystemTraverseCommand -ConsoleHost -InputObject [-Details ] - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Commands bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/commands \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemTraverseCommand -SystemId:() -``` - ----- ---------- -Command String -CommandType String -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -LaunchType String -Name String -Organization String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Schedule String -ScheduleRepeatType String -Timeout String -TimeToLiveSeconds Int -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Details -This will provide detail descriptive response for the request. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SystemId -ObjectID of the System. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ICommandsGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicy.md deleted file mode 100644 index fe7fe14d7..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicy.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicy.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemTraversePolicy - -## SYNOPSIS -This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -This endpoint is not yet public as we have finish the code. - -##### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSystemTraversePolicy -ConsoleHost -SystemId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkSystemTraversePolicy -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -This endpoint is not yet public as we have finish the code. - -##### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemTraversePolicy -SystemId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SystemId -ObjectID of the System. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicyGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicyGroup.md deleted file mode 100644 index 914bc95c3..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicyGroup.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicyGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemTraversePolicyGroup - -## SYNOPSIS -This endpoint will return all Policy Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policygroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSystemTraversePolicyGroup -ConsoleHost -SystemId [-Filter >] - [-Authorization ] [-Date ] [] -``` - -### GetViaIdentity -``` -Get-JcSdkSystemTraversePolicyGroup -ConsoleHost -InputObject - [-Filter >] [-Authorization ] [-Date ] [] -``` - -## DESCRIPTION -This endpoint will return all Policy Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policygroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemTraversePolicyGroup -SystemId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -Authorization -Authorization header for the System Context API - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Date -Current date header for the System Context API - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SystemId -ObjectID of the System. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUser.md deleted file mode 100644 index dbb603fa5..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUser.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUser.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemTraverseUser - -## SYNOPSIS -This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSystemTraverseUser -ConsoleHost -SystemId [-Filter >] - [-Authorization ] [-Date ] [] -``` - -### GetViaIdentity -``` -Get-JcSdkSystemTraverseUser -ConsoleHost -InputObject - [-Filter >] [-Authorization ] [-Date ] [] -``` - -## DESCRIPTION -This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemTraverseUser -SystemId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -Authorization -Authorization header for the System Context API - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Date -Current date header for the System Context API - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SystemId -ObjectID of the System. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUserGroup.md deleted file mode 100644 index 6d967693e..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUserGroup.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUserGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkSystemTraverseUserGroup - -## SYNOPSIS -This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkSystemTraverseUserGroup -ConsoleHost -SystemId [-Filter >] - [-Authorization ] [-Date ] [] -``` - -### GetViaIdentity -``` -Get-JcSdkSystemTraverseUserGroup -ConsoleHost -InputObject - [-Filter >] [-Authorization ] [-Date ] [] -``` - -## DESCRIPTION -This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkSystemTraverseUserGroup -SystemId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -Authorization -Authorization header for the System Context API - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Date -Current date header for the System Context API - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SystemId -ObjectID of the System. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserAssociation.md deleted file mode 100644 index eb22356dc..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserAssociation.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserAssociation.md -schema: 2.0.0 ---- - -# Get-JcSdkUserAssociation - -## SYNOPSIS -This endpoint returns the _direct_ associations of a User. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/associations?targets=system_group \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserAssociation -ConsoleHost -UserId -Targets [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserAssociation -ConsoleHost -InputObject -Targets - [] -``` - -## DESCRIPTION -This endpoint returns the _direct_ associations of a User. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/associations?targets=system_group \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserAssociation -UserId:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Targets -Targets which a "active_directory" can be associated to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -ObjectID of the User. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphConnection - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroup.md deleted file mode 100644 index 69c23d497..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroup.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkUserGroup - -## SYNOPSIS -This endpoint returns the details of a User Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### List (Default) -``` -Get-JcSdkUserGroup -ConsoleHost [-Fields >] [-Filter >] - [-Sort >] [] -``` - -### Get -``` -Get-JcSdkUserGroup -ConsoleHost -Id [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserGroup -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -This endpoint returns the details of a User Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserGroup -Fields:() -Filter:() -Sort:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -SuggestionCountAdd Int -SuggestionCountRemove Int -SuggestionCountTotal Int -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkUserGroup -Id:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -SuggestionCountAdd Int -SuggestionCountRemove Int -SuggestionCountTotal Int -Type String - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields -The comma separated fields included in the returned records. -If omitted, the default list of fields will be returned. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -ObjectID of the User Group. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IUserGroup - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupAssociation.md deleted file mode 100644 index 456c2bdf9..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupAssociation.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupAssociation.md -schema: 2.0.0 ---- - -# Get-JcSdkUserGroupAssociation - -## SYNOPSIS -This endpoint returns the _direct_ associations of this User Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations?targets=system \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserGroupAssociation -ConsoleHost -GroupId -Targets [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserGroupAssociation -ConsoleHost -InputObject -Targets - [] -``` - -## DESCRIPTION -This endpoint returns the _direct_ associations of this User Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations?targets=system \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserGroupAssociation -GroupId:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the User Group. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Targets -Targets which a "active_directory" can be associated to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphConnection - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMember.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMember.md deleted file mode 100644 index a53f769aa..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMember.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMember.md -schema: 2.0.0 ---- - -# Get-JcSdkUserGroupMember - -## SYNOPSIS -This endpoint returns the user members of a User Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserGroupMember -ConsoleHost -GroupId [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserGroupMember -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -This endpoint returns the user members of a User Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserGroupMember -GroupId:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes -FromId String -FromType String -ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes -ToId String -ToType String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the User Group. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphConnection - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMembership.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMembership.md deleted file mode 100644 index afa6041c3..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMembership.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMembership.md -schema: 2.0.0 ---- - -# Get-JcSdkUserGroupMembership - -## SYNOPSIS -This endpoint returns all users members that are a member of this User Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/membership \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserGroupMembership -ConsoleHost -GroupId [-Filter >] - [-Sort >] [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserGroupMembership -ConsoleHost -InputObject - [-Filter >] [-Sort >] [] -``` - -## DESCRIPTION -This endpoint returns all users members that are a member of this User Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/membership \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserGroupMembership -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the User Group. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseActiveDirectory.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseActiveDirectory.md deleted file mode 100644 index f210e673d..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseActiveDirectory.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseActiveDirectory.md -schema: 2.0.0 ---- - -# Get-JcSdkUserGroupTraverseActiveDirectory - -## SYNOPSIS -This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserGroupTraverseActiveDirectory -ConsoleHost -GroupId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserGroupTraverseActiveDirectory -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserGroupTraverseActiveDirectory -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the User Group. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseApplication.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseApplication.md deleted file mode 100644 index 8ef59ba98..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseApplication.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseApplication.md -schema: 2.0.0 ---- - -# Get-JcSdkUserGroupTraverseApplication - -## SYNOPSIS -This endpoint will return all Applications bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/applications \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserGroupTraverseApplication -ConsoleHost -GroupId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserGroupTraverseApplication -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Applications bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/applications \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserGroupTraverseApplication -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the User Group. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseDirectory.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseDirectory.md deleted file mode 100644 index fffaf1a05..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseDirectory.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseDirectory.md -schema: 2.0.0 ---- - -# Get-JcSdkUserGroupTraverseDirectory - -## SYNOPSIS -This endpoint will return all Directories bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directories from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/directories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserGroupTraverseDirectory -ConsoleHost -GroupId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserGroupTraverseDirectory -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Directories bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directories from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/directories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserGroupTraverseDirectory -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the User Group. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseGSuite.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseGSuite.md deleted file mode 100644 index 246054e9f..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseGSuite.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseGSuite.md -schema: 2.0.0 ---- - -# Get-JcSdkUserGroupTraverseGSuite - -## SYNOPSIS -This endpoint will return all G Suite Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID/gsuites \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserGroupTraverseGSuite -ConsoleHost -GroupId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserGroupTraverseGSuite -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all G Suite Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID/gsuites \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserGroupTraverseGSuite -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the User Group. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseLdapServer.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseLdapServer.md deleted file mode 100644 index 719a03213..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseLdapServer.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseLdapServer.md -schema: 2.0.0 ---- - -# Get-JcSdkUserGroupTraverseLdapServer - -## SYNOPSIS -This endpoint will return all LDAP Servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/ldapservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserGroupTraverseLdapServer -ConsoleHost -GroupId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserGroupTraverseLdapServer -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all LDAP Servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/ldapservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserGroupTraverseLdapServer -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the User Group. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseOffice365.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseOffice365.md deleted file mode 100644 index 55f84a9dc..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseOffice365.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseOffice365.md -schema: 2.0.0 ---- - -# Get-JcSdkUserGroupTraverseOffice365 - -## SYNOPSIS -This endpoint will return all Office 365 instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/office365s \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserGroupTraverseOffice365 -ConsoleHost -GroupId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserGroupTraverseOffice365 -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Office 365 instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/office365s \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserGroupTraverseOffice365 -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the User Group. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseRadiusServer.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseRadiusServer.md deleted file mode 100644 index 9e60e1888..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseRadiusServer.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseRadiusServer.md -schema: 2.0.0 ---- - -# Get-JcSdkUserGroupTraverseRadiusServer - -## SYNOPSIS -This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserGroupTraverseRadiusServer -ConsoleHost -GroupId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserGroupTraverseRadiusServer -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserGroupTraverseRadiusServer -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the User Group. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystem.md deleted file mode 100644 index 9a98ff09b..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystem.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystem.md -schema: 2.0.0 ---- - -# Get-JcSdkUserGroupTraverseSystem - -## SYNOPSIS -This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserGroupTraverseSystem -ConsoleHost -GroupId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserGroupTraverseSystem -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserGroupTraverseSystem -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the User Group. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystemGroup.md deleted file mode 100644 index 26c89dc00..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystemGroup.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystemGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkUserGroupTraverseSystemGroup - -## SYNOPSIS -This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserGroupTraverseSystemGroup -ConsoleHost -GroupId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserGroupTraverseSystemGroup -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserGroupTraverseSystemGroup -GroupId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the User Group. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserMember.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserMember.md deleted file mode 100644 index 2aeee1146..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserMember.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserMember.md -schema: 2.0.0 ---- - -# Get-JcSdkUserMember - -## SYNOPSIS -This endpoint returns all the User Groups a User is a member of. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/memberof \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserMember -ConsoleHost -UserId [-Filter >] [-Sort >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserMember -ConsoleHost -InputObject [-Filter >] - [-Sort >] [] -``` - -## DESCRIPTION -This endpoint returns all the User Groups a User is a member of. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/memberof \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserMember -UserId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -ObjectID of the User. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserPushEndpoint.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserPushEndpoint.md deleted file mode 100644 index 664fe02b7..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserPushEndpoint.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserPushEndpoint.md -schema: 2.0.0 ---- - -# Get-JcSdkUserPushEndpoint - -## SYNOPSIS -This endpoint will retrieve a push endpoint associated with a user. - -## SYNTAX - -### List (Default) -``` -Get-JcSdkUserPushEndpoint -ConsoleHost -UserId [] -``` - -### Get -``` -Get-JcSdkUserPushEndpoint -ConsoleHost -PushEndpointId -UserId [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserPushEndpoint -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -This endpoint will retrieve a push endpoint associated with a user. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserPushEndpoint -UserId:() -``` - ----- ---------- -DeviceAppVersion String -DeviceMake String -DeviceModel String -DeviceOS String -DeviceOSVersion String -DeviceUvEnabled Boolean -EnrollmentDate Datetime -Id String -LastUsedDate Datetime -Name String -State String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkUserPushEndpoint -UserId:() -PushEndpointId:() -``` - ----- ---------- -DeviceAppVersion String -DeviceMake String -DeviceModel String -DeviceOS String -DeviceOSVersion String -DeviceUvEnabled Boolean -EnrollmentDate Datetime -Id String -LastUsedDate Datetime -Name String -State String - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PushEndpointId -. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPushEndpointResponse - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseActiveDirectory.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseActiveDirectory.md deleted file mode 100644 index 00ac10707..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseActiveDirectory.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseActiveDirectory.md -schema: 2.0.0 ---- - -# Get-JcSdkUserTraverseActiveDirectory - -## SYNOPSIS -This endpoint will return all Active Directory Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Active Directory instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory instance from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/activedirectories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserTraverseActiveDirectory -ConsoleHost -UserId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserTraverseActiveDirectory -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Active Directory Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Active Directory instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory instance from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/activedirectories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserTraverseActiveDirectory -UserId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UserId -ObjectID of the User. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseApplication.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseApplication.md deleted file mode 100644 index 726a0c3bc..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseApplication.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseApplication.md -schema: 2.0.0 ---- - -# Get-JcSdkUserTraverseApplication - -## SYNOPSIS -This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserTraverseApplication -ConsoleHost -UserId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserTraverseApplication -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserTraverseApplication -UserId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UserId -ObjectID of the User. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseDirectory.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseDirectory.md deleted file mode 100644 index 40a32b4da..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseDirectory.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseDirectory.md -schema: 2.0.0 ---- - -# Get-JcSdkUserTraverseDirectory - -## SYNOPSIS -This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserTraverseDirectory -ConsoleHost -UserId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserTraverseDirectory -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserTraverseDirectory -UserId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UserId -ObjectID of the User. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseGSuite.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseGSuite.md deleted file mode 100644 index 905bfc939..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseGSuite.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseGSuite.md -schema: 2.0.0 ---- - -# Get-JcSdkUserTraverseGSuite - -## SYNOPSIS -This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserTraverseGSuite -ConsoleHost -UserId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserTraverseGSuite -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserTraverseGSuite -UserId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UserId -ObjectID of the User. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseLdapServer.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseLdapServer.md deleted file mode 100644 index e3c7bf30f..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseLdapServer.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseLdapServer.md -schema: 2.0.0 ---- - -# Get-JcSdkUserTraverseLdapServer - -## SYNOPSIS -This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserTraverseLdapServer -ConsoleHost -UserId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserTraverseLdapServer -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserTraverseLdapServer -UserId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UserId -ObjectID of the User. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseOffice365.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseOffice365.md deleted file mode 100644 index 3aef92fda..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseOffice365.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseOffice365.md -schema: 2.0.0 ---- - -# Get-JcSdkUserTraverseOffice365 - -## SYNOPSIS -This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserTraverseOffice365 -ConsoleHost -UserId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserTraverseOffice365 -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserTraverseOffice365 -UserId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UserId -ObjectID of the User. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseRadiusServer.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseRadiusServer.md deleted file mode 100644 index 757521d7d..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseRadiusServer.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseRadiusServer.md -schema: 2.0.0 ---- - -# Get-JcSdkUserTraverseRadiusServer - -## SYNOPSIS -This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserTraverseRadiusServer -ConsoleHost -UserId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserTraverseRadiusServer -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserTraverseRadiusServer -UserId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UserId -ObjectID of the User. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystem.md deleted file mode 100644 index 9bc963f1c..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystem.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystem.md -schema: 2.0.0 ---- - -# Get-JcSdkUserTraverseSystem - -## SYNOPSIS -This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserTraverseSystem -ConsoleHost -UserId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserTraverseSystem -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserTraverseSystem -UserId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UserId -ObjectID of the User. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystemGroup.md deleted file mode 100644 index 81cc22780..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystemGroup.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystemGroup.md -schema: 2.0.0 ---- - -# Get-JcSdkUserTraverseSystemGroup - -## SYNOPSIS -This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkUserTraverseSystemGroup -ConsoleHost -UserId [-Filter >] - [] -``` - -### GetViaIdentity -``` -Get-JcSdkUserTraverseSystemGroup -ConsoleHost -InputObject - [-Filter >] [] -``` - -## DESCRIPTION -This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkUserTraverseSystemGroup -UserId:() -``` - ----- ---------- -CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes -Id String -Paths JumpCloud.SDK.V2.Models.GraphConnection[][] -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UserId -ObjectID of the User. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkday.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkday.md deleted file mode 100644 index df589dc1b..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkday.md +++ /dev/null @@ -1,241 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkday.md -schema: 2.0.0 ---- - -# Get-JcSdkWorkday - -## SYNOPSIS -This endpoint will return all the available information about an instance of Workday. - -#### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/workdays/ \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## SYNTAX - -### List (Default) -``` -Get-JcSdkWorkday -ConsoleHost [-Fields >] [-Filter >] - [-Sort >] [] -``` - -### Get -``` -Get-JcSdkWorkday -ConsoleHost -Id [] -``` - -### GetViaIdentity -``` -Get-JcSdkWorkday -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -This endpoint will return all the available information about an instance of Workday. - -#### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/workdays/ \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkWorkday -Fields:() -Filter:() -Sort:() -``` - ----- ---------- -BasicExpiry String -BasicIsValid Boolean -BasicMessage String -Id String -LastImport String -Name String -OauthExpiry String -OauthIsValid Boolean -OauthMessage String -ReportUrl String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Get-JcSdkWorkday -Id:() -``` - ----- ---------- -BasicExpiry String -BasicIsValid Boolean -BasicMessage String -Id String -LastImport String -Name String -OauthExpiry String -OauthIsValid Boolean -OauthMessage String -ReportUrl String - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fields -The comma separated fields included in the returned records. -If omitted, the default list of fields will be returned. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -A filter to apply to the query. - -**Filter structure**: `\:\:\`. - -**field** = Populate with a valid field from an endpoint response. - -**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. -_Note: v1 operators differ from v2 operators._ - -**value** = Populate with the value you want to search for. -Is case sensitive. -Supports wild cards. - -**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IWorkdayOutput - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkdayWorker.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkdayWorker.md deleted file mode 100644 index 46738cf09..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkdayWorker.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkdayWorker.md -schema: 2.0.0 ---- - -# Get-JcSdkWorkdayWorker - -## SYNOPSIS -This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. - -##### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - - -``` - -## SYNTAX - -### Get (Default) -``` -Get-JcSdkWorkdayWorker -ConsoleHost -WorkdayId [-Sort >] [] -``` - -### GetViaIdentity -``` -Get-JcSdkWorkdayWorker -ConsoleHost -InputObject [-Sort >] - [] -``` - -## DESCRIPTION -This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. - -##### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Get-JcSdkWorkdayWorker -WorkdayId:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.WorkdayWorkerAttributes -Email String -FirstName String -LastName String -Username String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Sort -The comma separated fields used to sort the collection. -Default sort is ascending, prefix with `-` to sort descending. - -```yaml -Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkdayId -. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IWorkdayWorker - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Grant-JcSdkWorkday.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Grant-JcSdkWorkday.md deleted file mode 100644 index f87d1b413..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Grant-JcSdkWorkday.md +++ /dev/null @@ -1,312 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Grant-JcSdkWorkday.md -schema: 2.0.0 ---- - -# Grant-JcSdkWorkday - -## SYNOPSIS -This endpoint adds an authorization method to a workday instance. - -You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. -Failure to provide these credentials will result in the request being rejected. - -Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ -\t\"auth\":{ -\t \"basic\": { -\t\t\"username\": \"someDeveloper\",\t -\t\t\"password\": \"notTheRealPassword\" - -\t } -\t} -}' - -``` - -## SYNTAX - -### AuthorizeExpanded (Default) -``` -Grant-JcSdkWorkday -ConsoleHost -WorkdayId [-BasicPassword ] - [-BasicUsername ] [-OauthCode ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Authorize -``` -Grant-JcSdkWorkday -ConsoleHost -WorkdayId -Body [-PassThru] [-Confirm] - [-WhatIf] [] -``` - -### AuthorizeViaIdentity -``` -Grant-JcSdkWorkday -ConsoleHost -InputObject -Body - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### AuthorizeViaIdentityExpanded -``` -Grant-JcSdkWorkday -ConsoleHost -InputObject [-BasicPassword ] - [-BasicUsername ] [-OauthCode ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint adds an authorization method to a workday instance. - -You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. -Failure to provide these credentials will result in the request being rejected. - -Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ -\t\"auth\":{ -\t \"basic\": { -\t\t\"username\": \"someDeveloper\",\t -\t\t\"password\": \"notTheRealPassword\" - -\t } -\t} -}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Grant-JcSdkWorkday -WorkdayId:() -BasicPassword:() -BasicUsername:() -OauthCode:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Grant-JcSdkWorkday -WorkdayId:() -Body:() -``` - - - -## PARAMETERS - -### -BasicPassword -. - -```yaml -Type: System.String -Parameter Sets: AuthorizeExpanded, AuthorizeViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BasicUsername -. - -```yaml -Type: System.String -Parameter Sets: AuthorizeExpanded, AuthorizeViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -Auth Input Object - -```yaml -Type: JumpCloud.SDK.V2.Models.IAuthInputObject -Parameter Sets: Authorize, AuthorizeViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: AuthorizeViaIdentity, AuthorizeViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OauthCode -. - -```yaml -Type: System.String -Parameter Sets: AuthorizeExpanded, AuthorizeViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkdayId -. - -```yaml -Type: System.String -Parameter Sets: Authorize, AuthorizeExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IAuthInputObject - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: Auth Input Object - - `[BasicPassword ]`: - - `[BasicUsername ]`: - - `[OauthCode ]`: - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkScim.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkScim.md deleted file mode 100644 index 6ec6350eb..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkScim.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkScim.md -schema: 2.0.0 ---- - -# Import-JcSdkScim - -## SYNOPSIS -Get a list of users to import from an Application IdM service provider. - -## SYNTAX - -### Import (Default) -``` -Import-JcSdkScim -ConsoleHost -ApplicationId [-Cursor ] [-Filter ] - [-IsCount] [-IsCursor] [-Query ] [-SessionId ] [-Sort ] [-SortOrder ] - [] -``` - -### ImportViaIdentity -``` -Import-JcSdkScim -ConsoleHost -InputObject [-Cursor ] - [-Filter ] [-IsCount] [-IsCursor] [-Query ] [-SessionId ] [-Sort ] - [-SortOrder ] [] -``` - -## DESCRIPTION -Get a list of users to import from an Application IdM service provider. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Import-JcSdkScim -ApplicationId:() -``` - ----- ---------- -TotalCount System.Nullable[float] TotalCount {get;set;} -Users JumpCloud.SDK.V2.Models.ImportUser[] - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ApplicationId -ObjectID of the Application. - -```yaml -Type: System.String -Parameter Sets: Import -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cursor -Cursor token for pagination - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Filter users by a search term - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: ImportViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IsCount -IsCount indicates if the request is only for getting the total count of users. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsCursor -Enable cursor-based pagination - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Query -URL query to merge with the service provider request - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionId -Import sessionId for manual select and view user - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort -Sort users by supported fields - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortOrder -. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IImportUsersResponse - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkday.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkday.md deleted file mode 100644 index 16a9f7dd9..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkday.md +++ /dev/null @@ -1,297 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkday.md -schema: 2.0.0 ---- - -# Import-JcSdkWorkday - -## SYNOPSIS -The endpoint allows you to import a Workday Import request. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '[ -\t{ -\t\t\"email\":\"{email}\", -\t\t\"firstname\":\"{firstname}\", -\t\t\"lastname\":\"{firstname}\", -\t\t\"username\":\"{username}\", -\t\t\"attributes\":[ -\t\t\t{\"name\":\"EmployeeID\",\"value\":\"0000\"}, -\t\t\t{\"name\":\"WorkdayID\",\"value\":\"name.name\"} -\t\t\t] -\t\t -\t} -] -``` - -## SYNTAX - -### Import (Default) -``` -Import-JcSdkWorkday -ConsoleHost -WorkdayId -Body > [-Confirm] - [-WhatIf] [] -``` - -### ImportViaIdentity -``` -Import-JcSdkWorkday -ConsoleHost -InputObject -Body > - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -The endpoint allows you to import a Workday Import request. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '[ -\t{ -\t\t\"email\":\"{email}\", -\t\t\"firstname\":\"{firstname}\", -\t\t\"lastname\":\"{firstname}\", -\t\t\"username\":\"{username}\", -\t\t\"attributes\":[ -\t\t\t{\"name\":\"EmployeeID\",\"value\":\"0000\"}, -\t\t\t{\"name\":\"WorkdayID\",\"value\":\"name.name\"} -\t\t\t] -\t\t -\t} -] -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Import-JcSdkWorkday -WorkdayId:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -Body -Array of bulk-user-create - -```yaml -Type: System.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserCreate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: ImportViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkdayId -. - -```yaml -Type: System.String -Parameter Sets: Import -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### System.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserCreate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IJobIdResult - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY >`: Array of bulk-user-create - - `[AccountLocked ]`: - - `[Activated ]`: - - `[Addresses >]`: - - `[Country ]`: - - `[ExtendedAddress ]`: - - `[Locality ]`: - - `[PoBox ]`: - - `[PostalCode ]`: - - `[Region ]`: - - `[StreetAddress ]`: - - `[Type ]`: - - `[AllowPublicKey ]`: - - `[AlternateEmail ]`: - - `[Attributes >]`: - - `[Name ]`: - - `[Value ]`: - - `[Company ]`: - - `[CostCenter ]`: - - `[DelegatedAuthorityId ]`: ObjectId of the target Active Directory connection - - `[DelegatedAuthorityName ]`: Authority name - - `[Department ]`: - - `[Description ]`: - - `[DisableDeviceMaxLoginAttempts ]`: - - `[Displayname ]`: - - `[Email ]`: - - `[EmployeeIdentifier ]`: Must be unique per user. - - `[EmployeeType ]`: - - `[EnableManagedUid ]`: - - `[EnableUserPortalMultifactor ]`: - - `[ExternalDn ]`: - - `[ExternalPasswordExpirationDate ]`: - - `[ExternalSourceType ]`: - - `[ExternallyManaged ]`: - - `[Firstname ]`: - - `[JobTitle ]`: - - `[Lastname ]`: - - `[LdapBindingUser ]`: - - `[Location ]`: - - `[ManagedAppleId ]`: - - `[Manager ]`: Relation with another systemuser to identify the last as a manager. - - `[MfaConfigured ]`: - - `[MfaExclusion ]`: - - `[MfaExclusionDays ]`: - - `[MfaExclusionUntil ]`: - - `[Middlename ]`: - - `[Password ]`: - - `[PasswordNeverExpires ]`: - - `[PasswordlessSudo ]`: - - `[PhoneNumbers >]`: - - `[Number ]`: - - `[Type ]`: - - `[PublicKey ]`: - - `[RecoveryEmailAddress ]`: - - `[Relationships >]`: - - `[Type ]`: - - `[Value ]`: - - `[RestrictedField ]`: - - `[RestrictedFieldId ]`: - - `[RestrictedFieldType ]`: - - `[SambaServiceUser ]`: - - `[State ]`: - - `[Sudo ]`: - - `[Suspended ]`: - - `[UnixGuid ]`: - - `[UnixUid ]`: - - `[Username ]`: - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkdayResult.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkdayResult.md deleted file mode 100644 index 50ec8465f..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkdayResult.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkdayResult.md -schema: 2.0.0 ---- - -# Import-JcSdkWorkdayResult - -## SYNOPSIS -This endpoint provides a list of job results from the workday import and will contain all imported data from Workday. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import/{ImportJobID}/results \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Import (Default) -``` -Import-JcSdkWorkdayResult -ConsoleHost -Id -JobId [] -``` - -### ImportViaIdentity -``` -Import-JcSdkWorkdayResult -ConsoleHost -InputObject [] -``` - -## DESCRIPTION -This endpoint provides a list of job results from the workday import and will contain all imported data from Workday. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import/{ImportJobID}/results \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Import-JcSdkWorkdayResult -Id:() -JobId:() -``` - ----- ---------- -CreatedAt String -Id String -Meta JumpCloud.SDK.V2.Models.JobWorkresultMeta -PersistedFields JumpCloud.SDK.V2.Models.JobWorkresultPersistedFields -Status String -StatusMsg String -UpdatedAt String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Import -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: ImportViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -JobId -. - -```yaml -Type: System.String -Parameter Sets: Import -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IJobWorkresult - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Invoke-JcSdkReclaimSoftwareAppLicense.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Invoke-JcSdkReclaimSoftwareAppLicense.md deleted file mode 100644 index 7bc65b8f8..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Invoke-JcSdkReclaimSoftwareAppLicense.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Invoke-JcSdkReclaimSoftwareAppLicense.md -schema: 2.0.0 ---- - -# Invoke-JcSdkReclaimSoftwareAppLicense - -## SYNOPSIS -This endpoint allows you to reclaim the licenses from a software app associated with devices that are deleted. -#### Sample Request -``` -$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/reclaim-licenses \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '{}' -``` - -## SYNTAX - -### Reclaim (Default) -``` -Invoke-JcSdkReclaimSoftwareAppLicense -ConsoleHost -SoftwareAppId [-Confirm] [-WhatIf] - [] -``` - -### ReclaimViaIdentity -``` -Invoke-JcSdkReclaimSoftwareAppLicense -ConsoleHost -InputObject [-Confirm] - [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to reclaim the licenses from a software app associated with devices that are deleted. -#### Sample Request -``` -$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/reclaim-licenses \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '{}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Invoke-JcSdkReclaimSoftwareAppLicense -SoftwareAppId:() -``` - ----- ---------- -AssignedLicenses Int -AvailableLicenses Int -ReclaimedLicenses Int -TotalLicenses Int - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: ReclaimViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SoftwareAppId -. - -```yaml -Type: System.String -Parameter Sets: Reclaim -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISoftwareAppReclaimLicenses - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/JumpCloud.SDK.V2.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/JumpCloud.SDK.V2.md deleted file mode 100644 index bffb87f68..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/JumpCloud.SDK.V2.md +++ /dev/null @@ -1,3316 +0,0 @@ ---- -Module Name: JumpCloud.SDK.V2 -Module Guid: ff397964-2121-4c89-a916-34b5c30d7187 -Download Help Link: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/jumpcloud.sdk.v2 -Help Version: 1.0.0.0 -Locale: en-US ---- - -# JumpCloud.SDK.V2 Module -## Description -The JumpCloud V2 PowerShell SDK - -## JumpCloud.SDK.V2 Cmdlets -### [Clear-JcSdkAppleMdmDevice](Clear-JcSdkAppleMdmDevice.md) -Erases a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/erase \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -### [Clear-JcSdkAppleMdmDeviceActivationLock](Clear-JcSdkAppleMdmDeviceActivationLock.md) -Clears the activation lock on the specified device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/clearActivationLock \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -### [Get-JcSdkAccessRequest](Get-JcSdkAccessRequest.md) -Endpoint that returns the workflow access request by id - -### [Get-JcSdkAccessRequestProgress](Get-JcSdkAccessRequestProgress.md) -Endpoint for getting the approval progress of a access request - -### [Get-JcSdkActiveDirectory](Get-JcSdkActiveDirectory.md) -This endpoint returns a specific Active Directory. - -#### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -### [Get-JcSdkActiveDirectoryAgent](Get-JcSdkActiveDirectoryAgent.md) -This endpoint returns an Active Directory agent. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkActiveDirectoryAssociation](Get-JcSdkActiveDirectoryAssociation.md) -This endpoint returns the direct associations of this Active Directory instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. - - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/associations?targets=user \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkActiveDirectoryTraverseUser](Get-JcSdkActiveDirectoryTraverseUser.md) -This endpoint will return all Users bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Active Directory instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Active Directory instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/users \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkActiveDirectoryTraverseUserGroup](Get-JcSdkActiveDirectoryTraverseUserGroup.md) -This endpoint will return all Users Groups bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Active Directory instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Active Directory instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/usergroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkAdministratorOrganization](Get-JcSdkAdministratorOrganization.md) -This endpoint returns the association links between an Administrator and Organizations. - -### [Get-JcSdkAdministratorOrganizationLink](Get-JcSdkAdministratorOrganizationLink.md) -This endpoint returns the association links between an Organization and Administrators. - -### [Get-JcSdkAppleMdm](Get-JcSdkAppleMdm.md) -Get a list of all Apple MDM configurations. -An empty topic indicates that a signed certificate from Apple has not been provided to the PUT endpoint yet. - -Note: currently only one MDM configuration per organization is supported. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/applemdms \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkAppleMdmDevice](Get-JcSdkAppleMdmDevice.md) -Gets a single Apple MDM device. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ - -H 'accept: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkAppleMdmEnrollmentProfile](Get-JcSdkAppleMdmEnrollmentProfile.md) -Get a list of enrollment profiles for an apple mdm. - -Note: currently only one enrollment profile is supported. - -#### Sample Request -``` - curl https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/enrollmentprofiles \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkApplicationAssociation](Get-JcSdkApplicationAssociation.md) -This endpoint will return the _direct_ associations of an Application. -A direct association can be a non-homogeneous relationship between 2 different objects, for example Applications and User Groups. - - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations?targets=user_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkApplicationTraverseUser](Get-JcSdkApplicationTraverseUser.md) -This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkApplicationTraverseUserGroup](Get-JcSdkApplicationTraverseUserGroup.md) -This endpoint will return all Users Groups bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Application to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Application. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/usergroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkApprovalFlow](Get-JcSdkApprovalFlow.md) -Endpoint for getting workflow by id - -### [Get-JcSdkApprovalFlowSetting](Get-JcSdkApprovalFlowSetting.md) -Endpoint for getting workflow settings for an organisation - -### [Get-JcSdkAuthenticationPolicy](Get-JcSdkAuthenticationPolicy.md) -Return a specific authentication policy. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkBulkUsersResult](Get-JcSdkBulkUsersResult.md) -This endpoint will return the results of particular user import or get job request. - -#### Sample Request -``` -curl -X GET \\ - https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -### [Get-JcSdkBulkUserState](Get-JcSdkBulkUserState.md) -The endpoint allows you to list scheduled statechange jobs. -#### Sample Request -``` -curl -X GET \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ - -H 'x-api-key: {API_KEY}' \\ - -H 'Content-Type: application/json' \\ - -H 'Accept: application/json' -``` - -### [Get-JcSdkCommandAssociation](Get-JcSdkCommandAssociation.md) -This endpoint will return the _direct_ associations of this Command. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations?targets=system_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkCommandTraverseSystem](Get-JcSdkCommandTraverseSystem.md) -This endpoint will return all Systems bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Command to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Command. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systems \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkCommandTraverseSystemGroup](Get-JcSdkCommandTraverseSystemGroup.md) -This endpoint will return all System Groups bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Command to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Command. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systemgroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkCustomEmailConfiguration](Get-JcSdkCustomEmailConfiguration.md) -Get the custom email configuration for the specified custom email type - -### [Get-JcSdkCustomEmailTemplate](Get-JcSdkCustomEmailTemplate.md) -Get the list of custom email templates - -### [Get-JcSdkDirectory](Get-JcSdkDirectory.md) -This endpoint returns all active directories (LDAP, O365 Suite, G-Suite). - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/directories \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkDuoAccount](Get-JcSdkDuoAccount.md) -This endpoint returns a specific Duo account. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkDuoApplication](Get-JcSdkDuoApplication.md) -This endpoint returns a specific Duo application that is associated with the specified Duo account. - -#### Sample Request -``` - curl https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkGroup](Get-JcSdkGroup.md) -This endpoint returns all Groups that exist in your organization. - -#### Available filter fields: - - `name` - - `disabled` - - `type` - - `memberQueryErrorFlags` - -#### Sample Request - -``` - curl -X GET \\ - https://console.jumpcloud.com/api/v2/groups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkGSuite](Get-JcSdkGSuite.md) -This endpoint returns a specific G Suite. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkGSuiteAssociation](Get-JcSdkGSuiteAssociation.md) -This endpoint returns the _direct_ associations of this G Suite instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. - - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations?targets=user_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkGSuiteTranslationRule](Get-JcSdkGSuiteTranslationRule.md) -This endpoint returns a specific translation rule for a specific G Suite instance. -These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. - -###### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -### [Get-JcSdkGSuiteTraverseUser](Get-JcSdkGSuiteTraverseUser.md) -This endpoint will return all Users bound to a G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this G Suite instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this G Suite instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/users \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkGSuiteTraverseUserGroup](Get-JcSdkGSuiteTraverseUserGroup.md) -This endpoint will return all User Groups bound to an G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this G Suite instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this G Suite instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSuite_ID}/usergroups \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkGSuiteUsersToImport](Get-JcSdkGSuiteUsersToImport.md) -Lists G Suite users available for import. - -### [Get-JcSdkGsuiteUsersToImportFormatted](Get-JcSdkGsuiteUsersToImportFormatted.md) -Lists available G Suite users for import, translated to the Jumpcloud user schema. - -### [Get-JcSdkIPList](Get-JcSdkIPList.md) -Return a specific IP list. - -#### Sample Request -``` -curl https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkLdapServer](Get-JcSdkLdapServer.md) -This endpoint returns a specific LDAP server. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkLdapServerAssociation](Get-JcSdkLdapServerAssociation.md) -This endpoint returns the _direct_ associations of this LDAP Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. - -#### Sample Request - -``` - curl -X GET 'https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations?targets=user_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkLdapServerSambaDomain](Get-JcSdkLdapServerSambaDomain.md) -This endpoint returns a specific samba domain for an LDAP server. - -##### Sample Request -``` -curl -X GET \\ - https://console.jumpcloud.com/api/v2/ldapservers/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -### [Get-JcSdkLdapServerTraverseUser](Get-JcSdkLdapServerTraverseUser.md) -This endpoint will return all Users bound to an LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this LDAP server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this LDAP server instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkLdapServerTraverseUserGroup](Get-JcSdkLdapServerTraverseUserGroup.md) -This endpoint will return all Users Groups bound to a LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this LDAP server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this LDAP server instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkNextScheduledBulkUserState](Get-JcSdkNextScheduledBulkUserState.md) -This endpoint is used to lookup the next upcoming scheduled state change for each user in the -given list. -The users parameter is limited to 100 items per request. -The results are also limited -to 100 items. -This endpoint returns a max of 1 event per state per user. -For example, if a user -has 3 ACTIVATED events scheduled it will return the next upcoming activation event. -However, if a -user also has a SUSPENDED event scheduled along with the ACTIVATED events it will return the next -upcoming activation event _and_ the next upcoming suspension event. - -### [Get-JcSdkOffice365](Get-JcSdkOffice365.md) -This endpoint returns a specific Office 365 instance. - -##### - -Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkOffice365Association](Get-JcSdkOffice365Association.md) -This endpoint returns _direct_ associations of an Office 365 instance. - - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations?targets=user_group' \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkOffice365TranslationRule](Get-JcSdkOffice365TranslationRule.md) -This endpoint returns a specific translation rule for a specific Office 365 instance. -These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. - -###### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -### [Get-JcSdkOffice365TraverseUser](Get-JcSdkOffice365TraverseUser.md) -This endpoint will return all Users bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Office 365 instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Office 365 instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkOffice365TraverseUserGroup](Get-JcSdkOffice365TraverseUserGroup.md) -This endpoint will return all Users Groups bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Office 365 instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Office 365 instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkOffice365UsersToImport](Get-JcSdkOffice365UsersToImport.md) -Lists Office 365 users available for import. - -### [Get-JcSdkOrganizationPolicyResult](Get-JcSdkOrganizationPolicyResult.md) -This endpoint returns all policy results for an organization. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -### [Get-JcSdkPolicy](Get-JcSdkPolicy.md) -This endpoint returns a specific policy. - -###### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/policies/{PolicyID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -### [Get-JcSdkPolicyAssociation](Get-JcSdkPolicyAssociation.md) -This endpoint returns the _direct_ associations of a Policy. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. - -#### Sample Request -``` -curl -X GET 'https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations?targets=system_group \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkPolicyGroup](Get-JcSdkPolicyGroup.md) -This endpoint returns the details of a Policy Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkPolicyGroupAssociation](Get-JcSdkPolicyGroupAssociation.md) -This endpoint returns the _direct_ associations of this Policy Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations?targets=system \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkPolicyGroupMember](Get-JcSdkPolicyGroupMember.md) -This endpoint returns all the Policy Groups a Policy is a member of. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/memberof \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkPolicyGroupMembership](Get-JcSdkPolicyGroupMembership.md) -This endpoint returns all Policy members that are a member of this Policy Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/membership \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkPolicyGroupTraverseSystem](Get-JcSdkPolicyGroupTraverseSystem.md) -This endpoint will return all Systems bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Policy Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systems \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkPolicyGroupTraverseSystemGroup](Get-JcSdkPolicyGroupTraverseSystemGroup.md) -This endpoint will return all System Groups bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Policy Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkPolicyResult](Get-JcSdkPolicyResult.md) -This endpoint will return the policy results for a specific policy. - -##### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policyresults/{Policy_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -### [Get-JcSdkPolicyStatus](Get-JcSdkPolicyStatus.md) -This endpoint returns the latest policy results for a specific policy. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -### [Get-JcSdkPolicyTemplate](Get-JcSdkPolicyTemplate.md) -This endpoint returns a specific policy template. - -#### Sample Request -``` - curl -X GET https://console.jumpcloud.com/api/v2/policytemplates/{Policy_Template_ID}\\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkPolicyTraverseSystem](Get-JcSdkPolicyTraverseSystem.md) -This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkPolicyTraverseSystemGroup](Get-JcSdkPolicyTraverseSystemGroup.md) -This endpoint will return all Systems Groups bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Policy to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkProviderAdministrator](Get-JcSdkProviderAdministrator.md) -This endpoint returns a list of the Administrators associated with the Provider. -You must be associated with the provider to use this route. - -### [Get-JcSdkProviderOrganization](Get-JcSdkProviderOrganization.md) -This endpoint returns a list of the Organizations associated with the Provider. -You must be associated with the provider to use this route. - -### [Get-JcSdkProvidersInvoice](Get-JcSdkProvidersInvoice.md) -Retrieves a list of invoices for this provider. -You must be associated to the provider to use this endpoint. - -### [Get-JcSdkRadiusServerAssociation](Get-JcSdkRadiusServerAssociation.md) -This endpoint returns the _direct_ associations of a Radius Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations?targets=user_group \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkRadiusServerTraverseUser](Get-JcSdkRadiusServerTraverseUser.md) -This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. - -See `/members` and `/associations` endpoints to manage those collections. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -### [Get-JcSdkRadiusServerTraverseUserGroup](Get-JcSdkRadiusServerTraverseUserGroup.md) -This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkSoftwareApp](Get-JcSdkSoftwareApp.md) -Retrieves a Software Application. -The optional isConfigEnabled and appConfiguration apple_vpp attributes are populated in this response. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkSoftwareAppAssociation](Get-JcSdkSoftwareAppAssociation.md) -This endpoint will return the _direct_ associations of a Software Application. -A direct association can be a non-homogeneous relationship between 2 different objects, for example Software Application and System Groups. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations?targets=system_group \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkSoftwareAppStatus](Get-JcSdkSoftwareAppStatus.md) -This endpoint allows you to get the status of the provided Software Application on associated JumpCloud systems. - -#### Sample Request -``` -$ curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/statuses \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ -``` - -### [Get-JcSdkSoftwareAppTraverseSystem](Get-JcSdkSoftwareAppTraverseSystem.md) -This endpoint will return all Systems bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Software App to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Software App. - -See `/associations` endpoint to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systems \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkSoftwareAppTraverseSystemGroup](Get-JcSdkSoftwareAppTraverseSystemGroup.md) -This endpoint will return all Systems Groups bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this Software App to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Software App. - -See `/associations` endpoint to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkSubscription](Get-JcSdkSubscription.md) -This endpoint returns all pricing & packaging subscriptions. - -##### Sample Request - -``` - curl -X GET https://console.jumpcloud.com/api/v2/subscriptions \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -### [Get-JcSdkSystemAssociation](Get-JcSdkSystemAssociation.md) -This endpoint returns the _direct_ associations of a System. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations?targets=user \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkSystemFdeKey](Get-JcSdkSystemFdeKey.md) -This endpoint will return the current (latest) fde key saved for a system. - -### [Get-JcSdkSystemGroup](Get-JcSdkSystemGroup.md) -This endpoint returns the details of a System Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkSystemGroupAssociation](Get-JcSdkSystemGroupAssociation.md) -This endpoint returns the _direct_ associations of a System Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations?targets=user \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkSystemGroupMember](Get-JcSdkSystemGroupMember.md) -This endpoint returns the system members of a System Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkSystemGroupMembership](Get-JcSdkSystemGroupMembership.md) -This endpoint returns all Systems that are a member of this System Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID/membership \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkSystemGroupTraverseCommand](Get-JcSdkSystemGroupTraverseCommand.md) -This endpoint will return all Commands bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the group's type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/commands \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkSystemGroupTraversePolicy](Get-JcSdkSystemGroupTraversePolicy.md) -This endpoint will return all Policies bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -This endpoint is not public yet as we haven't finished the code. - -##### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policies \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkSystemGroupTraversePolicyGroup](Get-JcSdkSystemGroupTraversePolicyGroup.md) -This endpoint will return all Policy Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policygroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkSystemGroupTraverseUser](Get-JcSdkSystemGroupTraverseUser.md) -This endpoint will return all Users bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkSystemGroupTraverseUserGroup](Get-JcSdkSystemGroupTraverseUserGroup.md) -This endpoint will return all User Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System Group to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkSystemInsightAlf](Get-JcSdkSystemInsightAlf.md) -Valid filter fields are `system_id` and `global_state`. - -### [Get-JcSdkSystemInsightAlfException](Get-JcSdkSystemInsightAlfException.md) -Valid filter fields are `system_id` and `state`. - -### [Get-JcSdkSystemInsightAlfExplicitAuth](Get-JcSdkSystemInsightAlfExplicitAuth.md) -Valid filter fields are `system_id` and `process`. - -### [Get-JcSdkSystemInsightApp](Get-JcSdkSystemInsightApp.md) -Lists all apps for macOS devices. -For Windows devices, use [List System Insights Programs](#operation/systeminsights_list_programs). - -Valid filter fields are `system_id` and `bundle_name`. - -### [Get-JcSdkSystemInsightAppCompatShim](Get-JcSdkSystemInsightAppCompatShim.md) -Valid filter fields are `system_id` and `enabled`. - -### [Get-JcSdkSystemInsightAuthorizedKey](Get-JcSdkSystemInsightAuthorizedKey.md) -Valid filter fields are `system_id` and `uid`. - -### [Get-JcSdkSystemInsightAzureInstanceMetadata](Get-JcSdkSystemInsightAzureInstanceMetadata.md) -Valid filter fields are `system_id`. - -### [Get-JcSdkSystemInsightAzureInstanceTag](Get-JcSdkSystemInsightAzureInstanceTag.md) -Valid filter fields are `system_id`. - -### [Get-JcSdkSystemInsightBattery](Get-JcSdkSystemInsightBattery.md) -Valid filter fields are `system_id` and `health`. - -### [Get-JcSdkSystemInsightBitlockerInfo](Get-JcSdkSystemInsightBitlockerInfo.md) -Valid filter fields are `system_id` and `protection_status`. - -### [Get-JcSdkSystemInsightBrowserPlugin](Get-JcSdkSystemInsightBrowserPlugin.md) -Valid filter fields are `system_id` and `name`. - -### [Get-JcSdkSystemInsightCertificate](Get-JcSdkSystemInsightCertificate.md) -Valid filter fields are `system_id` and `common_name`. - -### [Get-JcSdkSystemInsightChassisInfo](Get-JcSdkSystemInsightChassisInfo.md) -Valid filter fields are `system_id`. - -### [Get-JcSdkSystemInsightChromeExtension](Get-JcSdkSystemInsightChromeExtension.md) -Valid filter fields are `system_id` and `name`. - -### [Get-JcSdkSystemInsightConnectivity](Get-JcSdkSystemInsightConnectivity.md) -The only valid filter field is `system_id`. - -### [Get-JcSdkSystemInsightCrash](Get-JcSdkSystemInsightCrash.md) -Valid filter fields are `system_id` and `identifier`. - -### [Get-JcSdkSystemInsightCupDestination](Get-JcSdkSystemInsightCupDestination.md) -Valid filter fields are `system_id` and `name`. - -### [Get-JcSdkSystemInsightDiskEncryption](Get-JcSdkSystemInsightDiskEncryption.md) -Valid filter fields are `system_id` and `encryption_status`. - -### [Get-JcSdkSystemInsightDiskInfo](Get-JcSdkSystemInsightDiskInfo.md) -Valid filter fields are `system_id` and `disk_index`. - -### [Get-JcSdkSystemInsightDnsResolver](Get-JcSdkSystemInsightDnsResolver.md) -Valid filter fields are `system_id` and `type`. - -### [Get-JcSdkSystemInsightEtcHost](Get-JcSdkSystemInsightEtcHost.md) -Valid filter fields are `system_id` and `address`. - -### [Get-JcSdkSystemInsightFirefoxAddon](Get-JcSdkSystemInsightFirefoxAddon.md) -Valid filter fields are `system_id` and `name`. - -### [Get-JcSdkSystemInsightGroup](Get-JcSdkSystemInsightGroup.md) -Valid filter fields are `system_id` and `groupname`. - -### [Get-JcSdkSystemInsightIeExtension](Get-JcSdkSystemInsightIeExtension.md) -Valid filter fields are `system_id` and `name`. - -### [Get-JcSdkSystemInsightInterfaceAddress](Get-JcSdkSystemInsightInterfaceAddress.md) -Valid filter fields are `system_id` and `address`. - -### [Get-JcSdkSystemInsightInterfaceDetail](Get-JcSdkSystemInsightInterfaceDetail.md) -Valid filter fields are `system_id` and `interface`. - -### [Get-JcSdkSystemInsightKernelInfo](Get-JcSdkSystemInsightKernelInfo.md) -Valid filter fields are `system_id` and `version`. - -### [Get-JcSdkSystemInsightLaunchd](Get-JcSdkSystemInsightLaunchd.md) -Valid filter fields are `system_id` and `name`. - -### [Get-JcSdkSystemInsightLinuxPackage](Get-JcSdkSystemInsightLinuxPackage.md) -Lists all programs for Linux devices. -For macOS devices, use [List System Insights System Apps](#operation/systeminsights_list_apps). -For windows devices, use [List System Insights System Apps](#operation/systeminsights_list_programs). - -Valid filter fields are `name` and `package_format`. - -### [Get-JcSdkSystemInsightLoggedinUser](Get-JcSdkSystemInsightLoggedinUser.md) -Valid filter fields are `system_id` and `user`. - -### [Get-JcSdkSystemInsightLogicalDrive](Get-JcSdkSystemInsightLogicalDrive.md) -Valid filter fields are `system_id` and `device_id`. - -### [Get-JcSdkSystemInsightManagedPolicy](Get-JcSdkSystemInsightManagedPolicy.md) -Valid filter fields are `system_id` and `domain`. - -### [Get-JcSdkSystemInsightMount](Get-JcSdkSystemInsightMount.md) -Valid filter fields are `system_id` and `path`. - -### [Get-JcSdkSystemInsightOSVersion](Get-JcSdkSystemInsightOSVersion.md) -Valid filter fields are `system_id` and `version`. - -### [Get-JcSdkSystemInsightPatch](Get-JcSdkSystemInsightPatch.md) -Valid filter fields are `system_id` and `hotfix_id`. - -### [Get-JcSdkSystemInsightProgram](Get-JcSdkSystemInsightProgram.md) -Lists all programs for Windows devices. -For macOS devices, use [List System Insights Apps](#operation/systeminsights_list_apps). - -Valid filter fields are `system_id` and `name`. - -### [Get-JcSdkSystemInsightPythonPackage](Get-JcSdkSystemInsightPythonPackage.md) -Valid filter fields are `system_id` and `name`. - -### [Get-JcSdkSystemInsightSafariExtension](Get-JcSdkSystemInsightSafariExtension.md) -Valid filter fields are `system_id` and `name`. - -### [Get-JcSdkSystemInsightScheduledTask](Get-JcSdkSystemInsightScheduledTask.md) -Valid filter fields are `system_id` and `enabled`. - -### [Get-JcSdkSystemInsightSecureboot](Get-JcSdkSystemInsightSecureboot.md) -Valid filter fields are `system_id`. - -### [Get-JcSdkSystemInsightService](Get-JcSdkSystemInsightService.md) -Valid filter fields are `system_id` and `name`. - -### [Get-JcSdkSystemInsightShadow](Get-JcSdkSystemInsightShadow.md) -Valid filter fields are `system_id` and `username`. - -### [Get-JcSdkSystemInsightSharedFolder](Get-JcSdkSystemInsightSharedFolder.md) -Valid filter fields are `system_id` and `name`. - -### [Get-JcSdkSystemInsightSharedResource](Get-JcSdkSystemInsightSharedResource.md) -Valid filter fields are `system_id` and `type`. - -### [Get-JcSdkSystemInsightSharingPreference](Get-JcSdkSystemInsightSharingPreference.md) -Only valid filed field is `system_id`. - -### [Get-JcSdkSystemInsightSipConfig](Get-JcSdkSystemInsightSipConfig.md) -Valid filter fields are `system_id` and `enabled`. - -### [Get-JcSdkSystemInsightStartupItem](Get-JcSdkSystemInsightStartupItem.md) -Valid filter fields are `system_id` and `name`. - -### [Get-JcSdkSystemInsightSystemControl](Get-JcSdkSystemInsightSystemControl.md) -Valid filter fields are `system_id` and `name`. - -### [Get-JcSdkSystemInsightSystemInfo](Get-JcSdkSystemInsightSystemInfo.md) -Valid filter fields are `system_id` and `cpu_subtype`. - -### [Get-JcSdkSystemInsightTpmInfo](Get-JcSdkSystemInsightTpmInfo.md) -Valid filter fields are `system_id`. - -### [Get-JcSdkSystemInsightUptime](Get-JcSdkSystemInsightUptime.md) -Valid filter fields are `system_id` and `days`. - -### [Get-JcSdkSystemInsightUsbDevice](Get-JcSdkSystemInsightUsbDevice.md) -Valid filter fields are `system_id` and `model`. - -### [Get-JcSdkSystemInsightUser](Get-JcSdkSystemInsightUser.md) -Valid filter fields are `system_id` and `username`. - -### [Get-JcSdkSystemInsightUserAssist](Get-JcSdkSystemInsightUserAssist.md) -Valid filter fields are `system_id`. - -### [Get-JcSdkSystemInsightUserGroup](Get-JcSdkSystemInsightUserGroup.md) -Only valid filter field is `system_id`. - -### [Get-JcSdkSystemInsightUserSshKey](Get-JcSdkSystemInsightUserSshKey.md) -Valid filter fields are `system_id` and `uid`. - -### [Get-JcSdkSystemInsightWifiNetwork](Get-JcSdkSystemInsightWifiNetwork.md) -Valid filter fields are `system_id` and `security_type`. - -### [Get-JcSdkSystemInsightWifiStatus](Get-JcSdkSystemInsightWifiStatus.md) -Valid filter fields are `system_id` and `security_type`. - -### [Get-JcSdkSystemInsightWindowsSecurityCenter](Get-JcSdkSystemInsightWindowsSecurityCenter.md) -Valid filter fields are `system_id`. - -### [Get-JcSdkSystemInsightWindowsSecurityProduct](Get-JcSdkSystemInsightWindowsSecurityProduct.md) -Valid filter fields are `system_id` and `state`. - -### [Get-JcSdkSystemMember](Get-JcSdkSystemMember.md) -This endpoint returns all the System Groups a System is a member of. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/memberof \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkSystemPolicyStatus](Get-JcSdkSystemPolicyStatus.md) -This endpoint returns the policy results for a particular system. - -##### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkSystemTraverseCommand](Get-JcSdkSystemTraverseCommand.md) -This endpoint will return all Commands bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/commands \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkSystemTraversePolicy](Get-JcSdkSystemTraversePolicy.md) -This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -This endpoint is not yet public as we have finish the code. - -##### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkSystemTraversePolicyGroup](Get-JcSdkSystemTraversePolicyGroup.md) -This endpoint will return all Policy Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policygroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkSystemTraverseUser](Get-JcSdkSystemTraverseUser.md) -This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkSystemTraverseUserGroup](Get-JcSdkSystemTraverseUserGroup.md) -This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkUserAssociation](Get-JcSdkUserAssociation.md) -This endpoint returns the _direct_ associations of a User. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/associations?targets=system_group \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkUserGroup](Get-JcSdkUserGroup.md) -This endpoint returns the details of a User Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserGroupAssociation](Get-JcSdkUserGroupAssociation.md) -This endpoint returns the _direct_ associations of this User Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. - - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations?targets=system \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserGroupMember](Get-JcSdkUserGroupMember.md) -This endpoint returns the user members of a User Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserGroupMembership](Get-JcSdkUserGroupMembership.md) -This endpoint returns all users members that are a member of this User Group. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/membership \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserGroupTraverseActiveDirectory](Get-JcSdkUserGroupTraverseActiveDirectory.md) -This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserGroupTraverseApplication](Get-JcSdkUserGroupTraverseApplication.md) -This endpoint will return all Applications bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/applications \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserGroupTraverseDirectory](Get-JcSdkUserGroupTraverseDirectory.md) -This endpoint will return all Directories bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directories from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/directories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkUserGroupTraverseGSuite](Get-JcSdkUserGroupTraverseGSuite.md) -This endpoint will return all G Suite Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID/gsuites \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkUserGroupTraverseLdapServer](Get-JcSdkUserGroupTraverseLdapServer.md) -This endpoint will return all LDAP Servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/ldapservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserGroupTraverseOffice365](Get-JcSdkUserGroupTraverseOffice365.md) -This endpoint will return all Office 365 instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/office365s \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserGroupTraverseRadiusServer](Get-JcSdkUserGroupTraverseRadiusServer.md) -This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Get-JcSdkUserGroupTraverseSystem](Get-JcSdkUserGroupTraverseSystem.md) -This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserGroupTraverseSystemGroup](Get-JcSdkUserGroupTraverseSystemGroup.md) -This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserMember](Get-JcSdkUserMember.md) -This endpoint returns all the User Groups a User is a member of. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/memberof \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserPushEndpoint](Get-JcSdkUserPushEndpoint.md) -This endpoint will retrieve a push endpoint associated with a user. - -### [Get-JcSdkUserTraverseActiveDirectory](Get-JcSdkUserTraverseActiveDirectory.md) -This endpoint will return all Active Directory Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Active Directory instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory instance from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/activedirectories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserTraverseApplication](Get-JcSdkUserTraverseApplication.md) -This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserTraverseDirectory](Get-JcSdkUserTraverseDirectory.md) -This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserTraverseGSuite](Get-JcSdkUserTraverseGSuite.md) -This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserTraverseLdapServer](Get-JcSdkUserTraverseLdapServer.md) -This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserTraverseOffice365](Get-JcSdkUserTraverseOffice365.md) -This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserTraverseRadiusServer](Get-JcSdkUserTraverseRadiusServer.md) -This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserTraverseSystem](Get-JcSdkUserTraverseSystem.md) -This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkUserTraverseSystemGroup](Get-JcSdkUserTraverseSystemGroup.md) -This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. - -Each element will contain the type, id, attributes and paths. - -The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. - -The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. - -See `/members` and `/associations` endpoints to manage those collections. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Get-JcSdkWorkday](Get-JcSdkWorkday.md) -This endpoint will return all the available information about an instance of Workday. - -#### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/workdays/ \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -### [Get-JcSdkWorkdayWorker](Get-JcSdkWorkdayWorker.md) -This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. - -##### Sample Request - -``` -curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - - -``` - -### [Grant-JcSdkWorkday](Grant-JcSdkWorkday.md) -This endpoint adds an authorization method to a workday instance. - -You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. -Failure to provide these credentials will result in the request being rejected. - -Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ -\t\"auth\":{ -\t \"basic\": { -\t\t\"username\": \"someDeveloper\",\t -\t\t\"password\": \"notTheRealPassword\" - -\t } -\t} -}' - -``` - -### [Import-JcSdkScim](Import-JcSdkScim.md) -Get a list of users to import from an Application IdM service provider. - -### [Import-JcSdkWorkday](Import-JcSdkWorkday.md) -The endpoint allows you to import a Workday Import request. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '[ -\t{ -\t\t\"email\":\"{email}\", -\t\t\"firstname\":\"{firstname}\", -\t\t\"lastname\":\"{firstname}\", -\t\t\"username\":\"{username}\", -\t\t\"attributes\":[ -\t\t\t{\"name\":\"EmployeeID\",\"value\":\"0000\"}, -\t\t\t{\"name\":\"WorkdayID\",\"value\":\"name.name\"} -\t\t\t] -\t\t -\t} -] -``` - -### [Import-JcSdkWorkdayResult](Import-JcSdkWorkdayResult.md) -This endpoint provides a list of job results from the workday import and will contain all imported data from Workday. - -#### Sample Request -``` -curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import/{ImportJobID}/results \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Invoke-JcSdkReclaimSoftwareAppLicense](Invoke-JcSdkReclaimSoftwareAppLicense.md) -This endpoint allows you to reclaim the licenses from a software app associated with devices that are deleted. -#### Sample Request -``` -$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/reclaim-licenses \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '{}' -``` - -### [Lock-JcSdkAppleMdmDevice](Lock-JcSdkAppleMdmDevice.md) -Locks a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/lock \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -### [New-JcSdkActiveDirectory](New-JcSdkActiveDirectory.md) -This endpoint allows you to create a new Active Directory. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/ \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"domain\": \"{DC=AD_domain_name;DC=com}\" - }' -``` - -### [New-JcSdkActiveDirectoryAgent](New-JcSdkActiveDirectoryAgent.md) -This endpoint allows you to create a new Active Directory Agent. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ \"agent_type\":\"{SYNC}\" }' -``` - -### [New-JcSdkAdministratorOrganization](New-JcSdkAdministratorOrganization.md) -This endpoint allows you to grant Administrator access to an Organization. - -### [New-JcSdkApprovalFlow](New-JcSdkApprovalFlow.md) -Endpoint for adding a new access workflow - -### [New-JcSdkAuthenticationPolicy](New-JcSdkAuthenticationPolicy.md) -Create an authentication policy. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/authn/policies \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Sample Policy\", - \"disabled\": false, - \"effect\": { - \"action\": \"allow\" - }, - \"targets\": { - \"users\": { - \"inclusions\": [\"ALL\"] - }, - \"userGroups\": { - \"exclusions\": [{USER_GROUP_ID}] - }, - \"resources\": [ {\"type\": \"user_portal\" } ] - }, - \"conditions\":{ - \"ipAddressIn\": [{IP_LIST_ID}] - } - }' -``` - -### [New-JcSdkBulkUser](New-JcSdkBulkUser.md) -The endpoint allows you to create a bulk job to asynchronously create users. -See [create a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_post) -for the full list of attributes. - -#### Default User State -The `state` of each user in the request can be explicitly passed in or -omitted. -If `state` is omitted, then the user will get created -using the value returned from the -[Get an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organizations_get) -endpoint. -The default user state for bulk created users depends on the -`creation-source` header. -For `creation-source:jumpcloud:bulk` the -default state is stored in `settings.newSystemUserStateDefaults.csvImport`. -For other `creation-source` header values, the default state is stored in -`settings.newSystemUserStateDefaults.applicationImport` - -These default state values can be changed in the admin portal settings -or by using the -[create an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organization_put) -endpoint. - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '[ - { - \"email\":\"{email}\", - \"firstname\":\"{firstname}\", - \"lastname\":\"{firstname}\", - \"username\":\"{username}\", - \"attributes\":[ - { - \"name\":\"EmployeeID\", - \"value\":\"0000\" - }, - { - \"name\":\"Custom\", - \"value\":\"attribute\" - } - ] - } -]' -``` - -### [New-JcSdkBulkUserState](New-JcSdkBulkUserState.md) -This endpoint allows you to create scheduled statechange jobs. -#### Sample Request -``` -curl -X POST \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ - -H 'x-api-key: {API_KEY}' \\ - -H 'Content-Type: application/json' \\ - -H 'Accept: application/json' \\ - -d '{ - \"user_ids\": [\"{User_ID_1}\", \"{User_ID_2}\", \"{User_ID_3}\"], - \"state\": \"SUSPENDED\", - \"start_date\": \"2000-01-01T00:00:00.000Z\" - }' -``` - -### [New-JcSdkCustomEmailConfiguration](New-JcSdkCustomEmailConfiguration.md) -Create the custom email configuration for the specified custom email type. - -This action is only available to paying customers. - -### [New-JcSdkDuoAccount](New-JcSdkDuoAccount.md) -Registers a Duo account for an organization. -Only one Duo account will be allowed, -in case an organization has a Duo account already a 409 (Conflict) code will be returned. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -### [New-JcSdkDuoApplication](New-JcSdkDuoApplication.md) -Create a Duo application for your organization and the specified account. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Application Name\", - \"apiHost\": \"api-1234.duosecurity.com\", - \"integrationKey\": \"1234\", - \"secretKey\": \"5678\" - }' -``` - -### [New-JcSdkGSuiteTranslationRule](New-JcSdkGSuiteTranslationRule.md) -This endpoint allows you to create a translation rule for a specific G Suite instance. -These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Translation Rule Parameters} - }' -``` - -### [New-JcSdkIPList](New-JcSdkIPList.md) -Create an IP list. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/iplists \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Sample IP List\", - \"ips\": [ - \"192.168.10.12\", - \"192.168.10.20 - 192.168.10.30\", - \"123.225.10.0/32\" - ] - }' -``` - -### [New-JcSdkLdapServerSambaDomain](New-JcSdkLdapServerSambaDomain.md) -This endpoint allows you to create a samba domain for an LDAP server. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"sid\":\"{SID_ID}\", - \"name\":\"{WORKGROUP_NAME}\" - }' -``` - -### [New-JcSdkOffice365TranslationRule](New-JcSdkOffice365TranslationRule.md) -This endpoint allows you to create a translation rule for a specific Office 365 instance. -These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Translation Rule Parameters} - }' -``` - -### [New-JcSdkPolicy](New-JcSdkPolicy.md) -This endpoint allows you to create a policy. -Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policies \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Policy_Parameters} - }' -``` - -### [New-JcSdkPolicyGroup](New-JcSdkPolicyGroup.md) -This endpoint allows you to create a new Policy Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policygroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"{Group_Name}\" - }' -``` - -### [New-JcSdkProviderAdministrator](New-JcSdkProviderAdministrator.md) -This endpoint allows you to create a provider administrator. -You must be associated with the provider to use this route. -You must provide either `role` or `roleName`. - -### [New-JcSdkSoftwareApp](New-JcSdkSoftwareApp.md) -This endpoint allows you to create a Software Application that will be managed by JumpCloud on associated JumpCloud systems. -The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. - -#### Sample Request -``` -$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '{ - \"displayName\": \"Adobe Reader\", - \"settings\": [{\"packageId\": \"adobereader\"}] -}' -``` - -### [New-JcSdkSystemGroup](New-JcSdkSystemGroup.md) -This endpoint allows you to create a new System Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"{Group_Name}\" - }' -``` - -### [New-JcSdkUserGroup](New-JcSdkUserGroup.md) -This endpoint allows you to create a new User Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"{Group_Name}\" - }' -``` - -### [New-JcSdkWorkday](New-JcSdkWorkday.md) -This endpoint allows you to create a new workday instance. - -You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. -Failure to provide these credentials will result in the request being rejected. - -Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. - -Currently, only one instance is allowed and it must be `Workday Import`. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Workday2\", - \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", - \"auth\": { - \"basic\": { - \"username\": \"someDeveloper\", - \"password\": \"notTheRealPassword\" - } - } - }' -``` - -### [Remove-JcSdkActiveDirectory](Remove-JcSdkActiveDirectory.md) -This endpoint allows you to delete an Active Directory Instance. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -### [Remove-JcSdkActiveDirectoryAgent](Remove-JcSdkActiveDirectoryAgent.md) -This endpoint deletes an Active Directory agent. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Remove-JcSdkAdministratorOrganization](Remove-JcSdkAdministratorOrganization.md) -This endpoint removes the association link between an Administrator and an Organization. - -### [Remove-JcSdkAppleMdm](Remove-JcSdkAppleMdm.md) -Removes an Apple MDM configuration. - -Warning: This is a destructive operation and will remove your Apple Push Certificates. -We will no longer be able to manage your devices and the only recovery option is to re-register all devices into MDM. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Remove-JcSdkAppleMdmDevice](Remove-JcSdkAppleMdmDevice.md) -Remove a single Apple MDM device from MDM enrollment. - -#### Sample Request -``` - curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ - -H 'accept: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Remove-JcSdkApplicationLogo](Remove-JcSdkApplicationLogo.md) -Deletes the specified image from an application - -### [Remove-JcSdkApprovalFlow](Remove-JcSdkApprovalFlow.md) -Endpoint for deleting accessworkflow by id - -### [Remove-JcSdkAuthenticationPolicy](Remove-JcSdkAuthenticationPolicy.md) -Delete the specified authentication policy. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Remove-JcSdkBulkUserState](Remove-JcSdkBulkUserState.md) -This endpoint deletes a scheduled statechange job. -#### Sample Request -``` -curl -X DELETE \"https://console.jumpcloud.com/api/v2/bulk/userstates/{ScheduledJob_ID}\" \\ - -H 'x-api-key: {API_KEY}' \\ - -H 'Content-Type: application/json' \\ - -H 'Accept: application/json' -``` - -### [Remove-JcSdkCustomEmailConfiguration](Remove-JcSdkCustomEmailConfiguration.md) -Delete the custom email configuration for the specified custom email type - -### [Remove-JcSdkDuoAccount](Remove-JcSdkDuoAccount.md) -Removes the specified Duo account, an error will be returned if the account has some Duo application used in a protected resource. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Remove-JcSdkDuoApplication](Remove-JcSdkDuoApplication.md) -Deletes the specified Duo application, an error will be returned if the application is used in a protected resource. - -#### Sample Request -``` - curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}'' -``` - -### [Remove-JcSdkGSuiteTranslationRule](Remove-JcSdkGSuiteTranslationRule.md) -This endpoint allows you to delete a translation rule for a specific G Suite instance. -These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. - -#### Sample Request - -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -### [Remove-JcSdkIPList](Remove-JcSdkIPList.md) -Delete a specific IP list. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Remove-JcSdkLdapServerSambaDomain](Remove-JcSdkLdapServerSambaDomain.md) -This endpoint allows you to delete a samba domain from an LDAP server. - -##### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Remove-JcSdkOffice365TranslationRule](Remove-JcSdkOffice365TranslationRule.md) -This endpoint allows you to delete a translation rule for a specific Office 365 instance. -These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. - -#### Sample Request - -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -### [Remove-JcSdkPolicy](Remove-JcSdkPolicy.md) -This endpoint allows you to delete a policy. - -#### Sample Request - -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/policies/5a837ecd232e110d4291e6b9 \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -### [Remove-JcSdkPolicyGroup](Remove-JcSdkPolicyGroup.md) -This endpoint allows you to delete a Policy Group. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Remove-JcSdkProviderAdministrator](Remove-JcSdkProviderAdministrator.md) -This endpoint removes an Administrator associated with the Provider. -You must be associated with the provider to use this route. - -### [Remove-JcSdkSoftwareApp](Remove-JcSdkSoftwareApp.md) -Removes a Software Application configuration. - -Warning: This is a destructive operation and will unmanage the application on all affected systems. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Remove-JcSdkSystemGroup](Remove-JcSdkSystemGroup.md) -This endpoint allows you to delete a System Group. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Remove-JcSdkUserGroup](Remove-JcSdkUserGroup.md) -This endpoint allows you to delete a User Group. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -### [Remove-JcSdkUserPushEndpoint](Remove-JcSdkUserPushEndpoint.md) -This endpoint will delete a push endpoint associated with a user. - -### [Remove-JcSdkWorkdayAuthorization](Remove-JcSdkWorkdayAuthorization.md) -Removes any and all authorization methods from the workday instance - -##### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -### [Restart-JcSdkAppleMdmDevice](Restart-JcSdkAppleMdmDevice.md) -Restarts a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/restart \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{\"kextPaths\": [\"Path1\", \"Path2\"]}' -``` - -### [Set-JcSdkAccessRequest](Set-JcSdkAccessRequest.md) -Endpoint that set the workflow access request by id - -### [Set-JcSdkAccessRequestApproval](Set-JcSdkAccessRequestApproval.md) -Endpoint for user approval - -### [Set-JcSdkActiveDirectoryAssociation](Set-JcSdkActiveDirectoryAssociation.md) -This endpoint allows you to manage the _direct_ associations of an Active Directory instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{AD_Instance_ID}/associations \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{User_ID}\" - }' -``` - -### [Set-JcSdkAppleMdm](Set-JcSdkAppleMdm.md) -Set an Apple MDM configuration. -This endpoint is used to supply JumpCloud with a signed certificate from Apple in order to finalize the setup and allow JumpCloud to manage your devices. -It may also be used to set the DEP Settings. - -#### Sample Request -``` - curl -X PUT https://console.jumpcloud.com/api/v2/applemdms/{ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"MDM name\", - \"appleSignedCert\": \"{CERTIFICATE}\", - \"encryptedDepServerToken\": \"{SERVER_TOKEN}\", - \"dep\": { - \"welcomeScreen\": { - \"title\": \"Welcome\", - \"paragraph\": \"In just a few steps, you will be working securely from your Mac.\", - \"button\": \"continue\", - }, - }, - }' -``` - -### [Set-JcSdkApplicationAssociation](Set-JcSdkApplicationAssociation.md) -This endpoint allows you to manage the _direct_ associations of an Application. -A direct association can be a non-homogeneous relationship between 2 different objects, for example Application and User Groups. - -#### Sample Request -``` -curl -X POST 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations' \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user_group\", - \"id\": \"{Group_ID}\" - }' -``` - -### [Set-JcSdkApprovalFlow](Set-JcSdkApprovalFlow.md) -Endpoint for updating a new access workflow - -### [Set-JcSdkApprovalFlowSetting](Set-JcSdkApprovalFlowSetting.md) -Endpoint for updating a access workflow settings for an organization - -### [Set-JcSdkCommandAssociation](Set-JcSdkCommandAssociation.md) -This endpoint will allow you to manage the _direct_ associations of this Command. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. - - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system_group\", - \"id\": \"Group_ID\" - }' -``` - -### [Set-JcSdkCustomEmailConfiguration](Set-JcSdkCustomEmailConfiguration.md) -Set the custom email configuration for the specified custom email type. - -This action is only available to paying customers. - -### [Set-JcSdkDuoApplication](Set-JcSdkDuoApplication.md) -Set the specified Duo application. - -#### Sample Request -``` - curl -X PUT https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Application Name\", - \"apiHost\": \"api-1234.duosecurity.com\", - \"integrationKey\": \"1234\", - \"secretKey\": \"5678\" - }' -``` - -### [Set-JcSdkGSuiteAssociation](Set-JcSdkGSuiteAssociation.md) -This endpoint returns the _direct_ associations of this G Suite instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user_group\", - \"id\": \"{Group_ID}\" - }' -``` - -### [Set-JcSdkIPList](Set-JcSdkIPList.md) -Replace a specific IP list. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Sample IP List\", - \"ips\": [ - \"192.168.10.10\" - ] - }' -``` - -### [Set-JcSdkLdapServerAssociation](Set-JcSdkLdapServerAssociation.md) -This endpoint allows you to manage the _direct_ associations of a LDAP Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{User_ID}\" - }' -``` - -### [Set-JcSdkLdapServerSambaDomain](Set-JcSdkLdapServerSambaDomain.md) -This endpoint allows you to set the samba domain information for an LDAP server. - -##### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"sid\":\"{SID_ID}\", - \"name\":\"{WORKGROUP_NAME}\" - }' -``` - -### [Set-JcSdkOffice365Association](Set-JcSdkOffice365Association.md) -This endpoint allows you to manage the _direct_ associations of a Office 365 instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user_group\", - \"id\": \"{Group_ID}\" - }' -``` - -### [Set-JcSdkPolicy](Set-JcSdkPolicy.md) -This endpoint allows you to set a policy. -Given the amount of configurable parameters required to set a Policy, we suggest you use the JumpCloud Admin Console to set new policies. - - -##### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/policies/59fced45c9118022172547ff \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Policy_Parameters} - }' -``` - -### [Set-JcSdkPolicyAssociation](Set-JcSdkPolicyAssociation.md) -This endpoint allows you to manage the _direct_ associations of a Policy. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations/ \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system_group\", - \"id\": \"{Group_ID}\" - }' -``` - -### [Set-JcSdkPolicyGroup](Set-JcSdkPolicyGroup.md) -This endpoint allows you to do a full set of the Policy Group. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/policygroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"group_set - }' -``` - -### [Set-JcSdkPolicyGroupAssociation](Set-JcSdkPolicyGroupAssociation.md) -This endpoint manages the _direct_ associations of this Policy Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system\", - \"id\": \"{SystemID}\" - }' -``` - -### [Set-JcSdkPolicyGroupMember](Set-JcSdkPolicyGroupMember.md) -This endpoint allows you to manage the Policy members of a Policy Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"policy\", - \"id\": \"{Policy_ID}\" - }' -``` - -### [Set-JcSdkRadiusServerAssociation](Set-JcSdkRadiusServerAssociation.md) -This endpoint allows you to manage the _direct_ associations of a Radius Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ -\t -\"type\":\"user\", -\"id\":\"{USER_ID}\", -\"op\":\"add\" -\t -}' -``` - -### [Set-JcSdkSoftwareApp](Set-JcSdkSoftwareApp.md) -This endpoint set a specific Software Application configuration for the organization. -displayName can be changed alone if no settings are provided. -If a setting is provided, it should include all its information since this endpoint will set all the settings' fields. -The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. - -#### Sample Request - displayName only -``` - curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"displayName\": \"My Software App\" - }' -``` - -#### Sample Request - all attributes -``` - curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"displayName\": \"My Software App\", - \"settings\": [ - { - \"packageId\": \"123456\", - \"autoset : false, - \"allowUpdateDelay\": false, - \"packageManager\": \"APPLE_VPP\", - \"locationObjectId\": \"123456789012123456789012\", - \"location\": \"123456\", - \"desiredState\": \"Install\", - \"appleVpp\": { - \"appConfiguration\": \"\\\\\MyKey\\My String\\\\", - \"assignedLicenses\": 20, - \"availableLicenses\": 10, - \"details\": {}, - \"isConfigEnabled\": true, - \"supportedDeviceFamilies\": [ - \"IPAD\", - \"MAC\" - ], - \"totalLicenses\": 30 - }, - \"packageSubtitle\": \"My package subtitle\", - \"packageVersion\": \"1.2.3\", - \"packageKind\": \"software-package\", - \"assetKind\": \"software\", - \"assetSha256Size\": 256, - \"assetSha256Strings\": [ - \"a123b123c123d123\" - ], - \"description\": \"My app description\" - } - ] - }' -``` - -### [Set-JcSdkSoftwareAppAssociation](Set-JcSdkSoftwareAppAssociation.md) -This endpoint allows you to associate or disassociate a software application to a system or system group. - -#### Sample Request -``` -$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '{ - \"id\": \"\\", - \"op\": \"add\", - \"type\": \"system\" - }' -``` - -### [Set-JcSdkSystemAssociation](Set-JcSdkSystemAssociation.md) -This endpoint allows you to manage the _direct_ associations of a System. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"attributes\": { - \"sudo\": { - \"enabled\": true, - \"withoutPassword\": false - } - }, - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"UserID\" - }' -``` - -### [Set-JcSdkSystemGroup](Set-JcSdkSystemGroup.md) -This endpoint allows you to do a full set of the System Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Name_set - }' -``` - -### [Set-JcSdkSystemGroupAssociation](Set-JcSdkSystemGroupAssociation.md) -This endpoint allows you to manage the _direct_ associations of a System Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{UserID}\" - }' -``` - -### [Set-JcSdkSystemGroupMember](Set-JcSdkSystemGroupMember.md) -This endpoint allows you to manage the system members of a System Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system\", - \"id\": \"{System_ID}\" - }' -``` - -### [Set-JcSdkUserAssociation](Set-JcSdkUserAssociation.md) -This endpoint allows you to manage the _direct_ associations of a User. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"attributes\": { - \"sudo\": { - \"enabled\": true, - \"withoutPassword\": false - } - }, - \"op\": \"add\", - \"type\": \"system_group\", - \"id\": \"{GroupID}\" - }' -``` - -### [Set-JcSdkUserGroup](Set-JcSdkUserGroup.md) -This endpoint allows you to do a full set of the User Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"group_set - }' -``` - -### [Set-JcSdkUserGroupAssociation](Set-JcSdkUserGroupAssociation.md) -This endpoint manages the _direct_ associations of this User Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system\", - \"id\": \"{SystemID}\" - }' -``` - -### [Set-JcSdkUserGroupMember](Set-JcSdkUserGroupMember.md) -This endpoint allows you to manage the user members of a User Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{User_ID}\" - }' -``` - -### [Set-JcSdkWorkday](Set-JcSdkWorkday.md) -This endpoint allows you to set the name and Custom Report URL for a Workday Instance. - -Currently, the name can not be changed from the default of `Workday Import`. - -##### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/workdays/{WorkdayID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ -\t\"reportUrl\":\"{Report_URL}\", -\t\"name\":\"{Name}\" -}\t' -``` - -### [Stop-JcSdkAppleMdmDevice](Stop-JcSdkAppleMdmDevice.md) -Shuts down a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/shutdown \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -### [Sync-JcSdkAppleMdmDevice](Sync-JcSdkAppleMdmDevice.md) -Refreshes the list of devices that a JumpCloud admin has added to their virtual MDM in Apple Business Manager - ABM so that they can be DEP enrolled with JumpCloud. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/refreshdepdevices \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -### [Update-JcSdkAppleMdmDeviceLockInformation](Update-JcSdkAppleMdmDeviceLockInformation.md) -Refreshes the activation lock information for a device - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/refreshActivationLockInformation \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -### [Update-JcSdkAuthenticationPolicy](Update-JcSdkAuthenticationPolicy.md) -Patch the specified authentication policy. - -#### Sample Request -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ \"disabled\": false }' -``` - -### [Update-JcSdkBulkUser](Update-JcSdkBulkUser.md) -The endpoint allows you to update a bulk job to asynchronously update users. -See [update a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_put) for full list of attributes. - -#### Sample Request -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '[ -\t{ -\t \"id\":\"5be9fb4ddb01290001e85109\", -\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", -\t\t\"department\":\"{UPDATED_DEPARTMENT}\", -\t\t\"attributes\":[ -\t\t\t{\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} -\t\t] -\t}, -\t{ -\t \"id\":\"5be9fb4ddb01290001e85109\", -\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", -\t\t\"costCenter\":\"{UPDATED_COST_CENTER}\", -\t\t\"phoneNumbers\":[ -\t\t\t{\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, -\t\t\t{\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} -\t\t] -\t} -] -``` - -### [Update-JcSdkGSuite](Update-JcSdkGSuite.md) -This endpoint allows updating some attributes of a G Suite. - -##### Sample Request - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"userLockoutAction\": \"suspend\", - \"userPasswordExpirationAction\": \"maintain\" - }' -``` -Sample Request, set a default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": { - \"id\": \"{domainObjectID}\" - } - }' -``` - -Sample Request, unset the default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": {} - }' -``` - -### [Update-JcSdkIPList](Update-JcSdkIPList.md) -Update a specific IP list. - -#### Sample Request -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{\"name\": \"New IP List Name\"}' -``` - -### [Update-JcSdkLdapServer](Update-JcSdkLdapServer.md) -This endpoint allows updating some attributes of an LDAP server. - -Sample Request - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"userLockoutAction\": \"remove\", - \"userPasswordExpirationAction\": \"disable\" - }' -``` - -### [Update-JcSdkOffice365](Update-JcSdkOffice365.md) -This endpoint allows updating some attributes of an Office 365 instance. - -##### - -Sample Request - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"userLockoutAction\": \"maintain\", - \"userPasswordExpirationAction\": \"suspend\", - }' -``` - -Sample Request, set a default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": { - \"id\": \"{domainObjectID}\" - } - }' -``` - -Sample Request, unset the default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": {} - }' -``` - -### [Update-JcSdkUserPushEndpoint](Update-JcSdkUserPushEndpoint.md) -This endpoint will update a push endpoint associated with a user. - - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Lock-JcSdkAppleMdmDevice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Lock-JcSdkAppleMdmDevice.md deleted file mode 100644 index 8d48f43b8..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Lock-JcSdkAppleMdmDevice.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Lock-JcSdkAppleMdmDevice.md -schema: 2.0.0 ---- - -# Lock-JcSdkAppleMdmDevice - -## SYNOPSIS -Locks a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/lock \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -## SYNTAX - -### LockExpanded (Default) -``` -Lock-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId [-Pin ] - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Lock -``` -Lock-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId - -Body - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### LockViaIdentity -``` -Lock-JcSdkAppleMdmDevice -ConsoleHost -InputObject - -Body - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### LockViaIdentityExpanded -``` -Lock-JcSdkAppleMdmDevice -ConsoleHost -InputObject [-Pin ] - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Locks a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/lock \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Lock-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Pin:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Lock-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Body:() -``` - - - -## PARAMETERS - -### -AppleMdmId -. - -```yaml -Type: System.String -Parameter Sets: Lock, LockExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IPathsLf7IzoApplemdmsAppleMdmIdDevicesDeviceIdLockPostRequestbodyContentApplicationJsonSchema -Parameter Sets: Lock, LockViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeviceId -. - -```yaml -Type: System.String -Parameter Sets: Lock, LockExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: LockViaIdentity, LockViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pin -6-digit PIN, required for MacOS, to lock the device - -```yaml -Type: System.String -Parameter Sets: LockExpanded, LockViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.IPathsLf7IzoApplemdmsAppleMdmIdDevicesDeviceIdLockPostRequestbodyContentApplicationJsonSchema - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: . - - `[Pin ]`: 6-digit PIN, required for MacOS, to lock the device - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectory.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectory.md deleted file mode 100644 index d66f45306..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectory.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectory.md -schema: 2.0.0 ---- - -# New-JcSdkActiveDirectory - -## SYNOPSIS -This endpoint allows you to create a new Active Directory. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/ \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"domain\": \"{DC=AD_domain_name;DC=com}\" - }' -``` - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkActiveDirectory -ConsoleHost [-DelegationState ] [-Domain ] [-GroupsEnabled] - [-UpdatedAt ] [-UseCase ] [-Confirm] [-WhatIf] [] -``` - -### Create -``` -New-JcSdkActiveDirectory -ConsoleHost -Body [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint allows you to create a new Active Directory. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/ \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"domain\": \"{DC=AD_domain_name;DC=com}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkActiveDirectory -Domain:() -UseCase:() -``` - ----- ---------- -Domain String -Id String -PrimaryAgent String -UseCase String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkActiveDirectory -Body:() -``` - ----- ---------- -Domain String -Id String -PrimaryAgent String -UseCase String - -## PARAMETERS - -### -Body -Active Directory - -```yaml -Type: JumpCloud.SDK.V2.Models.IActiveDirectory -Parameter Sets: Create -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DelegationState -Delegation state of the Active Directory instance - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -Domain name for this Active Directory instance. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupsEnabled -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdatedAt -. - -```yaml -Type: System.DateTime -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseCase -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IActiveDirectory - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IActiveDirectory - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: Active Directory - - `[DelegationState ]`: Delegation state of the Active Directory instance - - `[Domain ]`: Domain name for this Active Directory instance. - - `[GroupsEnabled ]`: - - `[UpdatedAt ]`: - - `[UseCase ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectoryAgent.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectoryAgent.md deleted file mode 100644 index 8a1424152..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectoryAgent.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectoryAgent.md -schema: 2.0.0 ---- - -# New-JcSdkActiveDirectoryAgent - -## SYNOPSIS -This endpoint allows you to create a new Active Directory Agent. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ \"agent_type\":\"{SYNC}\" }' -``` - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkActiveDirectoryAgent -ConsoleHost -ActivedirectoryId [-AgentType ] - [-Confirm] [-WhatIf] [] -``` - -### Create -``` -New-JcSdkActiveDirectoryAgent -ConsoleHost -ActivedirectoryId -Body - [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentity -``` -New-JcSdkActiveDirectoryAgent -ConsoleHost -InputObject - -Body [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-JcSdkActiveDirectoryAgent -ConsoleHost -InputObject [-AgentType ] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to create a new Active Directory Agent. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ \"agent_type\":\"{SYNC}\" }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -AgentType:() -``` - ----- ---------- -ConnectKey String -ContactAt String -Hostname String -Id String -SourceIP String -State String -Version String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -Body:() -``` - ----- ---------- -ConnectKey String -ContactAt String -Hostname String -Id String -SourceIP String -State String -Version String - -## PARAMETERS - -### -ActivedirectoryId -. - -```yaml -Type: System.String -Parameter Sets: Create, CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgentType -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -Active Directory Agent - -```yaml -Type: JumpCloud.SDK.V2.Models.IActiveDirectoryAgent -Parameter Sets: Create, CreateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IActiveDirectoryAgent - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IActiveDirectoryAgentGet - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: Active Directory Agent - - `[AgentType ]`: - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAdministratorOrganization.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAdministratorOrganization.md deleted file mode 100644 index 1387753c8..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAdministratorOrganization.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAdministratorOrganization.md -schema: 2.0.0 ---- - -# New-JcSdkAdministratorOrganization - -## SYNOPSIS -This endpoint allows you to grant Administrator access to an Organization. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkAdministratorOrganization -ConsoleHost -Id [-Organization ] [-Confirm] - [-WhatIf] [] -``` - -### Create -``` -New-JcSdkAdministratorOrganization -ConsoleHost -Id - -Body [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentity -``` -New-JcSdkAdministratorOrganization -ConsoleHost -InputObject - -Body [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-JcSdkAdministratorOrganization -ConsoleHost -InputObject - [-Organization ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to grant Administrator access to an Organization. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkAdministratorOrganization -Id:() -Organization:() -``` - ----- ---------- -Administrator String -Organization String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkAdministratorOrganization -Id:() -Body:() -``` - ----- ---------- -Administrator String -Organization String - -## PARAMETERS - -### -Body -AdministratorOrganizationLinkReq - -```yaml -Type: JumpCloud.SDK.V2.Models.IAdministratorOrganizationLinkReq -Parameter Sets: Create, CreateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Create, CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Organization -The identifier for an organization to link this administrator to. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IAdministratorOrganizationLinkReq - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: AdministratorOrganizationLinkReq - - `[Organization ]`: The identifier for an organization to link this administrator to. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkApprovalFlow.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkApprovalFlow.md deleted file mode 100644 index abe34e98a..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkApprovalFlow.md +++ /dev/null @@ -1,464 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkApprovalFlow.md -schema: 2.0.0 ---- - -# New-JcSdkApprovalFlow - -## SYNOPSIS -Endpoint for adding a new access workflow - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkApprovalFlow -ConsoleHost [-ApprovalType ] [-ApproverRequirement ] - [-ApproverResources ] [-Category ] [-Description ] - [-FixedDuration ] [-IconColor ] [-IconUrl ] [-MultiSelectDuration ] - [-Name ] [-NonAdminApproval] [-OrganizationObjectIdInputFile ] [-ResourceId ] - [-ResourceType ] [-SlackConfig ] [-SlackEnabled] [-Status ] - [-TimeBasedAccess] [-TtlConfig ] [-VisibleTo ] [-Confirm] [-WhatIf] [] -``` - -### Create -``` -New-JcSdkApprovalFlow -ConsoleHost -Body [-Confirm] - [-WhatIf] [] -``` - -## DESCRIPTION -Endpoint for adding a new access workflow - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkApprovalFlow -ApprovalType 'manual' -Category "Application" -Description "A new workflow" -MultiSelectDuration @("P5D") -Name "New Workflow" -ResourceId 5d67fd481da3c52aa1faa883 -ResourceType "user_group" -Status "active" -TimeBasedAccess -TtlConfig "TTL_CONFIG_MULTI_SELECT_DURATIONS" -VisibleTo @('6148cd739d38866f0814e874') -``` - - - -## PARAMETERS - -### -ApprovalType -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApproverRequirement -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApproverResources -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpcloudIngressoApproverResource[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpcloudIngressoCreateAccessWorkflowRequest -Parameter Sets: Create -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Category -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FixedDuration -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IconColor -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IconUrl -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MultiSelectDuration -. - -```yaml -Type: System.String[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NonAdminApproval -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationObjectIdInputFile -Input File for OrganizationObjectId (.) - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceType -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SlackConfig -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpcloudIngressoSlackConfig[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SlackEnabled -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeBasedAccess -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TtlConfig -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VisibleTo -. - -```yaml -Type: System.String[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpcloudIngressoCreateAccessWorkflowRequest - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IJumpcloudIngressoCreateAccessWorkflowResponse - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`APPROVERRESOURCES `: . - - `[RequireAll ]`: - - `[ResourceId ]`: - - `[ResourceName ]`: - - `[ResourceOrder ]`: - - `[ResourceType ]`: - -`BODY `: . - - `[ApprovalType ]`: - - `[ApproverRequirement ]`: - - `[ApproverResources >]`: - - `[RequireAll ]`: - - `[ResourceId ]`: - - `[ResourceName ]`: - - `[ResourceOrder ]`: - - `[ResourceType ]`: - - `[Category ]`: - - `[Description ]`: - - `[FixedDuration ]`: - - `[IconColor ]`: - - `[IconUrl ]`: - - `[MultiSelectDuration >]`: - - `[Name ]`: - - `[NonAdminApproval ]`: - - `[OrganizationObjectId ]`: - - `[ResourceId ]`: - - `[ResourceType ]`: - - `[SlackConfig >]`: - - `[SlackResourceId ]`: - - `[SlackEnabled ]`: - - `[Status ]`: - - `[TimeBasedAccess ]`: - - `[TtlConfig ]`: - - `[VisibleTo >]`: - -`SLACKCONFIG `: . - - `[SlackResourceId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAuthenticationPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAuthenticationPolicy.md deleted file mode 100644 index 5aaf6e71b..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAuthenticationPolicy.md +++ /dev/null @@ -1,583 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAuthenticationPolicy.md -schema: 2.0.0 ---- - -# New-JcSdkAuthenticationPolicy - -## SYNOPSIS -Create an authentication policy. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/authn/policies \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Sample Policy\", - \"disabled\": false, - \"effect\": { - \"action\": \"allow\" - }, - \"targets\": { - \"users\": { - \"inclusions\": [\"ALL\"] - }, - \"userGroups\": { - \"exclusions\": [{USER_GROUP_ID}] - }, - \"resources\": [ {\"type\": \"user_portal\" } ] - }, - \"conditions\":{ - \"ipAddressIn\": [{IP_LIST_ID}] - } - }' -``` - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkAuthenticationPolicy -ConsoleHost [-Conditions ] [-CustomErrorMessage ] - [-CustomErrorMessageEnabled] [-Description ] [-Disabled] [-EffectAction ] [-MfaRequired] - [-Name ] [-ObligationMfaFactors ] - [-PrimaryHelpText ] [-PrimaryHelpUrl ] [-SecondaryHelpText ] - [-SecondaryHelpUrl ] [-TargetResources ] [-Type ] - [-UserAttributeExclusions ] - [-UserAttributeInclusions ] [-UserGroupExclusions ] - [-UserGroupInclusions ] [-UserInclusions ] [-UserVerificationRequirement ] - [-Confirm] [-WhatIf] [] -``` - -### Create -``` -New-JcSdkAuthenticationPolicy -ConsoleHost -Body [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -Create an authentication policy. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/authn/policies \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Sample Policy\", - \"disabled\": false, - \"effect\": { - \"action\": \"allow\" - }, - \"targets\": { - \"users\": { - \"inclusions\": [\"ALL\"] - }, - \"userGroups\": { - \"exclusions\": [{USER_GROUP_ID}] - }, - \"resources\": [ {\"type\": \"user_portal\" } ] - }, - \"conditions\":{ - \"ipAddressIn\": [{IP_LIST_ID}] - } - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkAuthenticationPolicy -Conditions:() -Description:() -Disabled:() -EffectAction:() -MfaRequired:() -Name:() -TargetResources:() -Type:() -UserAttributeExclusions:() -UserAttributeInclusions:() -UserGroupExclusions:() -UserGroupInclusions:() -UserInclusions:() -UserVerificationRequirement:() -``` - ----- ---------- -Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions -Description String -Disabled Boolean -EffectAction String -Id String -MfaRequired Boolean -Name String -TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] -Type String -UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserGroupExclusions String -UserGroupInclusions String -UserInclusions String -UserVerificationRequirement String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkAuthenticationPolicy -Body:() -``` - ----- ---------- -Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions -Description String -Disabled Boolean -EffectAction String -Id String -MfaRequired Boolean -Name String -TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] -Type String -UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserGroupExclusions String -UserGroupInclusions String -UserInclusions String -UserVerificationRequirement String - -## PARAMETERS - -### -Body -This represents an authentication policy. -See the details of each field for valid values and restrictions. - -```yaml -Type: JumpCloud.SDK.V2.Models.IAuthnPolicy -Parameter Sets: Create -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Conditions -Dictionary of \ - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomErrorMessage -The custom error message to be displayed when the policy is applied. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomErrorMessageEnabled -Indicates whether the custom error message is enabled or not. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EffectAction -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MfaRequired -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObligationMfaFactors -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IAuthnPolicyObligationsMfaFactorsItem[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryHelpText -The text to be displayed for the help link. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryHelpUrl -The URL to be opened when the help link is clicked. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryHelpText -The text to be displayed for the help link. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryHelpUrl -The URL to be opened when the help link is clicked. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetResources -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IAuthnPolicyResourceTarget[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -AuthnPolicyType - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserAttributeExclusions -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IAuthnPolicyUserAttributeFilter[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserAttributeInclusions -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IAuthnPolicyUserAttributeFilter[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserGroupExclusions -. - -```yaml -Type: System.String[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserGroupInclusions -. - -```yaml -Type: System.String[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserInclusions -. - -```yaml -Type: System.String[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserVerificationRequirement -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IAuthnPolicy - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IAuthnPolicy - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: This represents an authentication policy. See the details of each field for valid values and restrictions. - - `[Conditions ]`: Dictionary of - - `[(Any) ]`: This indicates any property can be added to this object. - - `[CustomErrorMessage ]`: The custom error message to be displayed when the policy is applied. - - `[CustomErrorMessageEnabled ]`: Indicates whether the custom error message is enabled or not. - - `[Description ]`: - - `[Disabled ]`: - - `[EffectAction ]`: - - `[MfaRequired ]`: - - `[Name ]`: - - `[ObligationMfaFactors >]`: - - `[Type ]`: - - `[PrimaryHelpText ]`: The text to be displayed for the help link. - - `[PrimaryHelpUrl ]`: The URL to be opened when the help link is clicked. - - `[SecondaryHelpText ]`: The text to be displayed for the help link. - - `[SecondaryHelpUrl ]`: The URL to be opened when the help link is clicked. - - `[TargetResources >]`: - - `Type `: - - `[Id ]`: Object ID of the resource target. If undefined, then all resources of the given type are targeted. - - `[Type ]`: AuthnPolicyType - - `[UserAttributeExclusions >]`: - - `[Field ]`: The only field that is currently supported is ldap_binding_user - - `[Operator ]`: - - `[Value ]`: Can be any value - string, number, boolean, array or object. - - `[UserAttributeInclusions >]`: - - `[UserGroupExclusions >]`: - - `[UserGroupInclusions >]`: - - `[UserInclusions >]`: - - `[UserVerificationRequirement ]`: - -`OBLIGATIONMFAFACTORS `: . - - `[Type ]`: - -`TARGETRESOURCES `: . - - `Type `: - - `[Id ]`: Object ID of the resource target. If undefined, then all resources of the given type are targeted. - -`USERATTRIBUTEEXCLUSIONS `: . - - `[Field ]`: The only field that is currently supported is ldap_binding_user - - `[Operator ]`: - - `[Value ]`: Can be any value - string, number, boolean, array or object. - -`USERATTRIBUTEINCLUSIONS `: . - - `[Field ]`: The only field that is currently supported is ldap_binding_user - - `[Operator ]`: - - `[Value ]`: Can be any value - string, number, boolean, array or object. - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUser.md deleted file mode 100644 index 7cc3efd46..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUser.md +++ /dev/null @@ -1,321 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUser.md -schema: 2.0.0 ---- - -# New-JcSdkBulkUser - -## SYNOPSIS -The endpoint allows you to create a bulk job to asynchronously create users. -See [create a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_post) -for the full list of attributes. - -#### Default User State -The `state` of each user in the request can be explicitly passed in or -omitted. -If `state` is omitted, then the user will get created -using the value returned from the -[Get an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organizations_get) -endpoint. -The default user state for bulk created users depends on the -`creation-source` header. -For `creation-source:jumpcloud:bulk` the -default state is stored in `settings.newSystemUserStateDefaults.csvImport`. -For other `creation-source` header values, the default state is stored in -`settings.newSystemUserStateDefaults.applicationImport` - -These default state values can be changed in the admin portal settings -or by using the -[create an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organization_put) -endpoint. - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '[ - { - \"email\":\"{email}\", - \"firstname\":\"{firstname}\", - \"lastname\":\"{firstname}\", - \"username\":\"{username}\", - \"attributes\":[ - { - \"name\":\"EmployeeID\", - \"value\":\"0000\" - }, - { - \"name\":\"Custom\", - \"value\":\"attribute\" - } - ] - } -]' -``` - -## SYNTAX - -``` -New-JcSdkBulkUser -ConsoleHost -Body > [-SuppressEmail] - [-CreationSource ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -The endpoint allows you to create a bulk job to asynchronously create users. -See [create a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_post) -for the full list of attributes. - -#### Default User State -The `state` of each user in the request can be explicitly passed in or -omitted. -If `state` is omitted, then the user will get created -using the value returned from the -[Get an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organizations_get) -endpoint. -The default user state for bulk created users depends on the -`creation-source` header. -For `creation-source:jumpcloud:bulk` the -default state is stored in `settings.newSystemUserStateDefaults.csvImport`. -For other `creation-source` header values, the default state is stored in -`settings.newSystemUserStateDefaults.applicationImport` - -These default state values can be changed in the admin portal settings -or by using the -[create an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organization_put) -endpoint. - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '[ - { - \"email\":\"{email}\", - \"firstname\":\"{firstname}\", - \"lastname\":\"{firstname}\", - \"username\":\"{username}\", - \"attributes\":[ - { - \"name\":\"EmployeeID\", - \"value\":\"0000\" - }, - { - \"name\":\"Custom\", - \"value\":\"attribute\" - } - ] - } -]' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkBulkUser -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -Body -Array of bulk-user-create - -```yaml -Type: System.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserCreate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreationSource -Defines the creation-source header for gapps, o365 and workdays requests. -If the header isn't sent, the default value is `jumpcloud:bulk`, if you send the header with a malformed value you receive a 400 error. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuppressEmail -An option indicating whether to suppress the job results email that will -otherwise be sent to the Administrator who created the job. -If true, the -email won't be sent. -If omitted or false, the email will be sent. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserCreate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IJobIdResult - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY >`: Array of bulk-user-create - - `[AccountLocked ]`: - - `[Activated ]`: - - `[Addresses >]`: - - `[Country ]`: - - `[ExtendedAddress ]`: - - `[Locality ]`: - - `[PoBox ]`: - - `[PostalCode ]`: - - `[Region ]`: - - `[StreetAddress ]`: - - `[Type ]`: - - `[AllowPublicKey ]`: - - `[AlternateEmail ]`: - - `[Attributes >]`: - - `[Name ]`: - - `[Value ]`: - - `[Company ]`: - - `[CostCenter ]`: - - `[DelegatedAuthorityId ]`: ObjectId of the target Active Directory connection - - `[DelegatedAuthorityName ]`: Authority name - - `[Department ]`: - - `[Description ]`: - - `[DisableDeviceMaxLoginAttempts ]`: - - `[Displayname ]`: - - `[Email ]`: - - `[EmployeeIdentifier ]`: Must be unique per user. - - `[EmployeeType ]`: - - `[EnableManagedUid ]`: - - `[EnableUserPortalMultifactor ]`: - - `[ExternalDn ]`: - - `[ExternalPasswordExpirationDate ]`: - - `[ExternalSourceType ]`: - - `[ExternallyManaged ]`: - - `[Firstname ]`: - - `[JobTitle ]`: - - `[Lastname ]`: - - `[LdapBindingUser ]`: - - `[Location ]`: - - `[ManagedAppleId ]`: - - `[Manager ]`: Relation with another systemuser to identify the last as a manager. - - `[MfaConfigured ]`: - - `[MfaExclusion ]`: - - `[MfaExclusionDays ]`: - - `[MfaExclusionUntil ]`: - - `[Middlename ]`: - - `[Password ]`: - - `[PasswordNeverExpires ]`: - - `[PasswordlessSudo ]`: - - `[PhoneNumbers >]`: - - `[Number ]`: - - `[Type ]`: - - `[PublicKey ]`: - - `[RecoveryEmailAddress ]`: - - `[Relationships >]`: - - `[Type ]`: - - `[Value ]`: - - `[RestrictedField ]`: - - `[RestrictedFieldId ]`: - - `[RestrictedFieldType ]`: - - `[SambaServiceUser ]`: - - `[State ]`: - - `[Sudo ]`: - - `[Suspended ]`: - - `[UnixGuid ]`: - - `[UnixUid ]`: - - `[Username ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUserState.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUserState.md deleted file mode 100644 index 992089c5c..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUserState.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUserState.md -schema: 2.0.0 ---- - -# New-JcSdkBulkUserState - -## SYNOPSIS -This endpoint allows you to create scheduled statechange jobs. -#### Sample Request -``` -curl -X POST \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ - -H 'x-api-key: {API_KEY}' \\ - -H 'Content-Type: application/json' \\ - -H 'Accept: application/json' \\ - -d '{ - \"user_ids\": [\"{User_ID_1}\", \"{User_ID_2}\", \"{User_ID_3}\"], - \"state\": \"SUSPENDED\", - \"start_date\": \"2000-01-01T00:00:00.000Z\" - }' -``` - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkBulkUserState -ConsoleHost [-ActivationEmailOverride ] [-SendActivationEmails] - [-StartDate ] [-State ] [-UserIds ] [-Confirm] [-WhatIf] [] -``` - -### Create -``` -New-JcSdkBulkUserState -ConsoleHost -Body [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint allows you to create scheduled statechange jobs. -#### Sample Request -``` -curl -X POST \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ - -H 'x-api-key: {API_KEY}' \\ - -H 'Content-Type: application/json' \\ - -H 'Accept: application/json' \\ - -d '{ - \"user_ids\": [\"{User_ID_1}\", \"{User_ID_2}\", \"{User_ID_3}\"], - \"state\": \"SUSPENDED\", - \"start_date\": \"2000-01-01T00:00:00.000Z\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkBulkUserState -StartDate:() -State:() -UserIds:() -ActivationEmailOverride:() -SendActivationEmails:() -``` - ----- ---------- -ScheduledDate String -ScheduledJobId String -State String -SystemUserId String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkBulkUserState -Body:() -``` - ----- ---------- -ScheduledDate String -ScheduledJobId String -State String -SystemUserId String - -## PARAMETERS - -### -ActivationEmailOverride -Send the activation or welcome email to the specified email address upon activation. -Can only be used with a single user_id and scheduled activation. -This field will be ignored if `send_activation_emails` is explicitly set to false. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -Model to support bulk scheduling of a state change for one or more users - -```yaml -Type: JumpCloud.SDK.V2.Models.IBulkScheduledStatechangeCreate -Parameter Sets: Create -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendActivationEmails -Set to true to send activation or welcome email(s) to each user_id upon activation. -Set to false to suppress emails. -Can only be used with scheduled activation(s). - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -Date and time that scheduled action should occur - -```yaml -Type: System.DateTime -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -State -The state to move the user(s) to - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserIds -Array of system user ids to schedule for a state change - -```yaml -Type: System.String[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IBulkScheduledStatechangeCreate - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IScheduledUserstateResult - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: Model to support bulk scheduling of a state change for one or more users - - `StartDate `: Date and time that scheduled action should occur - - `State `: The state to move the user(s) to - - `UserIds >`: Array of system user ids to schedule for a state change - - `[ActivationEmailOverride ]`: Send the activation or welcome email to the specified email address upon activation. Can only be used with a single user_id and scheduled activation. This field will be ignored if `send_activation_emails` is explicitly set to false. - - `[SendActivationEmails ]`: Set to true to send activation or welcome email(s) to each user_id upon activation. Set to false to suppress emails. Can only be used with scheduled activation(s). - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkCustomEmailConfiguration.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkCustomEmailConfiguration.md deleted file mode 100644 index 6b3a082c6..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkCustomEmailConfiguration.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkCustomEmailConfiguration.md -schema: 2.0.0 ---- - -# New-JcSdkCustomEmailConfiguration - -## SYNOPSIS -Create the custom email configuration for the specified custom email type. - -This action is only available to paying customers. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkCustomEmailConfiguration -ConsoleHost [-Body ] [-Button ] [-Header ] - [-NextStepContactInfo ] [-Subject ] [-Title ] [-Type ] [-Confirm] [-WhatIf] - [] -``` - -### Create -``` -New-JcSdkCustomEmailConfiguration -ConsoleHost -CustomEmail [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -Create the custom email configuration for the specified custom email type. - -This action is only available to paying customers. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkCustomEmailConfiguration -Subject:() -Type:() -Body:() -Button:() -Header:() -NextStepContactInfo:() -Title:() -``` - ----- ---------- -Body String -Button String -Header String -Id String -NextStepContactInfo String -Subject String -Title String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkCustomEmailConfiguration -CustomEmail:() -``` - ----- ---------- -Body String -Button String -Header String -Id String -NextStepContactInfo String -Subject String -Title String -Type String - -## PARAMETERS - -### -Body -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Button -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomEmail -Custom email content created by the admin user to personalize emails sent to their system users. - -```yaml -Type: JumpCloud.SDK.V2.Models.ICustomEmail -Parameter Sets: Create -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Header -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NextStepContactInfo -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subject -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.ICustomEmail - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ICustomEmail - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`CUSTOMEMAIL `: Custom email content created by the admin user to personalize emails sent to their system users. - - `Subject `: - - `Type `: - - `[Body ]`: - - `[Button ]`: - - `[Header ]`: - - `[NextStepContactInfo ]`: - - `[Title ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoAccount.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoAccount.md deleted file mode 100644 index 09a078107..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoAccount.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoAccount.md -schema: 2.0.0 ---- - -# New-JcSdkDuoAccount - -## SYNOPSIS -Registers a Duo account for an organization. -Only one Duo account will be allowed, -in case an organization has a Duo account already a 409 (Conflict) code will be returned. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -## SYNTAX - -``` -New-JcSdkDuoAccount -ConsoleHost [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Registers a Duo account for an organization. -Only one Duo account will be allowed, -in case an organization has a Duo account already a 409 (Conflict) code will be returned. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkDuoAccount -``` - ----- ---------- -Id String -Name String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IDuoAccount - -## NOTES - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoApplication.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoApplication.md deleted file mode 100644 index d9a0cc3e9..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoApplication.md +++ /dev/null @@ -1,301 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoApplication.md -schema: 2.0.0 ---- - -# New-JcSdkDuoApplication - -## SYNOPSIS -Create a Duo application for your organization and the specified account. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Application Name\", - \"apiHost\": \"api-1234.duosecurity.com\", - \"integrationKey\": \"1234\", - \"secretKey\": \"5678\" - }' -``` - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkDuoApplication -ConsoleHost -AccountId [-ApiHost ] - [-IntegrationKey ] [-Name ] [-SecretKey ] [-Confirm] [-WhatIf] [] -``` - -### Create -``` -New-JcSdkDuoApplication -ConsoleHost -AccountId -Body [-Confirm] - [-WhatIf] [] -``` - -### CreateViaIdentity -``` -New-JcSdkDuoApplication -ConsoleHost -InputObject -Body - [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-JcSdkDuoApplication -ConsoleHost -InputObject [-ApiHost ] - [-IntegrationKey ] [-Name ] [-SecretKey ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Create a Duo application for your organization and the specified account. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Application Name\", - \"apiHost\": \"api-1234.duosecurity.com\", - \"integrationKey\": \"1234\", - \"secretKey\": \"5678\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkDuoApplication -AccountId:() -ApiHost:() -IntegrationKey:() -Name:() -SecretKey:() -``` - ----- ---------- -ApiHost String -Id String -IntegrationKey String -Name String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkDuoApplication -AccountId:() -Body:() -``` - ----- ---------- -ApiHost String -Id String -IntegrationKey String -Name String - -## PARAMETERS - -### -AccountId -. - -```yaml -Type: System.String -Parameter Sets: Create, CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiHost -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -DuoApplicationReq - -```yaml -Type: JumpCloud.SDK.V2.Models.IDuoApplicationReq -Parameter Sets: Create, CreateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IntegrationKey -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecretKey -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IDuoApplicationReq - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IDuoApplication - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: DuoApplicationReq - - `ApiHost `: - - `IntegrationKey `: - - `Name `: - - `SecretKey `: - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkGSuiteTranslationRule.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkGSuiteTranslationRule.md deleted file mode 100644 index e96f69a40..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkGSuiteTranslationRule.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkGSuiteTranslationRule.md -schema: 2.0.0 ---- - -# New-JcSdkGSuiteTranslationRule - -## SYNOPSIS -This endpoint allows you to create a translation rule for a specific G Suite instance. -These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Translation Rule Parameters} - }' -``` - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkGSuiteTranslationRule -ConsoleHost -GsuiteId [-BuiltIn ] - [-Direction ] [-Confirm] [-WhatIf] [] -``` - -### Create -``` -New-JcSdkGSuiteTranslationRule -ConsoleHost -GsuiteId -Body - [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentity -``` -New-JcSdkGSuiteTranslationRule -ConsoleHost -InputObject - -Body [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-JcSdkGSuiteTranslationRule -ConsoleHost -InputObject [-BuiltIn ] - [-Direction ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to create a translation rule for a specific G Suite instance. -These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Translation Rule Parameters} - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkGSuiteTranslationRule -GsuiteId:() -BuiltIn:() -Direction:() -``` - ----- ---------- -BuiltIn String -Direction String -Id String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkGSuiteTranslationRule -GsuiteId:() -Body:() -``` - ----- ---------- -BuiltIn String -Direction String -Id String - -## PARAMETERS - -### -Body -G Suite Translation Rule Request - -```yaml -Type: JumpCloud.SDK.V2.Models.IGSuiteTranslationRuleRequest -Parameter Sets: Create, CreateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BuiltIn -Built-in translations for G Suite export:* `user_home_addresses` - Translate all JumpCloud user addresses of type `home` to G Suite Directory user addresses of type `home`* `user_work_addresses` - Translate all JumpCloud user addresses of type `work` to G Suite Directory user addresses of type `work`* `user_other_addresses` - Translate all JumpCloud user addresses of type `other` to G Suite Directory user addresses of type `other`* `user_home_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `home` to G Suite Directory user phones of type `home`* `user_mobile_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `mobile` to G Suite Directory user phones of type `mobile`* `user_other_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `other` to G Suite Directory user phones of type `other`* `user_work_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work` to G Suite Directory user phones of type `work`* `user_work_fax_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work_fax` to G Suite Directory user phones of type `work_fax`* `user_work_mobile_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work_mobile` to G Suite Directory user phones of type `work_mobile`* `user_manager` - Translate JumpCloud user `manager` to G Suite Directory user `relations-manager`* `user_primary_organization_cost_center` - Translate JumpCloud user `costCenter` to G Suite Directory user `costCenter` for `primary` organization* `user_primary_organization_department` - Translate JumpCloud user `department` to G Suite Directory user `department` for `primary` organization* `user_primary_organization_description` - Translate JumpCloud user `employeeType` to G Suite Directory user `description` for `primary` organization* `user_primary_organization_employee_id` - Translate JumpCloud user `employeeIdentifier` to G Suite Directory user `externalIds` element of type `organization`* `user_primary_organization_title` - Translate JumpCloud user `jobTitle` to G Suite Directory user `title` for `primary` organization* `user_alternate_email` - Translate JumpCloud user `alternateEmail` to G Suite Directory user `emails`* `user_status` - Translate JumpCloud user `status` to G Suite Directory user `status`* `user_password` - Translate JumpCloud user `password` to G Suite Directory user `password` - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -Direction identify if an attribute is going to be exported or imported from GSuite* `Import`- The data will be imported from GSuite into the user modal* `Export`- The data will be exported from the user modal to GSuite - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GsuiteId -. - -```yaml -Type: System.String -Parameter Sets: Create, CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGSuiteTranslationRuleRequest - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGSuiteTranslationRule - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: G Suite Translation Rule Request - - `[BuiltIn ]`: Built-in translations for G Suite export: * `user_home_addresses` - Translate all JumpCloud user addresses of type `home` to G Suite Directory user addresses of type `home` * `user_work_addresses` - Translate all JumpCloud user addresses of type `work` to G Suite Directory user addresses of type `work` * `user_other_addresses` - Translate all JumpCloud user addresses of type `other` to G Suite Directory user addresses of type `other` * `user_home_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `home` to G Suite Directory user phones of type `home` * `user_mobile_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `mobile` to G Suite Directory user phones of type `mobile` * `user_other_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `other` to G Suite Directory user phones of type `other` * `user_work_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work` to G Suite Directory user phones of type `work` * `user_work_fax_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work_fax` to G Suite Directory user phones of type `work_fax` * `user_work_mobile_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work_mobile` to G Suite Directory user phones of type `work_mobile` * `user_manager` - Translate JumpCloud user `manager` to G Suite Directory user `relations-manager` * `user_primary_organization_cost_center` - Translate JumpCloud user `costCenter` to G Suite Directory user `costCenter` for `primary` organization * `user_primary_organization_department` - Translate JumpCloud user `department` to G Suite Directory user `department` for `primary` organization * `user_primary_organization_description` - Translate JumpCloud user `employeeType` to G Suite Directory user `description` for `primary` organization * `user_primary_organization_employee_id` - Translate JumpCloud user `employeeIdentifier` to G Suite Directory user `externalIds` element of type `organization` * `user_primary_organization_title` - Translate JumpCloud user `jobTitle` to G Suite Directory user `title` for `primary` organization * `user_alternate_email` - Translate JumpCloud user `alternateEmail` to G Suite Directory user `emails` * `user_status` - Translate JumpCloud user `status` to G Suite Directory user `status` * `user_password` - Translate JumpCloud user `password` to G Suite Directory user `password` - - `[Direction ]`: Direction identify if an attribute is going to be exported or imported from GSuite * `Import`- The data will be imported from GSuite into the user modal * `Export`- The data will be exported from the user modal to GSuite - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkIPList.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkIPList.md deleted file mode 100644 index 7a99c5b18..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkIPList.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkIPList.md -schema: 2.0.0 ---- - -# New-JcSdkIPList - -## SYNOPSIS -Create an IP list. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/iplists \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Sample IP List\", - \"ips\": [ - \"192.168.10.12\", - \"192.168.10.20 - 192.168.10.30\", - \"123.225.10.0/32\" - ] - }' -``` - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkIPList -ConsoleHost [-Description ] [-Ips ] [-Name ] [-Confirm] - [-WhatIf] [] -``` - -### Create -``` -New-JcSdkIPList -ConsoleHost -Body [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Create an IP list. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/iplists \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Sample IP List\", - \"ips\": [ - \"192.168.10.12\", - \"192.168.10.20 - 192.168.10.30\", - \"123.225.10.0/32\" - ] - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkIPList -Description:() -Ips:() -Name:() -``` - ----- ---------- -Description String -Id String -Ips String -Name String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkIPList -Body:() -``` - ----- ---------- -Description String -Id String -Ips String -Name String - -## PARAMETERS - -### -Body -IPListRequest - -```yaml -Type: JumpCloud.SDK.V2.Models.IIPListRequest -Parameter Sets: Create -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ips -. - -```yaml -Type: System.String[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IIPListRequest - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IIPList - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: IPListRequest - - `[Description ]`: - - `[Ips >]`: - - `[Name ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkLdapServerSambaDomain.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkLdapServerSambaDomain.md deleted file mode 100644 index 60132303d..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkLdapServerSambaDomain.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkLdapServerSambaDomain.md -schema: 2.0.0 ---- - -# New-JcSdkLdapServerSambaDomain - -## SYNOPSIS -This endpoint allows you to create a samba domain for an LDAP server. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"sid\":\"{SID_ID}\", - \"name\":\"{WORKGROUP_NAME}\" - }' -``` - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkLdapServerSambaDomain -ConsoleHost -LdapserverId [-Name ] [-Sid ] - [-Confirm] [-WhatIf] [] -``` - -### Create -``` -New-JcSdkLdapServerSambaDomain -ConsoleHost -LdapserverId -Body [-Confirm] - [-WhatIf] [] -``` - -### CreateViaIdentity -``` -New-JcSdkLdapServerSambaDomain -ConsoleHost -InputObject -Body - [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-JcSdkLdapServerSambaDomain -ConsoleHost -InputObject [-Name ] - [-Sid ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to create a samba domain for an LDAP server. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"sid\":\"{SID_ID}\", - \"name\":\"{WORKGROUP_NAME}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkLdapServerSambaDomain -LdapserverId:() -Name:() -Sid:() -``` - ----- ---------- -Id String -Name String -Sid String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkLdapServerSambaDomain -LdapserverId:() -Body:() -``` - ----- ---------- -Id String -Name String -Sid String - -## PARAMETERS - -### -Body -Samba Domain - -```yaml -Type: JumpCloud.SDK.V2.Models.ISambaDomain -Parameter Sets: Create, CreateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LdapserverId -Unique identifier of the LDAP server. - -```yaml -Type: System.String -Parameter Sets: Create, CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of this domain's WorkGroup - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sid -Security identifier of this domain - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.ISambaDomain - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISambaDomain - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: Samba Domain - - `Name `: Name of this domain's WorkGroup - - `Sid `: Security identifier of this domain - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkOffice365TranslationRule.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkOffice365TranslationRule.md deleted file mode 100644 index d08db22b0..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkOffice365TranslationRule.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkOffice365TranslationRule.md -schema: 2.0.0 ---- - -# New-JcSdkOffice365TranslationRule - -## SYNOPSIS -This endpoint allows you to create a translation rule for a specific Office 365 instance. -These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Translation Rule Parameters} - }' -``` - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkOffice365TranslationRule -ConsoleHost -Office365Id [-BuiltIn ] - [-Direction ] [-Confirm] [-WhatIf] [] -``` - -### Create -``` -New-JcSdkOffice365TranslationRule -ConsoleHost -Office365Id - -Body [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentity -``` -New-JcSdkOffice365TranslationRule -ConsoleHost -InputObject - -Body [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-JcSdkOffice365TranslationRule -ConsoleHost -InputObject - [-BuiltIn ] [-Direction ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to create a translation rule for a specific Office 365 instance. -These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Translation Rule Parameters} - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkOffice365TranslationRule -Office365Id:() -BuiltIn:() -Direction:() -``` - ----- ---------- -BuiltIn String -Direction String -Id String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkOffice365TranslationRule -Office365Id:() -Body:() -``` - ----- ---------- -BuiltIn String -Direction String -Id String - -## PARAMETERS - -### -Body -Office 365 Translation Rule Request - -```yaml -Type: JumpCloud.SDK.V2.Models.IOffice365TranslationRuleRequest -Parameter Sets: Create, CreateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BuiltIn -Built-in translations for Office 365 (Microsoft Graph) export:* `user_alternate_email` - Translate `alternateEmail` field of JumpCloud user to `otherMails` field of Microsoft Graph `user`* `user_business_phones` - Translate `number` field of first JumpCloud user `phoneNumber` of type `work` to `businessPhones` field of Microsoft Graph `user`* `user_city` - Translate `locality` field of JumpCloud user address of type `work` to `city` field of Microsoft Graph user* `user_country` - Translate `country` field of JumpCloud user address of type `work` to `country` field of Microsoft Graph `user`* `user_department` - Translate `department` field of JumpCloud user to `department` field of Microsoft Graph `user`* `user_job_title` - Translate `jobTitle` field of JumpCloud user to `jobTitle` field of Microsoft Graph `user`* `user_manager` - Translate `manager` field of JumpCloud user to `manager` field of Microsoft Graph `user`* `user_mobile_phone` - Translate `number` field of first JumpCloud user `phoneNumber` of type `mobile` to `mobilePhone` field of Microsoft Graph `user`* `user_office_location` - Translate `location` field of JumpCloud user to `officeLocation` field of Microsoft Graph `user`* `user_postal_code` - Translate `postalCode` field of JumpCloud user address of type `work` to `postalCode` field of Microsoft Graph `user`* `user_principal_name_from_alternate_email` - Translate user `alternateEmail` field of Jumpcloud user to `userPrincipalName` field of Microsoft Graph `user`* `user_state` - Translate `region` field of JumpCloud user address of type `work` to `state` field of Microsoft Graph `user`* `user_street_address` - Translate `streetAddress` field of JumpCloud user address of type `work` to `streetAddress` field of Microsoft Graph user - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -Direction identify if a attribute is going to be exported or imported from Office365* `Export`- The data will exported from the user modal to Office365 - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Office365Id -. - -```yaml -Type: System.String -Parameter Sets: Create, CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.IOffice365TranslationRuleRequest - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IOffice365TranslationRule - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: Office 365 Translation Rule Request - - `[BuiltIn ]`: Built-in translations for Office 365 (Microsoft Graph) export: * `user_alternate_email` - Translate `alternateEmail` field of JumpCloud user to `otherMails` field of Microsoft Graph `user` * `user_business_phones` - Translate `number` field of first JumpCloud user `phoneNumber` of type `work` to `businessPhones` field of Microsoft Graph `user` * `user_city` - Translate `locality` field of JumpCloud user address of type `work` to `city` field of Microsoft Graph user * `user_country` - Translate `country` field of JumpCloud user address of type `work` to `country` field of Microsoft Graph `user` * `user_department` - Translate `department` field of JumpCloud user to `department` field of Microsoft Graph `user` * `user_job_title` - Translate `jobTitle` field of JumpCloud user to `jobTitle` field of Microsoft Graph `user` * `user_manager` - Translate `manager` field of JumpCloud user to `manager` field of Microsoft Graph `user` * `user_mobile_phone` - Translate `number` field of first JumpCloud user `phoneNumber` of type `mobile` to `mobilePhone` field of Microsoft Graph `user` * `user_office_location` - Translate `location` field of JumpCloud user to `officeLocation` field of Microsoft Graph `user` * `user_postal_code` - Translate `postalCode` field of JumpCloud user address of type `work` to `postalCode` field of Microsoft Graph `user` * `user_principal_name_from_alternate_email` - Translate user `alternateEmail` field of Jumpcloud user to `userPrincipalName` field of Microsoft Graph `user` * `user_state` - Translate `region` field of JumpCloud user address of type `work` to `state` field of Microsoft Graph `user` * `user_street_address` - Translate `streetAddress` field of JumpCloud user address of type `work` to `streetAddress` field of Microsoft Graph user - - `[Direction ]`: Direction identify if a attribute is going to be exported or imported from Office365 * `Export`- The data will exported from the user modal to Office365 - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicy.md deleted file mode 100644 index a3aea9af8..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicy.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicy.md -schema: 2.0.0 ---- - -# New-JcSdkPolicy - -## SYNOPSIS -This endpoint allows you to create a policy. -Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policies \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Policy_Parameters} - }' -``` - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkPolicy -ConsoleHost [-Name ] [-Notes ] [-TemplateId ] - [-Values ] [-Confirm] [-WhatIf] [] -``` - -### Create -``` -New-JcSdkPolicy -ConsoleHost -Body [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to create a policy. -Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. - -##### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policies \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Policy_Parameters} - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkPolicy -Name:() -TemplateId:() -Notes:() -Values:() -``` - ----- ---------- -ConfigFields JumpCloud.SDK.V2.Models.PolicyTemplateConfigField[] -Id String -Name String -Notes String -TemplateActivation String -TemplateAlert String -TemplateBehavior String -TemplateDeliveryTypes String -TemplateDescription String -TemplateDisplayName String -TemplateId String -TemplateName String -TemplateOSMetaFamily String -TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] -TemplateReference String -TemplateState String -Values JumpCloud.SDK.V2.Models.PolicyValue[] - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkPolicy -Body:() -``` - ----- ---------- -ConfigFields JumpCloud.SDK.V2.Models.PolicyTemplateConfigField[] -Id String -Name String -Notes String -TemplateActivation String -TemplateAlert String -TemplateBehavior String -TemplateDeliveryTypes String -TemplateDescription String -TemplateDisplayName String -TemplateId String -TemplateName String -TemplateOSMetaFamily String -TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] -TemplateReference String -TemplateState String -Values JumpCloud.SDK.V2.Models.PolicyValue[] - -## PARAMETERS - -### -Body -A request to create an instance of a policy template. - -```yaml -Type: JumpCloud.SDK.V2.Models.IPolicyCreateRequest -Parameter Sets: Create -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The description for this specific Policy. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -The notes for this specific Policy. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateId -ObjectId uniquely identifying a Policy instance. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Values -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IPolicyValue[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IPolicyCreateRequest - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPolicyWithDetails - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: A request to create an instance of a policy template. - - `Name `: The description for this specific Policy. - - `TemplateId `: ObjectId uniquely identifying a Policy instance. - - `[Notes ]`: The notes for this specific Policy. - - `[Values >]`: - - `[ConfigFieldId ]`: The ObjectId of the corresponding Policy Template configuration field. - - `[Sensitive ]`: Defines if the value is sensitive or not. - - `[Value ]`: The value for the configuration field for this Policy instance. - -`VALUES `: . - - `[ConfigFieldId ]`: The ObjectId of the corresponding Policy Template configuration field. - - `[Sensitive ]`: Defines if the value is sensitive or not. - - `[Value ]`: The value for the configuration field for this Policy instance. - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicyGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicyGroup.md deleted file mode 100644 index 200771a84..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicyGroup.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicyGroup.md -schema: 2.0.0 ---- - -# New-JcSdkPolicyGroup - -## SYNOPSIS -This endpoint allows you to create a new Policy Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policygroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"{Group_Name}\" - }' -``` - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkPolicyGroup -ConsoleHost [-Name ] [-Confirm] [-WhatIf] [] -``` - -### Create -``` -New-JcSdkPolicyGroup -ConsoleHost -Body [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to create a new Policy Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policygroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"{Group_Name}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkPolicyGroup -Name:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -Name String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkPolicyGroup -Body:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -Name String -Type String - -## PARAMETERS - -### -Body -PolicyGroupData - -```yaml -Type: JumpCloud.SDK.V2.Models.IPolicyGroupData -Parameter Sets: Create -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Display name of a Policy Group. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IPolicyGroupData - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPolicyGroup - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: PolicyGroupData - - `Name `: Display name of a Policy Group. - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkProviderAdministrator.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkProviderAdministrator.md deleted file mode 100644 index 87a524c8a..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkProviderAdministrator.md +++ /dev/null @@ -1,409 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkProviderAdministrator.md -schema: 2.0.0 ---- - -# New-JcSdkProviderAdministrator - -## SYNOPSIS -This endpoint allows you to create a provider administrator. -You must be associated with the provider to use this route. -You must provide either `role` or `roleName`. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkProviderAdministrator -ConsoleHost -ProviderId [-ApiKeyAllowed] - [-ApiKeyHashCreatedAt ] [-ApiKeyHashExpireAt ] [-ApiKeyHashPrefix ] [-BindNoOrgs] - [-Email ] [-EnableMultiFactor] [-Firstname ] [-Lastname ] [-Role ] - [-RoleName ] [-Confirm] [-WhatIf] [] -``` - -### Create -``` -New-JcSdkProviderAdministrator -ConsoleHost -ProviderId -Body [-Confirm] - [-WhatIf] [] -``` - -### CreateViaIdentity -``` -New-JcSdkProviderAdministrator -ConsoleHost -InputObject - -Body [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-JcSdkProviderAdministrator -ConsoleHost -InputObject [-ApiKeyAllowed] - [-ApiKeyHashCreatedAt ] [-ApiKeyHashExpireAt ] [-ApiKeyHashPrefix ] [-BindNoOrgs] - [-Email ] [-EnableMultiFactor] [-Firstname ] [-Lastname ] [-Role ] - [-RoleName ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to create a provider administrator. -You must be associated with the provider to use this route. -You must provide either `role` or `roleName`. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkProviderAdministrator -ProviderId:() -Email:() -ApiKeyAllowed:() -BindNoOrgs:() -EnableMultiFactor:() -Firstname:() -Lastname:() -Role:() -RoleName:() -``` - ----- ---------- -ApiKeyAllowed Boolean -ApiKeySet Boolean -Email String -EnableMultiFactor Boolean -Firstname String -Id String -Lastname String -OrganizationAccessTotal System.Nullable[float] OrganizationAccessTotal {get;set;} -Registered Boolean -Role String -RoleName String -Suspended Boolean - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkProviderAdministrator -ProviderId:() -Body:() -``` - ----- ---------- -ApiKeyAllowed Boolean -ApiKeySet Boolean -Email String -EnableMultiFactor Boolean -Firstname String -Id String -Lastname String -OrganizationAccessTotal System.Nullable[float] OrganizationAccessTotal {get;set;} -Registered Boolean -Role String -RoleName String -Suspended Boolean - -## PARAMETERS - -### -ApiKeyAllowed -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiKeyHashCreatedAt -. - -```yaml -Type: System.DateTime -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiKeyHashExpireAt -. - -```yaml -Type: System.DateTime -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiKeyHashPrefix -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BindNoOrgs -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -ProviderAdminReq - -```yaml -Type: JumpCloud.SDK.V2.Models.IProviderAdminReq -Parameter Sets: Create, CreateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Email -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableMultiFactor -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Firstname -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Lastname -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderId -. - -```yaml -Type: System.String -Parameter Sets: Create, CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Role -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoleName -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.IProviderAdminReq - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IAdministrator - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: ProviderAdminReq - - `Email `: - - `[ApiKeyAllowed ]`: - - `[ApiKeyHashCreatedAt ]`: - - `[ApiKeyHashExpireAt ]`: - - `[ApiKeyHashPrefix ]`: - - `[BindNoOrgs ]`: - - `[EnableMultiFactor ]`: - - `[Firstname ]`: - - `[Lastname ]`: - - `[Role ]`: - - `[RoleName ]`: - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSoftwareApp.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSoftwareApp.md deleted file mode 100644 index 899af73dd..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSoftwareApp.md +++ /dev/null @@ -1,402 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSoftwareApp.md -schema: 2.0.0 ---- - -# New-JcSdkSoftwareApp - -## SYNOPSIS -This endpoint allows you to create a Software Application that will be managed by JumpCloud on associated JumpCloud systems. -The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. - -#### Sample Request -``` -$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '{ - \"displayName\": \"Adobe Reader\", - \"settings\": [{\"packageId\": \"adobereader\"}] -}' -``` - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkSoftwareApp -ConsoleHost [-CreatedAt ] [-DisplayName ] [-Id ] - [-Settings ] [-UpdatedAt ] [-Confirm] [-WhatIf] [] -``` - -### Create -``` -New-JcSdkSoftwareApp -ConsoleHost -Body [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to create a Software Application that will be managed by JumpCloud on associated JumpCloud systems. -The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. - -#### Sample Request -``` -$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '{ - \"displayName\": \"Adobe Reader\", - \"settings\": [{\"packageId\": \"adobereader\"}] -}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkSoftwareApp -DisplayName:() -Id:() -Settings:() -``` - ----- ---------- -DisplayName String -Id String -Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] -UploadUrl String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkSoftwareApp -Body:() -``` - ----- ---------- -DisplayName String -Id String -Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] -UploadUrl String - -## PARAMETERS - -### -Body -Software Application Package - -```yaml -Type: JumpCloud.SDK.V2.Models.ISoftwareApp -Parameter Sets: Create -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreatedAt -. - -```yaml -Type: System.DateTime -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Settings -. - -```yaml -Type: JumpCloud.SDK.V2.Models.ISoftwareAppSettings[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdatedAt -. - -```yaml -Type: System.DateTime -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.ISoftwareApp - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISoftwareAppCreate - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: Software Application Package - - `[CreatedAt ]`: - - `[DisplayName ]`: - - `[Id ]`: - - `[Settings >]`: - - `[AllowUpdateDelay ]`: - - `[AppCatalogInstallableObjectId ]`: ID of the app catalog installable that created this app. - - `[AppFileName ]`: - - `[AppleVppAppConfiguration ]`: Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'. - - `[AppleVppAssignedLicenses ]`: - - `[AppleVppAvailableLicenses ]`: - - `[AppleVppDetails ]`: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. - - `[(Any) ]`: This indicates any property can be added to this object. - - `[AppleVppIsConfigEnabled ]`: Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''. - - `[AppleVppSupportedDeviceFamilies >]`: The supported device families for this VPP Application. - - `[AppleVppTotalLicenses ]`: - - `[Architectures >]`: - - `[AssetKind ]`: The manifest asset kind (ex: software). - - `[AssetSha256Size ]`: The incremental size to use for summing the package as it is downloaded. - - `[AssetSha256Strings >]`: The array of checksums, one each for the hash size up to the total size of the package. - - `[AutoUpdate ]`: - - `[BundleId ]`: - - `[CommandLineArguments ]`: Command line arguments to use with the application. - - `[CreatedAt ]`: - - `[Description ]`: The software app description. - - `[DesiredState ]`: State of Install or Uninstall - - `[DownloadUrl ]`: - - `[EnterpriseObjectId ]`: ID of the Enterprise with which this app is associated - - `[Format ]`: - - `[GoogleAndroidAppPricing ]`: Whether this app is free, free with in-app purchases, or paid. - - `[GoogleAndroidAppVersion ]`: Latest version currently available for this app. - - `[GoogleAndroidAuthor ]`: The name of the author of this app. - - `[GoogleAndroidAutoUpdateMode ]`: Controls the auto-update mode for the app. - - `[GoogleAndroidCategory ]`: The app category (e.g. COMMUNICATION, SOCIAL, etc.). - - `[GoogleAndroidContentRating ]`: The content rating for this app. - - `[GoogleAndroidDisplayMode ]`: The display mode of the web app. - - `[GoogleAndroidDistributionChannel ]`: How and to whom the package is made available. - - `[GoogleAndroidFeatures >]`: The array of android features for the app. - - `[GoogleAndroidFullDescription ]`: Full app description, if available. - - `[GoogleAndroidIconUrl ]`: A link to an image that can be used as an icon for the app. - - `[GoogleAndroidInstallType ]`: The type of installation to perform for an app. - - `[GoogleAndroidManagedConfigurationTemplateId ]`: The managed configurations template for the app. - - `[GoogleAndroidManagedProperties ]`: Indicates whether this app has managed properties or not. - - `[GoogleAndroidMinSdkVersion ]`: The minimum Android SDK necessary to run the app. - - `[GoogleAndroidName ]`: The name of the app in the form enterprises/{enterprise}/applications/{packageName}. - - `[GoogleAndroidPermissionGrants >]`: - - `[Id ]`: An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR. - - `[Policy ]`: The policy for granting the permission. - - `[GoogleAndroidRuntimePermission ]`: The policy for granting permission requests to apps. - - `[GoogleAndroidStartUrl ]`: The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps. - - `[GoogleAndroidType ]`: Type of this android application. - - `[GoogleAndroidUpdateTime ]`: The approximate time (within 7 days) the app was last published. - - `[GoogleAndroidVersionCode ]`: The current version of the web app. - - `[IconUrl ]`: URL to the icon for the app. - - `[Location ]`: Repository where the app is located within the package manager - - `[LocationObjectId ]`: ID of the repository where the app is located within the package manager - - `[MicrosoftStoreDoNotUpdate ]`: Indicates whether the app can be updated or not. - - `[MicrosoftStoreNonRemovable ]`: Indicates whether the app is removable by the users or not. - - `[MicrosoftStorePackageFamilyName ]`: Package Family Name for the app from Microsoft App Store. - - `[ObjectId ]`: - - `[PackageId ]`: - - `[PackageKind ]`: The package manifest kind (ex: software-package). - - `[PackageManager ]`: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. - - `[PackageSubtitle ]`: The package manifest subtitle. - - `[PackageVersion ]`: The package manifest version. - - `[PackageVersionUpdatedAt ]`: - - `[Scope ]`: The installation scope of the software app. - - `[ShortVersion ]`: - - `[StoredPackageObjectId ]`: ID of the stored package this app uses to reference the stored install media. - - `[StoredPackageVersions >]`: - - `[Metadata ]`: Dictionary of - - `[(Any) ]`: This indicates any property can be added to this object. - - `[Name ]`: - - `[RejectedReason ]`: - - `[Sha256Sum ]`: - - `[Size ]`: - - `[Status ]`: - - `[Version ]`: - - `[TeamId ]`: - - `[UpdateTool ]`: - - `[UpdateToolArguments ]`: - - `[UpdatedAt ]`: - - `[VersionlessDownloadUrl ]`: - - `[UpdatedAt ]`: - -`SETTINGS `: . - - `[AllowUpdateDelay ]`: - - `[AppCatalogInstallableObjectId ]`: ID of the app catalog installable that created this app. - - `[AppFileName ]`: - - `[AppleVppAppConfiguration ]`: Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'. - - `[AppleVppAssignedLicenses ]`: - - `[AppleVppAvailableLicenses ]`: - - `[AppleVppDetails ]`: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. - - `[(Any) ]`: This indicates any property can be added to this object. - - `[AppleVppIsConfigEnabled ]`: Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''. - - `[AppleVppSupportedDeviceFamilies >]`: The supported device families for this VPP Application. - - `[AppleVppTotalLicenses ]`: - - `[Architectures >]`: - - `[AssetKind ]`: The manifest asset kind (ex: software). - - `[AssetSha256Size ]`: The incremental size to use for summing the package as it is downloaded. - - `[AssetSha256Strings >]`: The array of checksums, one each for the hash size up to the total size of the package. - - `[AutoUpdate ]`: - - `[BundleId ]`: - - `[CommandLineArguments ]`: Command line arguments to use with the application. - - `[CreatedAt ]`: - - `[Description ]`: The software app description. - - `[DesiredState ]`: State of Install or Uninstall - - `[DownloadUrl ]`: - - `[EnterpriseObjectId ]`: ID of the Enterprise with which this app is associated - - `[Format ]`: - - `[GoogleAndroidAppPricing ]`: Whether this app is free, free with in-app purchases, or paid. - - `[GoogleAndroidAppVersion ]`: Latest version currently available for this app. - - `[GoogleAndroidAuthor ]`: The name of the author of this app. - - `[GoogleAndroidAutoUpdateMode ]`: Controls the auto-update mode for the app. - - `[GoogleAndroidCategory ]`: The app category (e.g. COMMUNICATION, SOCIAL, etc.). - - `[GoogleAndroidContentRating ]`: The content rating for this app. - - `[GoogleAndroidDisplayMode ]`: The display mode of the web app. - - `[GoogleAndroidDistributionChannel ]`: How and to whom the package is made available. - - `[GoogleAndroidFeatures >]`: The array of android features for the app. - - `[GoogleAndroidFullDescription ]`: Full app description, if available. - - `[GoogleAndroidIconUrl ]`: A link to an image that can be used as an icon for the app. - - `[GoogleAndroidInstallType ]`: The type of installation to perform for an app. - - `[GoogleAndroidManagedConfigurationTemplateId ]`: The managed configurations template for the app. - - `[GoogleAndroidManagedProperties ]`: Indicates whether this app has managed properties or not. - - `[GoogleAndroidMinSdkVersion ]`: The minimum Android SDK necessary to run the app. - - `[GoogleAndroidName ]`: The name of the app in the form enterprises/{enterprise}/applications/{packageName}. - - `[GoogleAndroidPermissionGrants >]`: - - `[Id ]`: An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR. - - `[Policy ]`: The policy for granting the permission. - - `[GoogleAndroidRuntimePermission ]`: The policy for granting permission requests to apps. - - `[GoogleAndroidStartUrl ]`: The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps. - - `[GoogleAndroidType ]`: Type of this android application. - - `[GoogleAndroidUpdateTime ]`: The approximate time (within 7 days) the app was last published. - - `[GoogleAndroidVersionCode ]`: The current version of the web app. - - `[IconUrl ]`: URL to the icon for the app. - - `[Location ]`: Repository where the app is located within the package manager - - `[LocationObjectId ]`: ID of the repository where the app is located within the package manager - - `[MicrosoftStoreDoNotUpdate ]`: Indicates whether the app can be updated or not. - - `[MicrosoftStoreNonRemovable ]`: Indicates whether the app is removable by the users or not. - - `[MicrosoftStorePackageFamilyName ]`: Package Family Name for the app from Microsoft App Store. - - `[ObjectId ]`: - - `[PackageId ]`: - - `[PackageKind ]`: The package manifest kind (ex: software-package). - - `[PackageManager ]`: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. - - `[PackageSubtitle ]`: The package manifest subtitle. - - `[PackageVersion ]`: The package manifest version. - - `[PackageVersionUpdatedAt ]`: - - `[Scope ]`: The installation scope of the software app. - - `[ShortVersion ]`: - - `[StoredPackageObjectId ]`: ID of the stored package this app uses to reference the stored install media. - - `[StoredPackageVersions >]`: - - `[Metadata ]`: Dictionary of - - `[(Any) ]`: This indicates any property can be added to this object. - - `[Name ]`: - - `[RejectedReason ]`: - - `[Sha256Sum ]`: - - `[Size ]`: - - `[Status ]`: - - `[Version ]`: - - `[TeamId ]`: - - `[UpdateTool ]`: - - `[UpdateToolArguments ]`: - - `[UpdatedAt ]`: - - `[VersionlessDownloadUrl ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSystemGroup.md deleted file mode 100644 index 4d3c55924..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSystemGroup.md +++ /dev/null @@ -1,353 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSystemGroup.md -schema: 2.0.0 ---- - -# New-JcSdkSystemGroup - -## SYNOPSIS -This endpoint allows you to create a new System Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"{Group_Name}\" - }' -``` - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkSystemGroup -ConsoleHost [-Attributes ] [-Description ] [-Email ] - [-MemberQueryExemptions ] [-MemberQueryFilters ] - [-MemberQuerySearchFilters ] [-MemberQueryType ] [-MembershipMethod ] - [-MemberSuggestionsNotify] [-Name ] [-Confirm] [-WhatIf] [] -``` - -### Create -``` -New-JcSdkSystemGroup -ConsoleHost -Body [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to create a new System Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/systemgroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"{Group_Name}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkSystemGroup -Name:() -Attributes:() -Description:() -Email:() -MemberQueryExemptions:() -MemberQueryFilters:() -MemberQueryType:() -MemberSuggestionsNotify:() -MembershipMethod:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkSystemGroup -Body:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -Type String - -## PARAMETERS - -### -Attributes -The graph attributes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -SystemGroupPost - -```yaml -Type: JumpCloud.SDK.V2.Models.ISystemGroupPost -Parameter Sets: Create -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Description of a System Group - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Email -Email address of a System Group - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberQueryExemptions -Array of GraphObjects exempted from the query - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphObject[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberQueryFilters -For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. - -```yaml -Type: System.String[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberQuerySearchFilters -For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberQueryType -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MembershipMethod -The type of membership method for this group. -Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED.Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices).Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberSuggestionsNotify -True if notification emails are to be sent for membership suggestions. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Display name of a System Group. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.ISystemGroupPost - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemGroup - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: SystemGroupPost - - `Name `: Display name of a System Group. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - - `[Description ]`: Description of a System Group - - `[Email ]`: Email address of a System Group - - `[MemberQueryExemptions >]`: Array of GraphObjects exempted from the query - - `Id `: The ObjectID of the graph object. - - `Type `: The type of graph object. - - `[Attributes ]`: The graph attributes. - - `[MemberQueryFilters >]`: For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. - - `[MemberQuerySearchFilters ]`: For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. - - `[MemberQueryType ]`: - - `[MemberSuggestionsNotify ]`: True if notification emails are to be sent for membership suggestions. - - `[MembershipMethod ]`: The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED. Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices). Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. - -`MEMBERQUERYEXEMPTIONS `: Array of GraphObjects exempted from the query - - `Id `: The ObjectID of the graph object. - - `Type `: The type of graph object. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkUserGroup.md deleted file mode 100644 index 0d1f703b3..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkUserGroup.md +++ /dev/null @@ -1,369 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkUserGroup.md -schema: 2.0.0 ---- - -# New-JcSdkUserGroup - -## SYNOPSIS -This endpoint allows you to create a new User Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"{Group_Name}\" - }' -``` - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkUserGroup -ConsoleHost [-Attributes ] [-Description ] [-Email ] - [-MemberQueryExemptions ] [-MemberQueryFilters ] - [-MemberQuerySearchFilters ] [-MemberQueryType ] [-MembershipMethod ] - [-MemberSuggestionsNotify] [-Name ] [-Confirm] [-WhatIf] [] -``` - -### Create -``` -New-JcSdkUserGroup -ConsoleHost -Body [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to create a new User Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/usergroups \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"{Group_Name}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkUserGroup -Name:() -Attributes:() -Description:() -Email:() -MemberQueryExemptions:() -MemberQueryFilters:() -MemberQueryType:() -MemberSuggestionsNotify:() -MembershipMethod:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -SuggestionCountAdd Int -SuggestionCountRemove Int -SuggestionCountTotal Int -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkUserGroup -Body:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -SuggestionCountAdd Int -SuggestionCountRemove Int -SuggestionCountTotal Int -Type String - -## PARAMETERS - -### -Attributes -The graph attributes for a UserGroup. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -UserGroupPost - -```yaml -Type: JumpCloud.SDK.V2.Models.IUserGroupPost -Parameter Sets: Create -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Description of a User Group - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Email -Email address of a User Group - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberQueryExemptions -Array of GraphObjects exempted from the query - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphObject[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberQueryFilters -For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. - -```yaml -Type: System.String[] -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberQuerySearchFilters -For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberQueryType -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MembershipMethod -The type of membership method for this group. -Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED.Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices).Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberSuggestionsNotify -True if notification emails are to be sent for membership suggestions. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Display name of a User Group. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IUserGroupPost - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IUserGroup - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: UserGroupPost - - `Name `: Display name of a User Group. - - `[Attributes ]`: The graph attributes for a UserGroup. - - `[(Any) ]`: This indicates any property can be added to this object. - - `[SudoEnabled ]`: Enables sudo - - `[SudoWithoutPassword ]`: Enable sudo without password (requires 'enabled' to be true) - - `[LdapGroups >]`: - - `[Name ]`: - - `[PosixGroups >]`: - - `Id `: - - `Name `: - - `[RadiusReply >]`: - - `Name `: - - `Value `: - - `[SambaEnabled ]`: - - `[Description ]`: Description of a User Group - - `[Email ]`: Email address of a User Group - - `[MemberQueryExemptions >]`: Array of GraphObjects exempted from the query - - `Id `: The ObjectID of the graph object. - - `Type `: The type of graph object. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - - `[MemberQueryFilters >]`: For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. - - `[MemberQuerySearchFilters ]`: For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. - - `[MemberQueryType ]`: - - `[MemberSuggestionsNotify ]`: True if notification emails are to be sent for membership suggestions. - - `[MembershipMethod ]`: The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED. Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices). Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. - -`MEMBERQUERYEXEMPTIONS `: Array of GraphObjects exempted from the query - - `Id `: The ObjectID of the graph object. - - `Type `: The type of graph object. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkWorkday.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkWorkday.md deleted file mode 100644 index f8a38dc5e..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkWorkday.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkWorkday.md -schema: 2.0.0 ---- - -# New-JcSdkWorkday - -## SYNOPSIS -This endpoint allows you to create a new workday instance. - -You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. -Failure to provide these credentials will result in the request being rejected. - -Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. - -Currently, only one instance is allowed and it must be `Workday Import`. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Workday2\", - \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", - \"auth\": { - \"basic\": { - \"username\": \"someDeveloper\", - \"password\": \"notTheRealPassword\" - } - } - }' -``` - -## SYNTAX - -### CreateExpanded (Default) -``` -New-JcSdkWorkday -ConsoleHost [-BasicPassword ] [-BasicUsername ] [-Name ] - [-OauthCode ] [-ReportUrl ] [-Confirm] [-WhatIf] [] -``` - -### Create -``` -New-JcSdkWorkday -ConsoleHost -Body [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to create a new workday instance. - -You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. -Failure to provide these credentials will result in the request being rejected. - -Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. - -Currently, only one instance is allowed and it must be `Workday Import`. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Workday2\", - \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", - \"auth\": { - \"basic\": { - \"username\": \"someDeveloper\", - \"password\": \"notTheRealPassword\" - } - } - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -New-JcSdkWorkday -BasicPassword:() -BasicUsername:() -Name:() -OauthCode:() -ReportUrl:() -``` - ----- ---------- -BasicExpiry String -BasicIsValid Boolean -BasicMessage String -Id String -LastImport String -Name String -OauthExpiry String -OauthIsValid Boolean -OauthMessage String -ReportUrl String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -New-JcSdkWorkday -Body:() -``` - ----- ---------- -BasicExpiry String -BasicIsValid Boolean -BasicMessage String -Id String -LastImport String -Name String -OauthExpiry String -OauthIsValid Boolean -OauthMessage String -ReportUrl String - -## PARAMETERS - -### -BasicPassword -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BasicUsername -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -Workday Input - -```yaml -Type: JumpCloud.SDK.V2.Models.IWorkdayInput -Parameter Sets: Create -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OauthCode -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportUrl -. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IWorkdayInput - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IWorkdayOutput - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: Workday Input - - `[BasicPassword ]`: - - `[BasicUsername ]`: - - `[Name ]`: - - `[OauthCode ]`: - - `[ReportUrl ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectory.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectory.md deleted file mode 100644 index 929746cb7..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectory.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectory.md -schema: 2.0.0 ---- - -# Remove-JcSdkActiveDirectory - -## SYNOPSIS -This endpoint allows you to delete an Active Directory Instance. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkActiveDirectory -ConsoleHost -Id [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkActiveDirectory -ConsoleHost -InputObject [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint allows you to delete an Active Directory Instance. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkActiveDirectory -Id:() -``` - ----- ---------- -Domain String -Id String -PrimaryAgent String -UseCase String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -ObjectID of this Active Directory instance. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IActiveDirectory - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectoryAgent.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectoryAgent.md deleted file mode 100644 index 5f919c15c..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectoryAgent.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectoryAgent.md -schema: 2.0.0 ---- - -# Remove-JcSdkActiveDirectoryAgent - -## SYNOPSIS -This endpoint deletes an Active Directory agent. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkActiveDirectoryAgent -ConsoleHost -ActivedirectoryId -AgentId - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkActiveDirectoryAgent -ConsoleHost -InputObject [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint deletes an Active Directory agent. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -AgentId:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ActivedirectoryId -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgentId -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAdministratorOrganization.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAdministratorOrganization.md deleted file mode 100644 index ebb6352e1..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAdministratorOrganization.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAdministratorOrganization.md -schema: 2.0.0 ---- - -# Remove-JcSdkAdministratorOrganization - -## SYNOPSIS -This endpoint removes the association link between an Administrator and an Organization. - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkAdministratorOrganization -ConsoleHost -AdministratorId -Id [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkAdministratorOrganization -ConsoleHost -InputObject [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint removes the association link between an Administrator and an Organization. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkAdministratorOrganization -AdministratorId:() -Id:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -AdministratorId -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdm.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdm.md deleted file mode 100644 index 465964c91..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdm.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdm.md -schema: 2.0.0 ---- - -# Remove-JcSdkAppleMdm - -## SYNOPSIS -Removes an Apple MDM configuration. - -Warning: This is a destructive operation and will remove your Apple Push Certificates. -We will no longer be able to manage your devices and the only recovery option is to re-register all devices into MDM. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkAppleMdm -ConsoleHost -Id [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkAppleMdm -ConsoleHost -InputObject [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -Removes an Apple MDM configuration. - -Warning: This is a destructive operation and will remove your Apple Push Certificates. -We will no longer be able to manage your devices and the only recovery option is to re-register all devices into MDM. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkAppleMdm -Id:() -``` - ----- ---------- -AllowMobileUserEnrollment Boolean -ApnsCertExpiry String -ApnsPushTopic String -AppleCertCreatorAppleId String -AppleCertSerialNumber String -DefaultIosUserEnrollmentDeviceGroupId String -DefaultSystemGroupId String -DepAccessTokenExpiry String -DepEnableZeroTouchEnrollment Boolean -DepServerTokenState String -DepSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -Id String -IoDefaultDeviceGroupObjectIds String -IoEnableZeroTouchEnrollment Boolean -IoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -IoSetupOptions String -IosWelcomeScreenButton String -IosWelcomeScreenParagraph String -IosWelcomeScreenTitle String -MacoDefaultDeviceGroupObjectIds String -MacoEnableZeroTouchEnrollment Boolean -MacoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -MacoSetupOptions String -MacosWelcomeScreenButton String -MacosWelcomeScreenParagraph String -MacosWelcomeScreenTitle String -Name String -Organization String -WelcomeScreenButton String -WelcomeScreenParagraph String -WelcomeScreenTitle String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IAppleMdm - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdmDevice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdmDevice.md deleted file mode 100644 index 2e18e2859..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdmDevice.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdmDevice.md -schema: 2.0.0 ---- - -# Remove-JcSdkAppleMdmDevice - -## SYNOPSIS -Remove a single Apple MDM device from MDM enrollment. - -#### Sample Request -``` - curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ - -H 'accept: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId [-Confirm] [-WhatIf] - [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkAppleMdmDevice -ConsoleHost -InputObject [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -Remove a single Apple MDM device from MDM enrollment. - -#### Sample Request -``` - curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ - -H 'accept: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -``` - ----- ---------- -CreatedAt String -DepRegistered Boolean -DeviceInformationActivationLockAllowedWhileSupervised Boolean -DeviceInformationAvailableDeviceCapacity System.Nullable[float] DeviceInformationAvailableDeviceCapacity {get;set;} -DeviceInformationDeviceCapacity System.Nullable[float] DeviceInformationDeviceCapacity {get;set;} -DeviceInformationDeviceName String -DeviceInformationIccid String -DeviceInformationImei String -DeviceInformationIsSupervised Boolean -DeviceInformationModelName String -DeviceInformationSecondIccid String -DeviceInformationSecondImei String -DeviceInformationSecondSubscriberCarrierNetwork String -DeviceInformationSubscriberCarrierNetwork String -DeviceInformationWifiMac String -Enrolled Boolean -HasActivationLockBypassCodes Boolean -Id String -OSVersion String -SecurityInfoEnrolledViaDep Boolean -SecurityInfoIsActivationLockManageable Boolean -SecurityInfoIsUserEnrollment Boolean -SecurityInfoPasscodePresent Boolean -SecurityInfoUserApprovedEnrollment Boolean -SerialNumber String -Udid String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -AppleMdmId -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeviceId -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IAppleMdmDevice - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApplicationLogo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApplicationLogo.md deleted file mode 100644 index e5113f031..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApplicationLogo.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApplicationLogo.md -schema: 2.0.0 ---- - -# Remove-JcSdkApplicationLogo - -## SYNOPSIS -Deletes the specified image from an application - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkApplicationLogo -ConsoleHost -ApplicationId [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkApplicationLogo -ConsoleHost -InputObject [-PassThru] [-Confirm] - [-WhatIf] [] -``` - -## DESCRIPTION -Deletes the specified image from an application - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkApplicationLogo -ApplicationId:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ApplicationId -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApprovalFlow.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApprovalFlow.md deleted file mode 100644 index 20b90fb35..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApprovalFlow.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApprovalFlow.md -schema: 2.0.0 ---- - -# Remove-JcSdkApprovalFlow - -## SYNOPSIS -Endpoint for deleting accessworkflow by id - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkApprovalFlow -ConsoleHost -ApprovalFlowId [-OrganizationObjectId ] - [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkApprovalFlow -ConsoleHost -InputObject - [-OrganizationObjectId ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Endpoint for deleting accessworkflow by id - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkApprovalFlow -ApprovalFlowId:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - - - -## PARAMETERS - -### -ApprovalFlowId -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OrganizationObjectId -. - -```yaml -Type: System.Byte[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IJumpcloudIngressoDeleteAccessWorkflowResponse - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAuthenticationPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAuthenticationPolicy.md deleted file mode 100644 index 7c5e414eb..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAuthenticationPolicy.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAuthenticationPolicy.md -schema: 2.0.0 ---- - -# Remove-JcSdkAuthenticationPolicy - -## SYNOPSIS -Delete the specified authentication policy. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkAuthenticationPolicy -ConsoleHost -Id [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkAuthenticationPolicy -ConsoleHost -InputObject [-Confirm] - [-WhatIf] [] -``` - -## DESCRIPTION -Delete the specified authentication policy. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkAuthenticationPolicy -Id:() -``` - ----- ---------- -Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions -Description String -Disabled Boolean -EffectAction String -Id String -MfaRequired Boolean -Name String -TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] -Type String -UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserGroupExclusions String -UserGroupInclusions String -UserInclusions String -UserVerificationRequirement String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Unique identifier of the authentication policy - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IAuthnPolicy - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkBulkUserState.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkBulkUserState.md deleted file mode 100644 index 027b4a92a..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkBulkUserState.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkBulkUserState.md -schema: 2.0.0 ---- - -# Remove-JcSdkBulkUserState - -## SYNOPSIS -This endpoint deletes a scheduled statechange job. -#### Sample Request -``` -curl -X DELETE \"https://console.jumpcloud.com/api/v2/bulk/userstates/{ScheduledJob_ID}\" \\ - -H 'x-api-key: {API_KEY}' \\ - -H 'Content-Type: application/json' \\ - -H 'Accept: application/json' -``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkBulkUserState -ConsoleHost -Id [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkBulkUserState -ConsoleHost -InputObject [-PassThru] [-Confirm] - [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint deletes a scheduled statechange job. -#### Sample Request -``` -curl -X DELETE \"https://console.jumpcloud.com/api/v2/bulk/userstates/{ScheduledJob_ID}\" \\ - -H 'x-api-key: {API_KEY}' \\ - -H 'Content-Type: application/json' \\ - -H 'Accept: application/json' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkBulkUserState -Id:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Unique identifier of the scheduled statechange job. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkCustomEmailConfiguration.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkCustomEmailConfiguration.md deleted file mode 100644 index f873e3aa7..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkCustomEmailConfiguration.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkCustomEmailConfiguration.md -schema: 2.0.0 ---- - -# Remove-JcSdkCustomEmailConfiguration - -## SYNOPSIS -Delete the custom email configuration for the specified custom email type - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkCustomEmailConfiguration -ConsoleHost -CustomEmailType [-PassThru] [-Confirm] - [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkCustomEmailConfiguration -ConsoleHost -InputObject [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Delete the custom email configuration for the specified custom email type - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkCustomEmailConfiguration -CustomEmailType:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomEmailType -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoAccount.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoAccount.md deleted file mode 100644 index 50d59a557..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoAccount.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoAccount.md -schema: 2.0.0 ---- - -# Remove-JcSdkDuoAccount - -## SYNOPSIS -Removes the specified Duo account, an error will be returned if the account has some Duo application used in a protected resource. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkDuoAccount -ConsoleHost -Id [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkDuoAccount -ConsoleHost -InputObject [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -Removes the specified Duo account, an error will be returned if the account has some Duo application used in a protected resource. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkDuoAccount -Id:() -``` - ----- ---------- -Id String -Name String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -ObjectID of the Duo Account - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IDuoAccount - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoApplication.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoApplication.md deleted file mode 100644 index d0106f8d4..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoApplication.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoApplication.md -schema: 2.0.0 ---- - -# Remove-JcSdkDuoApplication - -## SYNOPSIS -Deletes the specified Duo application, an error will be returned if the application is used in a protected resource. - -#### Sample Request -``` - curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}'' -``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkDuoApplication -ConsoleHost -AccountId -ApplicationId [-Confirm] - [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkDuoApplication -ConsoleHost -InputObject [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -Deletes the specified Duo application, an error will be returned if the application is used in a protected resource. - -#### Sample Request -``` - curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}'' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkDuoApplication -AccountId:() -ApplicationId:() -``` - ----- ---------- -ApiHost String -Id String -IntegrationKey String -Name String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -AccountId -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationId -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IDuoApplication - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkGSuiteTranslationRule.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkGSuiteTranslationRule.md deleted file mode 100644 index a966b97f1..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkGSuiteTranslationRule.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkGSuiteTranslationRule.md -schema: 2.0.0 ---- - -# Remove-JcSdkGSuiteTranslationRule - -## SYNOPSIS -This endpoint allows you to delete a translation rule for a specific G Suite instance. -These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. - -#### Sample Request - -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkGSuiteTranslationRule -ConsoleHost -GsuiteId -Id [-PassThru] [-Confirm] - [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkGSuiteTranslationRule -ConsoleHost -InputObject [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to delete a translation rule for a specific G Suite instance. -These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. - -#### Sample Request - -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkGSuiteTranslationRule -GsuiteId:() -Id:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GsuiteId -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkIPList.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkIPList.md deleted file mode 100644 index bc1a5c2ab..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkIPList.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkIPList.md -schema: 2.0.0 ---- - -# Remove-JcSdkIPList - -## SYNOPSIS -Delete a specific IP list. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkIPList -ConsoleHost -Id [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkIPList -ConsoleHost -InputObject [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -Delete a specific IP list. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkIPList -Id:() -``` - ----- ---------- -Description String -Id String -Ips String -Name String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IIPList - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkLdapServerSambaDomain.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkLdapServerSambaDomain.md deleted file mode 100644 index 50372ece5..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkLdapServerSambaDomain.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkLdapServerSambaDomain.md -schema: 2.0.0 ---- - -# Remove-JcSdkLdapServerSambaDomain - -## SYNOPSIS -This endpoint allows you to delete a samba domain from an LDAP server. - -##### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkLdapServerSambaDomain -ConsoleHost -Id -LdapserverId [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkLdapServerSambaDomain -ConsoleHost -InputObject [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to delete a samba domain from an LDAP server. - -##### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkLdapServerSambaDomain -Id:() -LdapserverId:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Unique identifier of the samba domain. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LdapserverId -Unique identifier of the LDAP server. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.String - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkOffice365TranslationRule.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkOffice365TranslationRule.md deleted file mode 100644 index 5be2719bd..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkOffice365TranslationRule.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkOffice365TranslationRule.md -schema: 2.0.0 ---- - -# Remove-JcSdkOffice365TranslationRule - -## SYNOPSIS -This endpoint allows you to delete a translation rule for a specific Office 365 instance. -These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. - -#### Sample Request - -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkOffice365TranslationRule -ConsoleHost -Id -Office365Id [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkOffice365TranslationRule -ConsoleHost -InputObject [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to delete a translation rule for a specific Office 365 instance. -These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. - -#### Sample Request - -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkOffice365TranslationRule -Id:() -Office365Id:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Office365Id -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicy.md deleted file mode 100644 index dcc7e2464..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicy.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicy.md -schema: 2.0.0 ---- - -# Remove-JcSdkPolicy - -## SYNOPSIS -This endpoint allows you to delete a policy. - -#### Sample Request - -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/policies/5a837ecd232e110d4291e6b9 \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkPolicy -ConsoleHost -Id [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkPolicy -ConsoleHost -InputObject [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint allows you to delete a policy. - -#### Sample Request - -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/policies/5a837ecd232e110d4291e6b9 \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - ``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkPolicy -Id:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -ObjectID of the Policy object. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicyGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicyGroup.md deleted file mode 100644 index cde6cb890..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicyGroup.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicyGroup.md -schema: 2.0.0 ---- - -# Remove-JcSdkPolicyGroup - -## SYNOPSIS -This endpoint allows you to delete a Policy Group. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkPolicyGroup -ConsoleHost -Id [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkPolicyGroup -ConsoleHost -InputObject [-PassThru] [-Confirm] - [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to delete a Policy Group. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkPolicyGroup -Id:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -Name String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -ObjectID of the Policy Group. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPolicyGroup - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkProviderAdministrator.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkProviderAdministrator.md deleted file mode 100644 index f6a03f48c..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkProviderAdministrator.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkProviderAdministrator.md -schema: 2.0.0 ---- - -# Remove-JcSdkProviderAdministrator - -## SYNOPSIS -This endpoint removes an Administrator associated with the Provider. -You must be associated with the provider to use this route. - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkProviderAdministrator -ConsoleHost -Id -ProviderId [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkProviderAdministrator -ConsoleHost -InputObject [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint removes an Administrator associated with the Provider. -You must be associated with the provider to use this route. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkProviderAdministrator -Id:() -ProviderId:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderId -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSoftwareApp.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSoftwareApp.md deleted file mode 100644 index 4f70c6514..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSoftwareApp.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSoftwareApp.md -schema: 2.0.0 ---- - -# Remove-JcSdkSoftwareApp - -## SYNOPSIS -Removes a Software Application configuration. - -Warning: This is a destructive operation and will unmanage the application on all affected systems. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkSoftwareApp -ConsoleHost -Id [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkSoftwareApp -ConsoleHost -InputObject [-PassThru] [-Confirm] - [-WhatIf] [] -``` - -## DESCRIPTION -Removes a Software Application configuration. - -Warning: This is a destructive operation and will unmanage the application on all affected systems. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkSoftwareApp -Id:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSystemGroup.md deleted file mode 100644 index c32cafeb4..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSystemGroup.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSystemGroup.md -schema: 2.0.0 ---- - -# Remove-JcSdkSystemGroup - -## SYNOPSIS -This endpoint allows you to delete a System Group. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkSystemGroup -ConsoleHost -Id [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkSystemGroup -ConsoleHost -InputObject [-PassThru] [-Confirm] - [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to delete a System Group. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkSystemGroup -Id:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -ObjectID of the System Group. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemGroup - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserGroup.md deleted file mode 100644 index f332fa831..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserGroup.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserGroup.md -schema: 2.0.0 ---- - -# Remove-JcSdkUserGroup - -## SYNOPSIS -This endpoint allows you to delete a User Group. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkUserGroup -ConsoleHost -Id [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkUserGroup -ConsoleHost -InputObject [-PassThru] [-Confirm] - [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to delete a User Group. - -#### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' - -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkUserGroup -Id:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -SuggestionCountAdd Int -SuggestionCountRemove Int -SuggestionCountTotal Int -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -ObjectID of the User Group. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IUserGroup - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserPushEndpoint.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserPushEndpoint.md deleted file mode 100644 index bc99b9591..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserPushEndpoint.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserPushEndpoint.md -schema: 2.0.0 ---- - -# Remove-JcSdkUserPushEndpoint - -## SYNOPSIS -This endpoint will delete a push endpoint associated with a user. - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkUserPushEndpoint -ConsoleHost -PushEndpointId -UserId [-Confirm] - [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkUserPushEndpoint -ConsoleHost -InputObject [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint will delete a push endpoint associated with a user. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkUserPushEndpoint -PushEndpointId:() -UserId:() -``` - ----- ---------- -DeviceAppVersion String -DeviceMake String -DeviceModel String -DeviceOS String -DeviceOSVersion String -DeviceUvEnabled Boolean -EnrollmentDate Datetime -Id String -LastUsedDate Datetime -Name String -State String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PushEndpointId -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPushEndpointResponse - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkWorkdayAuthorization.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkWorkdayAuthorization.md deleted file mode 100644 index 7648b5a66..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkWorkdayAuthorization.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkWorkdayAuthorization.md -schema: 2.0.0 ---- - -# Remove-JcSdkWorkdayAuthorization - -## SYNOPSIS -Removes any and all authorization methods from the workday instance - -##### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## SYNTAX - -### Delete (Default) -``` -Remove-JcSdkWorkdayAuthorization -ConsoleHost -WorkdayId [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### DeleteViaIdentity -``` -Remove-JcSdkWorkdayAuthorization -ConsoleHost -InputObject [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Removes any and all authorization methods from the workday instance - -##### Sample Request -``` -curl -X DELETE https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Remove-JcSdkWorkdayAuthorization -WorkdayId:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkdayId -. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Restart-JcSdkAppleMdmDevice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Restart-JcSdkAppleMdmDevice.md deleted file mode 100644 index b85bd1b4b..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Restart-JcSdkAppleMdmDevice.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Restart-JcSdkAppleMdmDevice.md -schema: 2.0.0 ---- - -# Restart-JcSdkAppleMdmDevice - -## SYNOPSIS -Restarts a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/restart \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{\"kextPaths\": [\"Path1\", \"Path2\"]}' -``` - -## SYNTAX - -### RestartExpanded (Default) -``` -Restart-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId - [-KextPaths ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Restart -``` -Restart-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId - -Body - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### RestartViaIdentity -``` -Restart-JcSdkAppleMdmDevice -ConsoleHost -InputObject - -Body - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### RestartViaIdentityExpanded -``` -Restart-JcSdkAppleMdmDevice -ConsoleHost -InputObject [-KextPaths ] - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Restarts a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/restart \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{\"kextPaths\": [\"Path1\", \"Path2\"]}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Restart-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Restart-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -KextPaths:() -``` - - - -## PARAMETERS - -### -AppleMdmId -. - -```yaml -Type: System.String -Parameter Sets: Restart, RestartExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IPaths1Whnyt3ApplemdmsAppleMdmIdDevicesDeviceIdRestartPostRequestbodyContentApplicationJsonSchema -Parameter Sets: Restart, RestartViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeviceId -. - -```yaml -Type: System.String -Parameter Sets: Restart, RestartExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: RestartViaIdentity, RestartViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KextPaths -The string to pass when doing a restart and performing a RebuildKernelCache. - -```yaml -Type: System.String[] -Parameter Sets: RestartExpanded, RestartViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.IPaths1Whnyt3ApplemdmsAppleMdmIdDevicesDeviceIdRestartPostRequestbodyContentApplicationJsonSchema - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: . - - `[KextPaths >]`: The string to pass when doing a restart and performing a RebuildKernelCache. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequest.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequest.md deleted file mode 100644 index cdb2b17e8..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequest.md +++ /dev/null @@ -1,301 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequest.md -schema: 2.0.0 ---- - -# Set-JcSdkAccessRequest - -## SYNOPSIS -Endpoint that set the workflow access request by id - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkAccessRequest -ConsoleHost -Id [-Admin ] [-ApprovedDuration ] - [-InternalNote ] [-OrganizationObjectIdInputFile ] [-Remarks ] [-Status ] - [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkAccessRequest -ConsoleHost -Id - -Body [-Confirm] [-WhatIf] - [] -``` - -### SetViaIdentity -``` -Set-JcSdkAccessRequest -ConsoleHost -InputObject - -Body [-Confirm] [-WhatIf] - [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkAccessRequest -ConsoleHost -InputObject [-Admin ] - [-ApprovedDuration ] [-InternalNote ] [-OrganizationObjectIdInputFile ] - [-Remarks ] [-Status ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Endpoint that set the workflow access request by id - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkAccessRequest -Id:() -Admin:() -ApprovedDuration:() -InternalNote:() -OrganizationObjectIdInputFile:() -Remarks:() -Status:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkAccessRequest -Id:() -Body:() -``` - - - -## PARAMETERS - -### -Admin -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApprovedDuration -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IPaths17F25RsApprovalflowrequestIdPutRequestbodyContentApplicationJsonSchema -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InternalNote -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationObjectIdInputFile -Input File for OrganizationObjectId (.) - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remarks -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.IPaths17F25RsApprovalflowrequestIdPutRequestbodyContentApplicationJsonSchema - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateWorkflowAccessRequestResponse - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: . - - `[Admin ]`: - - `[ApprovedDuration ]`: - - `[InternalNote ]`: - - `[OrganizationObjectId ]`: - - `[Remarks ]`: - - `[Status ]`: - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequestApproval.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequestApproval.md deleted file mode 100644 index 9540d8325..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequestApproval.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequestApproval.md -schema: 2.0.0 ---- - -# Set-JcSdkAccessRequestApproval - -## SYNOPSIS -Endpoint for user approval - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkAccessRequestApproval -ConsoleHost [-ApprovedDuration ] [-Id ] - [-OrganizationObjectIdInputFile ] [-Remarks ] [-Status ] [-Confirm] [-WhatIf] - [] -``` - -### Set -``` -Set-JcSdkAccessRequestApproval -ConsoleHost -Body [-Confirm] - [-WhatIf] [] -``` - -## DESCRIPTION -Endpoint for user approval - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkAccessRequestApproval -ApprovedDuration:() -Id:() -OrganizationObjectIdInputFile:() -Remarks:() -Status:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkAccessRequestApproval -Body:() -``` - - - -## PARAMETERS - -### -ApprovedDuration -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpcloudIngressoUserApprovalRequest -Parameter Sets: Set -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationObjectIdInputFile -Input File for OrganizationObjectId (.) - -```yaml -Type: System.String -Parameter Sets: SetExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remarks -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpcloudIngressoUserApprovalRequest - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IJumpcloudIngressoUserApprovalRequestResponse - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: . - - `[ApprovedDuration ]`: - - `[Id ]`: - - `[OrganizationObjectId ]`: - - `[Remarks ]`: - - `[Status ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkActiveDirectoryAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkActiveDirectoryAssociation.md deleted file mode 100644 index 485230d56..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkActiveDirectoryAssociation.md +++ /dev/null @@ -1,313 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkActiveDirectoryAssociation.md -schema: 2.0.0 ---- - -# Set-JcSdkActiveDirectoryAssociation - -## SYNOPSIS -This endpoint allows you to manage the _direct_ associations of an Active Directory instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{AD_Instance_ID}/associations \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{User_ID}\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkActiveDirectoryAssociation -ConsoleHost -ActivedirectoryId - [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### Set -``` -Set-JcSdkActiveDirectoryAssociation -ConsoleHost -ActivedirectoryId - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkActiveDirectoryAssociation -ConsoleHost -InputObject - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkActiveDirectoryAssociation -ConsoleHost -InputObject - [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint allows you to manage the _direct_ associations of an Active Directory instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{AD_Instance_ID}/associations \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{User_ID}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkActiveDirectoryAssociation -ActivedirectoryId:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkActiveDirectoryAssociation -ActivedirectoryId:() -Id:() -Op:() -Type:() -Attributes:() -``` - - - -## PARAMETERS - -### -ActivedirectoryId -. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Attributes -The graph attributes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -GraphOperation (ActiveDirectory) - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphOperationActiveDirectoryAutoGenerated -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectID of graph object being added or removed as an association. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Op -How to modify the graph connection. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Targets which a "active_directory" can be associated to. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGraphOperationActiveDirectoryAutoGenerated - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GraphOperation (ActiveDirectory) - - `Id `: The ObjectID of graph object being added or removed as an association. - - `Op `: How to modify the graph connection. - - `Type `: Targets which a "active_directory" can be associated to. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAppleMdm.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAppleMdm.md deleted file mode 100644 index 585539567..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAppleMdm.md +++ /dev/null @@ -1,755 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAppleMdm.md -schema: 2.0.0 ---- - -# Set-JcSdkAppleMdm - -## SYNOPSIS -Set an Apple MDM configuration. -This endpoint is used to supply JumpCloud with a signed certificate from Apple in order to finalize the setup and allow JumpCloud to manage your devices. -It may also be used to set the DEP Settings. - -#### Sample Request -``` - curl -X PUT https://console.jumpcloud.com/api/v2/applemdms/{ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"MDM name\", - \"appleSignedCert\": \"{CERTIFICATE}\", - \"encryptedDepServerToken\": \"{SERVER_TOKEN}\", - \"dep\": { - \"welcomeScreen\": { - \"title\": \"Welcome\", - \"paragraph\": \"In just a few steps, you will be working securely from your Mac.\", - \"button\": \"continue\", - }, - }, - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkAppleMdm -ConsoleHost -Id [-AllowMobileUserEnrollment] - [-AppleCertCreatorAppleId ] [-AppleSignedCert ] - [-DefaultIosUserEnrollmentDeviceGroupId ] [-DefaultSystemGroupId ] - [-DepEnableZeroTouchEnrollment] [-DepSetupAssistantOptions ] - [-EncryptedDepServerToken ] [-IoDefaultDeviceGroupObjectIds ] - [-IoEnableZeroTouchEnrollment] [-IoSetupAssistantOptions ] - [-IoSetupOptions ] [-IosWelcomeScreenButton ] [-IosWelcomeScreenParagraph ] - [-IosWelcomeScreenTitle ] [-MacoDefaultDeviceGroupObjectIds ] - [-MacoEnableZeroTouchEnrollment] [-MacoSetupAssistantOptions ] - [-MacoSetupOptions ] [-MacosWelcomeScreenButton ] [-MacosWelcomeScreenParagraph ] - [-MacosWelcomeScreenTitle ] [-Name ] [-WelcomeScreenButton ] - [-WelcomeScreenParagraph ] [-WelcomeScreenTitle ] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkAppleMdm -ConsoleHost -Id -Body [-Confirm] [-WhatIf] - [] -``` - -### SetViaIdentity -``` -Set-JcSdkAppleMdm -ConsoleHost -InputObject -Body [-Confirm] - [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkAppleMdm -ConsoleHost -InputObject [-AllowMobileUserEnrollment] - [-AppleCertCreatorAppleId ] [-AppleSignedCert ] - [-DefaultIosUserEnrollmentDeviceGroupId ] [-DefaultSystemGroupId ] - [-DepEnableZeroTouchEnrollment] [-DepSetupAssistantOptions ] - [-EncryptedDepServerToken ] [-IoDefaultDeviceGroupObjectIds ] - [-IoEnableZeroTouchEnrollment] [-IoSetupAssistantOptions ] - [-IoSetupOptions ] [-IosWelcomeScreenButton ] [-IosWelcomeScreenParagraph ] - [-IosWelcomeScreenTitle ] [-MacoDefaultDeviceGroupObjectIds ] - [-MacoEnableZeroTouchEnrollment] [-MacoSetupAssistantOptions ] - [-MacoSetupOptions ] [-MacosWelcomeScreenButton ] [-MacosWelcomeScreenParagraph ] - [-MacosWelcomeScreenTitle ] [-Name ] [-WelcomeScreenButton ] - [-WelcomeScreenParagraph ] [-WelcomeScreenTitle ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Set an Apple MDM configuration. -This endpoint is used to supply JumpCloud with a signed certificate from Apple in order to finalize the setup and allow JumpCloud to manage your devices. -It may also be used to set the DEP Settings. - -#### Sample Request -``` - curl -X PUT https://console.jumpcloud.com/api/v2/applemdms/{ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"MDM name\", - \"appleSignedCert\": \"{CERTIFICATE}\", - \"encryptedDepServerToken\": \"{SERVER_TOKEN}\", - \"dep\": { - \"welcomeScreen\": { - \"title\": \"Welcome\", - \"paragraph\": \"In just a few steps, you will be working securely from your Mac.\", - \"button\": \"continue\", - }, - }, - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkAppleMdm -Id:() -Body:() -``` - ----- ---------- -AllowMobileUserEnrollment Boolean -ApnsCertExpiry String -ApnsPushTopic String -AppleCertCreatorAppleId String -AppleCertSerialNumber String -DefaultIosUserEnrollmentDeviceGroupId String -DefaultSystemGroupId String -DepAccessTokenExpiry String -DepEnableZeroTouchEnrollment Boolean -DepServerTokenState String -DepSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -Id String -IoDefaultDeviceGroupObjectIds String -IoEnableZeroTouchEnrollment Boolean -IoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -IoSetupOptions String -IosWelcomeScreenButton String -IosWelcomeScreenParagraph String -IosWelcomeScreenTitle String -MacoDefaultDeviceGroupObjectIds String -MacoEnableZeroTouchEnrollment Boolean -MacoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -MacoSetupOptions String -MacosWelcomeScreenButton String -MacosWelcomeScreenParagraph String -MacosWelcomeScreenTitle String -Name String -Organization String -WelcomeScreenButton String -WelcomeScreenParagraph String -WelcomeScreenTitle String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkAppleMdm -Id:() -AllowMobileUserEnrollment:() -AppleCertCreatorAppleId:() -AppleSignedCert:() -DefaultIosUserEnrollmentDeviceGroupId:() -DefaultSystemGroupId:() -DepEnableZeroTouchEnrollment:() -DepSetupAssistantOptions:() -EncryptedDepServerToken:() -IoDefaultDeviceGroupObjectIds:() -IoEnableZeroTouchEnrollment:() -IoSetupAssistantOptions:() -IoSetupOptions:() -IosWelcomeScreenButton:() -IosWelcomeScreenParagraph:() -IosWelcomeScreenTitle:() -MacoDefaultDeviceGroupObjectIds:() -MacoEnableZeroTouchEnrollment:() -MacoSetupAssistantOptions:() -MacoSetupOptions:() -MacosWelcomeScreenButton:() -MacosWelcomeScreenParagraph:() -MacosWelcomeScreenTitle:() -Name:() -WelcomeScreenButton:() -WelcomeScreenParagraph:() -WelcomeScreenTitle:() -``` - ----- ---------- -AllowMobileUserEnrollment Boolean -ApnsCertExpiry String -ApnsPushTopic String -AppleCertCreatorAppleId String -AppleCertSerialNumber String -DefaultIosUserEnrollmentDeviceGroupId String -DefaultSystemGroupId String -DepAccessTokenExpiry String -DepEnableZeroTouchEnrollment Boolean -DepServerTokenState String -DepSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -Id String -IoDefaultDeviceGroupObjectIds String -IoEnableZeroTouchEnrollment Boolean -IoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -IoSetupOptions String -IosWelcomeScreenButton String -IosWelcomeScreenParagraph String -IosWelcomeScreenTitle String -MacoDefaultDeviceGroupObjectIds String -MacoEnableZeroTouchEnrollment Boolean -MacoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] -MacoSetupOptions String -MacosWelcomeScreenButton String -MacosWelcomeScreenParagraph String -MacosWelcomeScreenTitle String -Name String -Organization String -WelcomeScreenButton String -WelcomeScreenParagraph String -WelcomeScreenTitle String - -## PARAMETERS - -### -AllowMobileUserEnrollment -A toggle to allow mobile device enrollment for an organization. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppleCertCreatorAppleId -The Apple ID of the admin who created the Apple signed certificate. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppleSignedCert -A signed certificate obtained from Apple after providing Apple with the plist file provided on POST. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -Apple MDM Patch - -```yaml -Type: JumpCloud.SDK.V2.Models.IAppleMdmPatch -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultIosUserEnrollmentDeviceGroupId -ObjectId uniquely identifying the MDM default iOS user enrollment device group. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultSystemGroupId -ObjectId uniquely identifying the MDM default System Group. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DepEnableZeroTouchEnrollment -A toggle to determine if DEP registered devices should go through JumpCloud Zero Touch Enrollment. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DepSetupAssistantOptions -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IDepSetupAssistantOption[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptedDepServerToken -The S/MIME encoded DEP Server Token returned by Apple Business Manager when creating an MDM instance. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IoDefaultDeviceGroupObjectIds -An array of ObjectIDs identifying the default device groups for this specific type (based on the OS family) of automated device enrollment. -Currently, only a single DeviceGroupID is supported. - -```yaml -Type: System.String[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IoEnableZeroTouchEnrollment -A toggle to determine if ADE registered devices should go through JumpCloud Zero Touch Enrollment. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IoSetupAssistantOptions -A Setup Option wrapped as an object - -```yaml -Type: JumpCloud.SDK.V2.Models.IDepSetupAssistantOption[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IoSetupOptions -A list of configured setup options for this enrollment. - -```yaml -Type: System.String[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IosWelcomeScreenButton -Text to display on the button on the DEP Welcome Screen. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IosWelcomeScreenParagraph -A message to display on the DEP Welcome Screen. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IosWelcomeScreenTitle -The title to display on the DEP Welcome Screen. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MacoDefaultDeviceGroupObjectIds -An array of ObjectIDs identifying the default device groups for this specific type (based on the OS family) of automated device enrollment. -Currently, only a single DeviceGroupID is supported. - -```yaml -Type: System.String[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MacoEnableZeroTouchEnrollment -A toggle to determine if ADE registered devices should go through JumpCloud Zero Touch Enrollment. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MacoSetupAssistantOptions -A Setup Option wrapped as an object - -```yaml -Type: JumpCloud.SDK.V2.Models.IDepSetupAssistantOption[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MacoSetupOptions -A list of configured setup options for this enrollment. - -```yaml -Type: System.String[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MacosWelcomeScreenButton -Text to display on the button on the DEP Welcome Screen. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MacosWelcomeScreenParagraph -A message to display on the DEP Welcome Screen. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MacosWelcomeScreenTitle -The title to display on the DEP Welcome Screen. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -A new name for the Apple MDM configuration. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WelcomeScreenButton -Text to display on the button on the DEP Welcome Screen. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WelcomeScreenParagraph -A message to display on the DEP Welcome Screen. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WelcomeScreenTitle -The title to display on the DEP Welcome Screen. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IAppleMdmPatch - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IAppleMdm - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: Apple MDM Patch - - `[AllowMobileUserEnrollment ]`: A toggle to allow mobile device enrollment for an organization. - - `[AppleCertCreatorAppleId ]`: The Apple ID of the admin who created the Apple signed certificate. - - `[AppleSignedCert ]`: A signed certificate obtained from Apple after providing Apple with the plist file provided on POST. - - `[DefaultIosUserEnrollmentDeviceGroupId ]`: ObjectId uniquely identifying the MDM default iOS user enrollment device group. - - `[DefaultSystemGroupId ]`: ObjectId uniquely identifying the MDM default System Group. - - `[DepEnableZeroTouchEnrollment ]`: A toggle to determine if DEP registered devices should go through JumpCloud Zero Touch Enrollment. - - `[DepSetupAssistantOptions >]`: - - `[Option ]`: Options to skip screens during MacOS and iOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `actionButton` - Skips the Action Button configuration pane. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `cameraButton` - Skips the Camera Button configuration pane. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `enableLockdownMode` - Skips the Lockdown Mode pane. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `intelligence` - Skips the Intelligence pane. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `termsOfAddress` - Skips the Terms of Address pane. * `tos` - Skips terms and conditions. * `appStore` - Skips the App Store pane. * `deviceToDeviceMigration` - Skips Device to Device Migration pane. * `displayZoom` - Skips zoom setup. * `homeButton` - Skips the Meet the New Home Button screen on iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus and iPhone SE. * `imessageAndFacetime` - Skips the iMessage and FaceTime screen in iOS. * `messagingActivationUsingPhoneNumber` - Skips the iMessage pane. * `moveFromAndroid` - If the Restore pane is not skipped, removes the Move from Android option in the Restore pane on iOS.O * `passcode` - Hides and disables the passcode pane. * `restoreComplete` - Skips the Restore Completed pane. * `safety` - Skips the Safety pane. * `setupCellular` - Skips the add cellular plan pane. * `softwareUpdate` - Skips the mandatory software update screen in iOS. * `unlockWithWatch` - Skips Unlock Your Mac with your Apple Watch pane. * `updateComplete` - Skips the Software Update Complete pane. * `wallpaper` - Skips the Wallpaper setup. * `watchMigration` - Skips the screen for watch migration. * `welcome` - Skips the Get Started pane. * `additionalPrivacySettings` - Skips the Additional Privacy Settings pane. * `multitasking` - Skips the Multitasking pane. * `osShowcase` - Skips the OS Showcase pane. * `webContentFiltering` - Skips the Web Content Filtering pane. * `safetyAndHandling` - Skips the Safety and Handling pane. - - `[EncryptedDepServerToken ]`: The S/MIME encoded DEP Server Token returned by Apple Business Manager when creating an MDM instance. - - `[IoDefaultDeviceGroupObjectIds >]`: An array of ObjectIDs identifying the default device groups for this specific type (based on the OS family) of automated device enrollment. Currently, only a single DeviceGroupID is supported. - - `[IoEnableZeroTouchEnrollment ]`: A toggle to determine if ADE registered devices should go through JumpCloud Zero Touch Enrollment. - - `[IoSetupAssistantOptions >]`: A Setup Option wrapped as an object - - `[IoSetupOptions >]`: A list of configured setup options for this enrollment. - - `[IosWelcomeScreenButton ]`: Text to display on the button on the DEP Welcome Screen. - - `[IosWelcomeScreenParagraph ]`: A message to display on the DEP Welcome Screen. - - `[IosWelcomeScreenTitle ]`: The title to display on the DEP Welcome Screen. - - `[MacoDefaultDeviceGroupObjectIds >]`: An array of ObjectIDs identifying the default device groups for this specific type (based on the OS family) of automated device enrollment. Currently, only a single DeviceGroupID is supported. - - `[MacoEnableZeroTouchEnrollment ]`: A toggle to determine if ADE registered devices should go through JumpCloud Zero Touch Enrollment. - - `[MacoSetupAssistantOptions >]`: A Setup Option wrapped as an object - - `[MacoSetupOptions >]`: A list of configured setup options for this enrollment. - - `[MacosWelcomeScreenButton ]`: Text to display on the button on the DEP Welcome Screen. - - `[MacosWelcomeScreenParagraph ]`: A message to display on the DEP Welcome Screen. - - `[MacosWelcomeScreenTitle ]`: The title to display on the DEP Welcome Screen. - - `[Name ]`: A new name for the Apple MDM configuration. - - `[WelcomeScreenButton ]`: Text to display on the button on the DEP Welcome Screen. - - `[WelcomeScreenParagraph ]`: A message to display on the DEP Welcome Screen. - - `[WelcomeScreenTitle ]`: The title to display on the DEP Welcome Screen. - -`DEPSETUPASSISTANTOPTIONS `: . - - `[Option ]`: Options to skip screens during MacOS and iOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `actionButton` - Skips the Action Button configuration pane. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `cameraButton` - Skips the Camera Button configuration pane. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `enableLockdownMode` - Skips the Lockdown Mode pane. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `intelligence` - Skips the Intelligence pane. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `termsOfAddress` - Skips the Terms of Address pane. * `tos` - Skips terms and conditions. * `appStore` - Skips the App Store pane. * `deviceToDeviceMigration` - Skips Device to Device Migration pane. * `displayZoom` - Skips zoom setup. * `homeButton` - Skips the Meet the New Home Button screen on iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus and iPhone SE. * `imessageAndFacetime` - Skips the iMessage and FaceTime screen in iOS. * `messagingActivationUsingPhoneNumber` - Skips the iMessage pane. * `moveFromAndroid` - If the Restore pane is not skipped, removes the Move from Android option in the Restore pane on iOS.O * `passcode` - Hides and disables the passcode pane. * `restoreComplete` - Skips the Restore Completed pane. * `safety` - Skips the Safety pane. * `setupCellular` - Skips the add cellular plan pane. * `softwareUpdate` - Skips the mandatory software update screen in iOS. * `unlockWithWatch` - Skips Unlock Your Mac with your Apple Watch pane. * `updateComplete` - Skips the Software Update Complete pane. * `wallpaper` - Skips the Wallpaper setup. * `watchMigration` - Skips the screen for watch migration. * `welcome` - Skips the Get Started pane. * `additionalPrivacySettings` - Skips the Additional Privacy Settings pane. * `multitasking` - Skips the Multitasking pane. * `osShowcase` - Skips the OS Showcase pane. * `webContentFiltering` - Skips the Web Content Filtering pane. * `safetyAndHandling` - Skips the Safety and Handling pane. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -`IOSETUPASSISTANTOPTIONS `: A Setup Option wrapped as an object - - `[Option ]`: Options to skip screens during MacOS and iOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `actionButton` - Skips the Action Button configuration pane. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `cameraButton` - Skips the Camera Button configuration pane. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `enableLockdownMode` - Skips the Lockdown Mode pane. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `intelligence` - Skips the Intelligence pane. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `termsOfAddress` - Skips the Terms of Address pane. * `tos` - Skips terms and conditions. * `appStore` - Skips the App Store pane. * `deviceToDeviceMigration` - Skips Device to Device Migration pane. * `displayZoom` - Skips zoom setup. * `homeButton` - Skips the Meet the New Home Button screen on iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus and iPhone SE. * `imessageAndFacetime` - Skips the iMessage and FaceTime screen in iOS. * `messagingActivationUsingPhoneNumber` - Skips the iMessage pane. * `moveFromAndroid` - If the Restore pane is not skipped, removes the Move from Android option in the Restore pane on iOS.O * `passcode` - Hides and disables the passcode pane. * `restoreComplete` - Skips the Restore Completed pane. * `safety` - Skips the Safety pane. * `setupCellular` - Skips the add cellular plan pane. * `softwareUpdate` - Skips the mandatory software update screen in iOS. * `unlockWithWatch` - Skips Unlock Your Mac with your Apple Watch pane. * `updateComplete` - Skips the Software Update Complete pane. * `wallpaper` - Skips the Wallpaper setup. * `watchMigration` - Skips the screen for watch migration. * `welcome` - Skips the Get Started pane. * `additionalPrivacySettings` - Skips the Additional Privacy Settings pane. * `multitasking` - Skips the Multitasking pane. * `osShowcase` - Skips the OS Showcase pane. * `webContentFiltering` - Skips the Web Content Filtering pane. * `safetyAndHandling` - Skips the Safety and Handling pane. - -`MACOSETUPASSISTANTOPTIONS `: A Setup Option wrapped as an object - - `[Option ]`: Options to skip screens during MacOS and iOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `actionButton` - Skips the Action Button configuration pane. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `cameraButton` - Skips the Camera Button configuration pane. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `enableLockdownMode` - Skips the Lockdown Mode pane. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `intelligence` - Skips the Intelligence pane. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `termsOfAddress` - Skips the Terms of Address pane. * `tos` - Skips terms and conditions. * `appStore` - Skips the App Store pane. * `deviceToDeviceMigration` - Skips Device to Device Migration pane. * `displayZoom` - Skips zoom setup. * `homeButton` - Skips the Meet the New Home Button screen on iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus and iPhone SE. * `imessageAndFacetime` - Skips the iMessage and FaceTime screen in iOS. * `messagingActivationUsingPhoneNumber` - Skips the iMessage pane. * `moveFromAndroid` - If the Restore pane is not skipped, removes the Move from Android option in the Restore pane on iOS.O * `passcode` - Hides and disables the passcode pane. * `restoreComplete` - Skips the Restore Completed pane. * `safety` - Skips the Safety pane. * `setupCellular` - Skips the add cellular plan pane. * `softwareUpdate` - Skips the mandatory software update screen in iOS. * `unlockWithWatch` - Skips Unlock Your Mac with your Apple Watch pane. * `updateComplete` - Skips the Software Update Complete pane. * `wallpaper` - Skips the Wallpaper setup. * `watchMigration` - Skips the screen for watch migration. * `welcome` - Skips the Get Started pane. * `additionalPrivacySettings` - Skips the Additional Privacy Settings pane. * `multitasking` - Skips the Multitasking pane. * `osShowcase` - Skips the OS Showcase pane. * `webContentFiltering` - Skips the Web Content Filtering pane. * `safetyAndHandling` - Skips the Safety and Handling pane. - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApplicationAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApplicationAssociation.md deleted file mode 100644 index 51c6e1287..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApplicationAssociation.md +++ /dev/null @@ -1,310 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApplicationAssociation.md -schema: 2.0.0 ---- - -# Set-JcSdkApplicationAssociation - -## SYNOPSIS -This endpoint allows you to manage the _direct_ associations of an Application. -A direct association can be a non-homogeneous relationship between 2 different objects, for example Application and User Groups. - -#### Sample Request -``` -curl -X POST 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations' \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user_group\", - \"id\": \"{Group_ID}\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkApplicationAssociation -ConsoleHost -ApplicationId [-Attributes ] - [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkApplicationAssociation -ConsoleHost -ApplicationId - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkApplicationAssociation -ConsoleHost -InputObject - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkApplicationAssociation -ConsoleHost -InputObject - [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint allows you to manage the _direct_ associations of an Application. -A direct association can be a non-homogeneous relationship between 2 different objects, for example Application and User Groups. - -#### Sample Request -``` -curl -X POST 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations' \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user_group\", - \"id\": \"{Group_ID}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkApplicationAssociation -ApplicationId:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkApplicationAssociation -ApplicationId:() -Id:() -Op:() -Type:() -Attributes:() -``` - - - -## PARAMETERS - -### -ApplicationId -ObjectID of the Application. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Attributes -The graph attributes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -GraphOperation (Application) - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphOperationApplicationAutoGenerated -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectID of graph object being added or removed as an association. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Op -How to modify the graph connection. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Targets which a "application" can be associated to. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGraphOperationApplicationAutoGenerated - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GraphOperation (Application) - - `Id `: The ObjectID of graph object being added or removed as an association. - - `Op `: How to modify the graph connection. - - `Type `: Targets which a "application" can be associated to. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlow.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlow.md deleted file mode 100644 index a1c78ce1a..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlow.md +++ /dev/null @@ -1,517 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlow.md -schema: 2.0.0 ---- - -# Set-JcSdkApprovalFlow - -## SYNOPSIS -Endpoint for updating a new access workflow - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkApprovalFlow -ConsoleHost -ApprovalFlowId [-ApprovalType ] - [-ApproverRequirement ] [-ApproverResources ] - [-Description ] [-FixedDuration ] [-IconColor ] [-IconUrl ] - [-MultiSelectDuration ] [-Name ] [-NonAdminApproval] - [-OrganizationObjectIdInputFile ] [-ResourceId ] - [-SlackConfig ] [-SlackEnabled] [-Status ] [-TimeBasedAccess] - [-TtlConfig ] [-VisibleTo ] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkApprovalFlow -ConsoleHost -ApprovalFlowId - -Body [-Confirm] - [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkApprovalFlow -ConsoleHost -InputObject - -Body [-Confirm] - [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkApprovalFlow -ConsoleHost -InputObject [-ApprovalType ] - [-ApproverRequirement ] [-ApproverResources ] - [-Description ] [-FixedDuration ] [-IconColor ] [-IconUrl ] - [-MultiSelectDuration ] [-Name ] [-NonAdminApproval] - [-OrganizationObjectIdInputFile ] [-ResourceId ] - [-SlackConfig ] [-SlackEnabled] [-Status ] [-TimeBasedAccess] - [-TtlConfig ] [-VisibleTo ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Endpoint for updating a new access workflow - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkApprovalFlow -ApprovalFlowId:() -ApprovalType:() -ApproverRequirement:() -ApproverResources:() -Description:() -FixedDuration:() -IconColor:() -IconUrl:() -MultiSelectDuration:() -Name:() -NonAdminApproval:() -OrganizationObjectIdInputFile:() -ResourceId:() -SlackConfig:() -SlackEnabled:() -Status:() -TimeBasedAccess:() -TtlConfig:() -VisibleTo:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkApprovalFlow -ApprovalFlowId:() -Body:() -``` - - - -## PARAMETERS - -### -ApprovalFlowId -. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApprovalType -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApproverRequirement -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApproverResources -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpcloudIngressoApproverResource[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IPaths14Hfh8UApprovalflowsApprovalflowidPutRequestbodyContentApplicationJsonSchema -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FixedDuration -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IconColor -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IconUrl -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MultiSelectDuration -. - -```yaml -Type: System.String[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NonAdminApproval -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationObjectIdInputFile -Input File for OrganizationObjectId (.) - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SlackConfig -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpcloudIngressoSlackConfig[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SlackEnabled -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeBasedAccess -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TtlConfig -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VisibleTo -. - -```yaml -Type: System.String[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.IPaths14Hfh8UApprovalflowsApprovalflowidPutRequestbodyContentApplicationJsonSchema - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowResponse - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`APPROVERRESOURCES `: . - - `[RequireAll ]`: - - `[ResourceId ]`: - - `[ResourceName ]`: - - `[ResourceOrder ]`: - - `[ResourceType ]`: - -`BODY `: . - - `[ApprovalType ]`: - - `[ApproverRequirement ]`: - - `[ApproverResources >]`: - - `[RequireAll ]`: - - `[ResourceId ]`: - - `[ResourceName ]`: - - `[ResourceOrder ]`: - - `[ResourceType ]`: - - `[Description ]`: - - `[FixedDuration ]`: - - `[IconColor ]`: - - `[IconUrl ]`: - - `[MultiSelectDuration >]`: - - `[Name ]`: - - `[NonAdminApproval ]`: - - `[OrganizationObjectId ]`: - - `[ResourceId ]`: - - `[SlackConfig >]`: - - `[SlackResourceId ]`: - - `[SlackEnabled ]`: - - `[Status ]`: - - `[TimeBasedAccess ]`: - - `[TtlConfig ]`: - - `[VisibleTo >]`: - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -`SLACKCONFIG `: . - - `[SlackResourceId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlowSetting.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlowSetting.md deleted file mode 100644 index c9667d4a4..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlowSetting.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlowSetting.md -schema: 2.0.0 ---- - -# Set-JcSdkApprovalFlowSetting - -## SYNOPSIS -Endpoint for updating a access workflow settings for an organization - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkApprovalFlowSetting -ConsoleHost [-AdminApprovalEmail] - [-ChannelEvents ] [-ExposeApprovalProgress] - [-OrganizationObjectIdInputFile ] [-ResourceRequest] [-UserApprovalEmail] [-UserRequestEmail] - [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkApprovalFlowSetting -ConsoleHost - -Body [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Endpoint for updating a access workflow settings for an organization - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkApprovalFlowSetting -AdminApprovalEmail:() -ChannelEvents:() -ExposeApprovalProgress:() -OrganizationObjectIdInputFile:() -ResourceRequest:() -UserApprovalEmail:() -UserRequestEmail:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkApprovalFlowSetting -Body:() -``` - - - -## PARAMETERS - -### -AdminApprovalEmail -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowSettingsRequest -Parameter Sets: Set -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ChannelEvents -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpcloudIngressoChannelEvent[] -Parameter Sets: SetExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExposeApprovalProgress -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationObjectIdInputFile -Input File for OrganizationObjectId (.) - -```yaml -Type: System.String -Parameter Sets: SetExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceRequest -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserApprovalEmail -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserRequestEmail -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowSettingsRequest - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowSettingsResponse - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: . - - `[AdminApprovalEmail ]`: - - `[ChannelEvents >]`: - - `[ChannelObjectId ]`: - - `[EventTypes >]`: - - `[ExposeApprovalProgress ]`: - - `[OrganizationObjectId ]`: - - `[ResourceRequest ]`: - - `[UserApprovalEmail ]`: - - `[UserRequestEmail ]`: - -`CHANNELEVENTS `: . - - `[ChannelObjectId ]`: - - `[EventTypes >]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCommandAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCommandAssociation.md deleted file mode 100644 index 5e1a02787..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCommandAssociation.md +++ /dev/null @@ -1,314 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCommandAssociation.md -schema: 2.0.0 ---- - -# Set-JcSdkCommandAssociation - -## SYNOPSIS -This endpoint will allow you to manage the _direct_ associations of this Command. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. - - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system_group\", - \"id\": \"Group_ID\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkCommandAssociation -ConsoleHost -CommandId [-Attributes ] [-Id ] - [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkCommandAssociation -ConsoleHost -CommandId -Body - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkCommandAssociation -ConsoleHost -InputObject - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkCommandAssociation -ConsoleHost -InputObject - [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint will allow you to manage the _direct_ associations of this Command. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. - - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system_group\", - \"id\": \"Group_ID\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkCommandAssociation -CommandId:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkCommandAssociation -CommandId:() -Id:() -Op:() -Type:() -Attributes:() -``` - - - -## PARAMETERS - -### -Attributes -The graph attributes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -GraphOperation (Command) - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphOperationCommand -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CommandId -ObjectID of the Command. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectID of graph object being added or removed as an association. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Op -How to modify the graph connection. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Targets which a "command" can be associated to. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGraphOperationCommand - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GraphOperation (Command) - - `Id `: The ObjectID of graph object being added or removed as an association. - - `Op `: How to modify the graph connection. - - `Type `: Targets which a "command" can be associated to. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCustomEmailConfiguration.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCustomEmailConfiguration.md deleted file mode 100644 index f36611d3d..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCustomEmailConfiguration.md +++ /dev/null @@ -1,335 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCustomEmailConfiguration.md -schema: 2.0.0 ---- - -# Set-JcSdkCustomEmailConfiguration - -## SYNOPSIS -Set the custom email configuration for the specified custom email type. - -This action is only available to paying customers. - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkCustomEmailConfiguration -ConsoleHost -CustomEmailType [-Body ] - [-Button ] [-Header ] [-NextStepContactInfo ] [-Subject ] [-Title ] - [-Type ] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkCustomEmailConfiguration -ConsoleHost -CustomEmailType -CustomEmail - [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkCustomEmailConfiguration -ConsoleHost -InputObject - -CustomEmail [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkCustomEmailConfiguration -ConsoleHost -InputObject [-Body ] - [-Button ] [-Header ] [-NextStepContactInfo ] [-Subject ] [-Title ] - [-Type ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Set the custom email configuration for the specified custom email type. - -This action is only available to paying customers. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkCustomEmailConfiguration -CustomEmailType:() -CustomEmail:() -``` - ----- ---------- -Body String -Button String -Header String -Id String -NextStepContactInfo String -Subject String -Title String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkCustomEmailConfiguration -CustomEmailType:() -Subject:() -Type:() -Body:() -Button:() -Header:() -NextStepContactInfo:() -Title:() -``` - ----- ---------- -Body String -Button String -Header String -Id String -NextStepContactInfo String -Subject String -Title String -Type String - -## PARAMETERS - -### -Body -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Button -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomEmail -Custom email content created by the admin user to personalize emails sent to their system users. - -```yaml -Type: JumpCloud.SDK.V2.Models.ICustomEmail -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CustomEmailType -. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Header -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NextStepContactInfo -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subject -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.ICustomEmail - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ICustomEmail - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`CUSTOMEMAIL `: Custom email content created by the admin user to personalize emails sent to their system users. - - `Subject `: - - `Type `: - - `[Body ]`: - - `[Button ]`: - - `[Header ]`: - - `[NextStepContactInfo ]`: - - `[Title ]`: - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkDuoApplication.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkDuoApplication.md deleted file mode 100644 index 9a2e471c7..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkDuoApplication.md +++ /dev/null @@ -1,316 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkDuoApplication.md -schema: 2.0.0 ---- - -# Set-JcSdkDuoApplication - -## SYNOPSIS -Set the specified Duo application. - -#### Sample Request -``` - curl -X PUT https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Application Name\", - \"apiHost\": \"api-1234.duosecurity.com\", - \"integrationKey\": \"1234\", - \"secretKey\": \"5678\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkDuoApplication -ConsoleHost -AccountId -ApplicationId [-ApiHost ] - [-IntegrationKey ] [-Name ] [-SecretKey ] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkDuoApplication -ConsoleHost -AccountId -ApplicationId - -Body [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkDuoApplication -ConsoleHost -InputObject - -Body [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkDuoApplication -ConsoleHost -InputObject [-ApiHost ] - [-IntegrationKey ] [-Name ] [-SecretKey ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Set the specified Duo application. - -#### Sample Request -``` - curl -X PUT https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Application Name\", - \"apiHost\": \"api-1234.duosecurity.com\", - \"integrationKey\": \"1234\", - \"secretKey\": \"5678\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkDuoApplication -AccountId:() -ApplicationId:() -Body:() -``` - ----- ---------- -ApiHost String -Id String -IntegrationKey String -Name String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkDuoApplication -AccountId:() -ApplicationId:() -ApiHost:() -IntegrationKey:() -Name:() -SecretKey:() -``` - ----- ---------- -ApiHost String -Id String -IntegrationKey String -Name String - -## PARAMETERS - -### -AccountId -. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiHost -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationId -. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -DuoApplicationUpdateReq - -```yaml -Type: JumpCloud.SDK.V2.Models.IDuoApplicationUpdateReq -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IntegrationKey -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecretKey -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IDuoApplicationUpdateReq - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IDuoApplication - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: DuoApplicationUpdateReq - - `ApiHost `: - - `IntegrationKey `: - - `Name `: - - `[SecretKey ]`: - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkGSuiteAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkGSuiteAssociation.md deleted file mode 100644 index 6cf979de6..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkGSuiteAssociation.md +++ /dev/null @@ -1,314 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkGSuiteAssociation.md -schema: 2.0.0 ---- - -# Set-JcSdkGSuiteAssociation - -## SYNOPSIS -This endpoint returns the _direct_ associations of this G Suite instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user_group\", - \"id\": \"{Group_ID}\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkGSuiteAssociation -ConsoleHost -GsuiteId [-Attributes ] [-Id ] - [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkGSuiteAssociation -ConsoleHost -GsuiteId -Body - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkGSuiteAssociation -ConsoleHost -InputObject - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkGSuiteAssociation -ConsoleHost -InputObject - [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint returns the _direct_ associations of this G Suite instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user_group\", - \"id\": \"{Group_ID}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkGSuiteAssociation -GsuiteId:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkGSuiteAssociation -GsuiteId:() -Id:() -Op:() -Type:() -Attributes:() -``` - - - -## PARAMETERS - -### -Attributes -The graph attributes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -GraphOperation (GSuite) - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphOperationGSuiteAutoGenerated -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GsuiteId -ObjectID of the G Suite instance. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectID of graph object being added or removed as an association. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Op -How to modify the graph connection. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Targets which a "g_suite" can be associated to. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGraphOperationGSuiteAutoGenerated - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GraphOperation (GSuite) - - `Id `: The ObjectID of graph object being added or removed as an association. - - `Op `: How to modify the graph connection. - - `Type `: Targets which a "g_suite" can be associated to. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkIPList.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkIPList.md deleted file mode 100644 index c4711b6cb..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkIPList.md +++ /dev/null @@ -1,285 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkIPList.md -schema: 2.0.0 ---- - -# Set-JcSdkIPList - -## SYNOPSIS -Replace a specific IP list. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Sample IP List\", - \"ips\": [ - \"192.168.10.10\" - ] - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkIPList -ConsoleHost -Id [-Description ] [-Ips ] [-Name ] - [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkIPList -ConsoleHost -Id -Body [-Confirm] [-WhatIf] - [] -``` - -### SetViaIdentity -``` -Set-JcSdkIPList -ConsoleHost -InputObject -Body [-Confirm] - [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkIPList -ConsoleHost -InputObject [-Description ] - [-Ips ] [-Name ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Replace a specific IP list. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Sample IP List\", - \"ips\": [ - \"192.168.10.10\" - ] - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkIPList -Id:() -Body:() -``` - ----- ---------- -Description String -Id String -Ips String -Name String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkIPList -Id:() -Description:() -Ips:() -Name:() -``` - ----- ---------- -Description String -Id String -Ips String -Name String - -## PARAMETERS - -### -Body -IPListRequest - -```yaml -Type: JumpCloud.SDK.V2.Models.IIPListRequest -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Ips -. - -```yaml -Type: System.String[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IIPListRequest - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IIPList - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: IPListRequest - - `[Description ]`: - - `[Ips >]`: - - `[Name ]`: - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerAssociation.md deleted file mode 100644 index 2e1702bef..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerAssociation.md +++ /dev/null @@ -1,312 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerAssociation.md -schema: 2.0.0 ---- - -# Set-JcSdkLdapServerAssociation - -## SYNOPSIS -This endpoint allows you to manage the _direct_ associations of a LDAP Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{User_ID}\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkLdapServerAssociation -ConsoleHost -LdapserverId [-Attributes ] - [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkLdapServerAssociation -ConsoleHost -LdapserverId - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkLdapServerAssociation -ConsoleHost -InputObject - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkLdapServerAssociation -ConsoleHost -InputObject - [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint allows you to manage the _direct_ associations of a LDAP Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{User_ID}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkLdapServerAssociation -LdapserverId:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkLdapServerAssociation -LdapserverId:() -Id:() -Op:() -Type:() -Attributes:() -``` - - - -## PARAMETERS - -### -Attributes -The graph attributes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -GraphOperation (LdapServer) - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphOperationLdapServerAutoGenerated -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectID of graph object being added or removed as an association. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LdapserverId -ObjectID of the LDAP Server. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Op -How to modify the graph connection. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Targets which a "ldap_server" can be associated to. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGraphOperationLdapServerAutoGenerated - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GraphOperation (LdapServer) - - `Id `: The ObjectID of graph object being added or removed as an association. - - `Op `: How to modify the graph connection. - - `Type `: Targets which a "ldap_server" can be associated to. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerSambaDomain.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerSambaDomain.md deleted file mode 100644 index 506ddbc9a..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerSambaDomain.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerSambaDomain.md -schema: 2.0.0 ---- - -# Set-JcSdkLdapServerSambaDomain - -## SYNOPSIS -This endpoint allows you to set the samba domain information for an LDAP server. - -##### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"sid\":\"{SID_ID}\", - \"name\":\"{WORKGROUP_NAME}\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkLdapServerSambaDomain -ConsoleHost -Id -LdapserverId [-Name ] - [-Sid ] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkLdapServerSambaDomain -ConsoleHost -Id -LdapserverId -Body - [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkLdapServerSambaDomain -ConsoleHost -InputObject -Body - [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkLdapServerSambaDomain -ConsoleHost -InputObject [-Name ] - [-Sid ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to set the samba domain information for an LDAP server. - -##### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"sid\":\"{SID_ID}\", - \"name\":\"{WORKGROUP_NAME}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkLdapServerSambaDomain -Id:() -LdapserverId:() -Body:() -``` - ----- ---------- -Id String -Name String -Sid String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkLdapServerSambaDomain -Id:() -LdapserverId:() -Name:() -Sid:() -``` - ----- ---------- -Id String -Name String -Sid String - -## PARAMETERS - -### -Body -Samba Domain - -```yaml -Type: JumpCloud.SDK.V2.Models.ISambaDomain -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Unique identifier of the samba domain. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LdapserverId -Unique identifier of the LDAP server. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of this domain's WorkGroup - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sid -Security identifier of this domain - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.ISambaDomain - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISambaDomain - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: Samba Domain - - `Name `: Name of this domain's WorkGroup - - `Sid `: Security identifier of this domain - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkOffice365Association.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkOffice365Association.md deleted file mode 100644 index 3b34af7ec..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkOffice365Association.md +++ /dev/null @@ -1,312 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkOffice365Association.md -schema: 2.0.0 ---- - -# Set-JcSdkOffice365Association - -## SYNOPSIS -This endpoint allows you to manage the _direct_ associations of a Office 365 instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user_group\", - \"id\": \"{Group_ID}\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkOffice365Association -ConsoleHost -Office365Id [-Attributes ] - [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkOffice365Association -ConsoleHost -Office365Id - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkOffice365Association -ConsoleHost -InputObject - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkOffice365Association -ConsoleHost -InputObject - [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint allows you to manage the _direct_ associations of a Office 365 instance. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user_group\", - \"id\": \"{Group_ID}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkOffice365Association -Office365Id:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkOffice365Association -Office365Id:() -Id:() -Op:() -Type:() -Attributes:() -``` - - - -## PARAMETERS - -### -Attributes -The graph attributes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -GraphOperation (Office365) - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphOperationOffice365AutoGenerated -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectID of graph object being added or removed as an association. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Office365Id -ObjectID of the Office 365 instance. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Op -How to modify the graph connection. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Targets which a "office_365" can be associated to. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGraphOperationOffice365AutoGenerated - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GraphOperation (Office365) - - `Id `: The ObjectID of graph object being added or removed as an association. - - `Op `: How to modify the graph connection. - - `Type `: Targets which a "office_365" can be associated to. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicy.md deleted file mode 100644 index 078b4a5dc..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicy.md +++ /dev/null @@ -1,311 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicy.md -schema: 2.0.0 ---- - -# Set-JcSdkPolicy - -## SYNOPSIS -This endpoint allows you to set a policy. -Given the amount of configurable parameters required to set a Policy, we suggest you use the JumpCloud Admin Console to set new policies. - - -##### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/policies/59fced45c9118022172547ff \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Policy_Parameters} - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkPolicy -ConsoleHost -Id [-Name ] [-Notes ] - [-Values ] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkPolicy -ConsoleHost -Id -Body [-Confirm] [-WhatIf] - [] -``` - -### SetViaIdentity -``` -Set-JcSdkPolicy -ConsoleHost -InputObject -Body - [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkPolicy -ConsoleHost -InputObject [-Name ] [-Notes ] - [-Values ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to set a policy. -Given the amount of configurable parameters required to set a Policy, we suggest you use the JumpCloud Admin Console to set new policies. - - -##### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/policies/59fced45c9118022172547ff \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - {Policy_Parameters} - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkPolicy -Id:() -Body:() -``` - ----- ---------- -Id String -Name String -TemplateActivation String -TemplateAlert String -TemplateBehavior String -TemplateDeliveryTypes String -TemplateDescription String -TemplateDisplayName String -TemplateId String -TemplateName String -TemplateOSMetaFamily String -TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] -TemplateReference String -TemplateState String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkPolicy -Id:() -Name:() -Notes:() -Values:() -``` - ----- ---------- -Id String -Name String -TemplateActivation String -TemplateAlert String -TemplateBehavior String -TemplateDeliveryTypes String -TemplateDescription String -TemplateDisplayName String -TemplateId String -TemplateName String -TemplateOSMetaFamily String -TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] -TemplateReference String -TemplateState String - -## PARAMETERS - -### -Body -A request to update an instance of a policy template. - -```yaml -Type: JumpCloud.SDK.V2.Models.IPolicyUpdateRequest -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -ObjectID of the Policy object. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The description for this specific Policy. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -The notes for this specific Policy. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Values -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IPolicyValue[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.IPolicyUpdateRequest - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPolicy - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: A request to update an instance of a policy template. - - `Name `: The description for this specific Policy. - - `[Notes ]`: The notes for this specific Policy. - - `[Values >]`: - - `[ConfigFieldId ]`: The ObjectId of the corresponding Policy Template configuration field. - - `[Sensitive ]`: Defines if the value is sensitive or not. - - `[Value ]`: The value for the configuration field for this Policy instance. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -`VALUES `: . - - `[ConfigFieldId ]`: The ObjectId of the corresponding Policy Template configuration field. - - `[Sensitive ]`: Defines if the value is sensitive or not. - - `[Value ]`: The value for the configuration field for this Policy instance. - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyAssociation.md deleted file mode 100644 index ee96799c7..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyAssociation.md +++ /dev/null @@ -1,312 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyAssociation.md -schema: 2.0.0 ---- - -# Set-JcSdkPolicyAssociation - -## SYNOPSIS -This endpoint allows you to manage the _direct_ associations of a Policy. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations/ \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system_group\", - \"id\": \"{Group_ID}\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkPolicyAssociation -ConsoleHost -PolicyId [-Attributes ] [-Id ] - [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkPolicyAssociation -ConsoleHost -PolicyId -Body [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkPolicyAssociation -ConsoleHost -InputObject - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkPolicyAssociation -ConsoleHost -InputObject - [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint allows you to manage the _direct_ associations of a Policy. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations/ \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system_group\", - \"id\": \"{Group_ID}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkPolicyAssociation -PolicyId:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkPolicyAssociation -PolicyId:() -Id:() -Op:() -Type:() -Attributes:() -``` - - - -## PARAMETERS - -### -Attributes -The graph attributes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -GraphOperation (Policy) - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphOperationPolicy -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectID of graph object being added or removed as an association. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Op -How to modify the graph connection. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyId -ObjectID of the Policy. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Targets which a "policy" can be associated to. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGraphOperationPolicy - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GraphOperation (Policy) - - `Id `: The ObjectID of graph object being added or removed as an association. - - `Op `: How to modify the graph connection. - - `Type `: Targets which a "policy" can be associated to. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroup.md deleted file mode 100644 index c67be49e0..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroup.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroup.md -schema: 2.0.0 ---- - -# Set-JcSdkPolicyGroup - -## SYNOPSIS -This endpoint allows you to do a full set of the Policy Group. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/policygroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"group_set - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkPolicyGroup -ConsoleHost -Id [-Name ] [-Confirm] [-WhatIf] - [] -``` - -### Set -``` -Set-JcSdkPolicyGroup -ConsoleHost -Id -Body [-Confirm] [-WhatIf] - [] -``` - -### SetViaIdentity -``` -Set-JcSdkPolicyGroup -ConsoleHost -InputObject -Body - [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkPolicyGroup -ConsoleHost -InputObject [-Name ] [-Confirm] - [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to do a full set of the Policy Group. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/policygroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"group_set - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkPolicyGroup -Id:() -Body:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -Name String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkPolicyGroup -Id:() -Name:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -Name String -Type String - -## PARAMETERS - -### -Body -PolicyGroupData - -```yaml -Type: JumpCloud.SDK.V2.Models.IPolicyGroupData -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -ObjectID of the Policy Group. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Display name of a Policy Group. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.IPolicyGroupData - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPolicyGroup - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: PolicyGroupData - - `Name `: Display name of a Policy Group. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupAssociation.md deleted file mode 100644 index ba4c11ce2..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupAssociation.md +++ /dev/null @@ -1,314 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupAssociation.md -schema: 2.0.0 ---- - -# Set-JcSdkPolicyGroupAssociation - -## SYNOPSIS -This endpoint manages the _direct_ associations of this Policy Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system\", - \"id\": \"{SystemID}\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkPolicyGroupAssociation -ConsoleHost -GroupId [-Attributes ] - [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkPolicyGroupAssociation -ConsoleHost -GroupId -Body - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkPolicyGroupAssociation -ConsoleHost -InputObject - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkPolicyGroupAssociation -ConsoleHost -InputObject - [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint manages the _direct_ associations of this Policy Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system\", - \"id\": \"{SystemID}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkPolicyGroupAssociation -GroupId:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkPolicyGroupAssociation -GroupId:() -Id:() -Op:() -Type:() -Attributes:() -``` - - - -## PARAMETERS - -### -Attributes -The graph attributes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -GraphOperation (PolicyGroup) - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphOperationPolicyGroup -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the Policy Group. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectID of graph object being added or removed as an association. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Op -How to modify the graph connection. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Targets which a "policy_group" can be associated to. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGraphOperationPolicyGroup - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GraphOperation (PolicyGroup) - - `Id `: The ObjectID of graph object being added or removed as an association. - - `Op `: How to modify the graph connection. - - `Type `: Targets which a "policy_group" can be associated to. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupMember.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupMember.md deleted file mode 100644 index 9ec5f6ef8..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupMember.md +++ /dev/null @@ -1,291 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupMember.md -schema: 2.0.0 ---- - -# Set-JcSdkPolicyGroupMember - -## SYNOPSIS -This endpoint allows you to manage the Policy members of a Policy Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"policy\", - \"id\": \"{Policy_ID}\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkPolicyGroupMember -ConsoleHost -GroupId [-Attributes ] [-Id ] - [-Op ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkPolicyGroupMember -ConsoleHost -GroupId -Body - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkPolicyGroupMember -ConsoleHost -InputObject - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkPolicyGroupMember -ConsoleHost -InputObject - [-Attributes ] [-Id ] [-Op ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to manage the Policy members of a Policy Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"policy\", - \"id\": \"{Policy_ID}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkPolicyGroupMember -GroupId:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkPolicyGroupMember -GroupId:() -Id:() -Op:() -Attributes:() -``` - - - -## PARAMETERS - -### -Attributes -The graph attributes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -GraphOperation (PolicyGroup-Member) - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphOperationPolicyGroupMember -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the Policy Group. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectID of graph object being added or removed as an association. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Op -How to modify the graph connection. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGraphOperationPolicyGroupMember - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GraphOperation (PolicyGroup-Member) - - `Id `: The ObjectID of graph object being added or removed as an association. - - `Op `: How to modify the graph connection. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkRadiusServerAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkRadiusServerAssociation.md deleted file mode 100644 index eb66ab80d..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkRadiusServerAssociation.md +++ /dev/null @@ -1,316 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkRadiusServerAssociation.md -schema: 2.0.0 ---- - -# Set-JcSdkRadiusServerAssociation - -## SYNOPSIS -This endpoint allows you to manage the _direct_ associations of a Radius Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ -\t -\"type\":\"user\", -\"id\":\"{USER_ID}\", -\"op\":\"add\" -\t -}' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkRadiusServerAssociation -ConsoleHost -RadiusserverId [-Attributes ] - [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkRadiusServerAssociation -ConsoleHost -RadiusserverId - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkRadiusServerAssociation -ConsoleHost -InputObject - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkRadiusServerAssociation -ConsoleHost -InputObject - [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint allows you to manage the _direct_ associations of a Radius Server. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ -\t -\"type\":\"user\", -\"id\":\"{USER_ID}\", -\"op\":\"add\" -\t -}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkRadiusServerAssociation -RadiusserverId:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkRadiusServerAssociation -RadiusserverId:() -Id:() -Op:() -Type:() -Attributes:() -``` - - - -## PARAMETERS - -### -Attributes -The graph attributes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -GraphOperation (RadiusServer) - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphOperationRadiusServerAutoGenerated -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectID of graph object being added or removed as an association. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Op -How to modify the graph connection. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RadiusserverId -ObjectID of the Radius Server. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Targets which a "radius_server" can be associated to. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGraphOperationRadiusServerAutoGenerated - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GraphOperation (RadiusServer) - - `Id `: The ObjectID of graph object being added or removed as an association. - - `Op `: How to modify the graph connection. - - `Type `: Targets which a "radius_server" can be associated to. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareApp.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareApp.md deleted file mode 100644 index b7327c3a2..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareApp.md +++ /dev/null @@ -1,561 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareApp.md -schema: 2.0.0 ---- - -# Set-JcSdkSoftwareApp - -## SYNOPSIS -This endpoint set a specific Software Application configuration for the organization. -displayName can be changed alone if no settings are provided. -If a setting is provided, it should include all its information since this endpoint will set all the settings' fields. -The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. - -#### Sample Request - displayName only -``` - curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"displayName\": \"My Software App\" - }' -``` - -#### Sample Request - all attributes -``` - curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"displayName\": \"My Software App\", - \"settings\": [ - { - \"packageId\": \"123456\", - \"autoset : false, - \"allowUpdateDelay\": false, - \"packageManager\": \"APPLE_VPP\", - \"locationObjectId\": \"123456789012123456789012\", - \"location\": \"123456\", - \"desiredState\": \"Install\", - \"appleVpp\": { - \"appConfiguration\": \"\\\\\MyKey\\My String\\\\", - \"assignedLicenses\": 20, - \"availableLicenses\": 10, - \"details\": {}, - \"isConfigEnabled\": true, - \"supportedDeviceFamilies\": [ - \"IPAD\", - \"MAC\" - ], - \"totalLicenses\": 30 - }, - \"packageSubtitle\": \"My package subtitle\", - \"packageVersion\": \"1.2.3\", - \"packageKind\": \"software-package\", - \"assetKind\": \"software\", - \"assetSha256Size\": 256, - \"assetSha256Strings\": [ - \"a123b123c123d123\" - ], - \"description\": \"My app description\" - } - ] - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkSoftwareApp -ConsoleHost -Id [-CreatedAt ] [-DisplayName ] - [-Id1 ] [-Settings ] [-UpdatedAt ] [-Confirm] [-WhatIf] - [] -``` - -### Set -``` -Set-JcSdkSoftwareApp -ConsoleHost -Id -Body [-Confirm] [-WhatIf] - [] -``` - -### SetViaIdentity -``` -Set-JcSdkSoftwareApp -ConsoleHost -InputObject -Body - [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkSoftwareApp -ConsoleHost -InputObject [-Id ] - [-CreatedAt ] [-DisplayName ] [-Settings ] [-UpdatedAt ] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint set a specific Software Application configuration for the organization. -displayName can be changed alone if no settings are provided. -If a setting is provided, it should include all its information since this endpoint will set all the settings' fields. -The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. - -#### Sample Request - displayName only -``` - curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"displayName\": \"My Software App\" - }' -``` - -#### Sample Request - all attributes -``` - curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"displayName\": \"My Software App\", - \"settings\": [ - { - \"packageId\": \"123456\", - \"autoset : false, - \"allowUpdateDelay\": false, - \"packageManager\": \"APPLE_VPP\", - \"locationObjectId\": \"123456789012123456789012\", - \"location\": \"123456\", - \"desiredState\": \"Install\", - \"appleVpp\": { - \"appConfiguration\": \"\\\\\MyKey\\My String\\\\", - \"assignedLicenses\": 20, - \"availableLicenses\": 10, - \"details\": {}, - \"isConfigEnabled\": true, - \"supportedDeviceFamilies\": [ - \"IPAD\", - \"MAC\" - ], - \"totalLicenses\": 30 - }, - \"packageSubtitle\": \"My package subtitle\", - \"packageVersion\": \"1.2.3\", - \"packageKind\": \"software-package\", - \"assetKind\": \"software\", - \"assetSha256Size\": 256, - \"assetSha256Strings\": [ - \"a123b123c123d123\" - ], - \"description\": \"My app description\" - } - ] - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkSoftwareApp -Id:() -Body:() -``` - ----- ---------- -DisplayName String -Id String -Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkSoftwareApp -Id:() -DisplayName:() -Id1:() -Settings:() -``` - ----- ---------- -DisplayName String -Id String -Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] - -## PARAMETERS - -### -Body -Software Application Package - -```yaml -Type: JumpCloud.SDK.V2.Models.ISoftwareApp -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreatedAt -. - -```yaml -Type: System.DateTime -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id1 -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Settings -. - -```yaml -Type: JumpCloud.SDK.V2.Models.ISoftwareAppSettings[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdatedAt -. - -```yaml -Type: System.DateTime -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.ISoftwareApp - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISoftwareApp - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: Software Application Package - - `[CreatedAt ]`: - - `[DisplayName ]`: - - `[Id ]`: - - `[Settings >]`: - - `[AllowUpdateDelay ]`: - - `[AppCatalogInstallableObjectId ]`: ID of the app catalog installable that created this app. - - `[AppFileName ]`: - - `[AppleVppAppConfiguration ]`: Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'. - - `[AppleVppAssignedLicenses ]`: - - `[AppleVppAvailableLicenses ]`: - - `[AppleVppDetails ]`: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. - - `[(Any) ]`: This indicates any property can be added to this object. - - `[AppleVppIsConfigEnabled ]`: Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''. - - `[AppleVppSupportedDeviceFamilies >]`: The supported device families for this VPP Application. - - `[AppleVppTotalLicenses ]`: - - `[Architectures >]`: - - `[AssetKind ]`: The manifest asset kind (ex: software). - - `[AssetSha256Size ]`: The incremental size to use for summing the package as it is downloaded. - - `[AssetSha256Strings >]`: The array of checksums, one each for the hash size up to the total size of the package. - - `[AutoUpdate ]`: - - `[BundleId ]`: - - `[CommandLineArguments ]`: Command line arguments to use with the application. - - `[CreatedAt ]`: - - `[Description ]`: The software app description. - - `[DesiredState ]`: State of Install or Uninstall - - `[DownloadUrl ]`: - - `[EnterpriseObjectId ]`: ID of the Enterprise with which this app is associated - - `[Format ]`: - - `[GoogleAndroidAppPricing ]`: Whether this app is free, free with in-app purchases, or paid. - - `[GoogleAndroidAppVersion ]`: Latest version currently available for this app. - - `[GoogleAndroidAuthor ]`: The name of the author of this app. - - `[GoogleAndroidAutoUpdateMode ]`: Controls the auto-update mode for the app. - - `[GoogleAndroidCategory ]`: The app category (e.g. COMMUNICATION, SOCIAL, etc.). - - `[GoogleAndroidContentRating ]`: The content rating for this app. - - `[GoogleAndroidDisplayMode ]`: The display mode of the web app. - - `[GoogleAndroidDistributionChannel ]`: How and to whom the package is made available. - - `[GoogleAndroidFeatures >]`: The array of android features for the app. - - `[GoogleAndroidFullDescription ]`: Full app description, if available. - - `[GoogleAndroidIconUrl ]`: A link to an image that can be used as an icon for the app. - - `[GoogleAndroidInstallType ]`: The type of installation to perform for an app. - - `[GoogleAndroidManagedConfigurationTemplateId ]`: The managed configurations template for the app. - - `[GoogleAndroidManagedProperties ]`: Indicates whether this app has managed properties or not. - - `[GoogleAndroidMinSdkVersion ]`: The minimum Android SDK necessary to run the app. - - `[GoogleAndroidName ]`: The name of the app in the form enterprises/{enterprise}/applications/{packageName}. - - `[GoogleAndroidPermissionGrants >]`: - - `[Id ]`: An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR. - - `[Policy ]`: The policy for granting the permission. - - `[GoogleAndroidRuntimePermission ]`: The policy for granting permission requests to apps. - - `[GoogleAndroidStartUrl ]`: The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps. - - `[GoogleAndroidType ]`: Type of this android application. - - `[GoogleAndroidUpdateTime ]`: The approximate time (within 7 days) the app was last published. - - `[GoogleAndroidVersionCode ]`: The current version of the web app. - - `[IconUrl ]`: URL to the icon for the app. - - `[Location ]`: Repository where the app is located within the package manager - - `[LocationObjectId ]`: ID of the repository where the app is located within the package manager - - `[MicrosoftStoreDoNotUpdate ]`: Indicates whether the app can be updated or not. - - `[MicrosoftStoreNonRemovable ]`: Indicates whether the app is removable by the users or not. - - `[MicrosoftStorePackageFamilyName ]`: Package Family Name for the app from Microsoft App Store. - - `[ObjectId ]`: - - `[PackageId ]`: - - `[PackageKind ]`: The package manifest kind (ex: software-package). - - `[PackageManager ]`: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. - - `[PackageSubtitle ]`: The package manifest subtitle. - - `[PackageVersion ]`: The package manifest version. - - `[PackageVersionUpdatedAt ]`: - - `[Scope ]`: The installation scope of the software app. - - `[ShortVersion ]`: - - `[StoredPackageObjectId ]`: ID of the stored package this app uses to reference the stored install media. - - `[StoredPackageVersions >]`: - - `[Metadata ]`: Dictionary of - - `[(Any) ]`: This indicates any property can be added to this object. - - `[Name ]`: - - `[RejectedReason ]`: - - `[Sha256Sum ]`: - - `[Size ]`: - - `[Status ]`: - - `[Version ]`: - - `[TeamId ]`: - - `[UpdateTool ]`: - - `[UpdateToolArguments ]`: - - `[UpdatedAt ]`: - - `[VersionlessDownloadUrl ]`: - - `[UpdatedAt ]`: - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -`SETTINGS `: . - - `[AllowUpdateDelay ]`: - - `[AppCatalogInstallableObjectId ]`: ID of the app catalog installable that created this app. - - `[AppFileName ]`: - - `[AppleVppAppConfiguration ]`: Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'. - - `[AppleVppAssignedLicenses ]`: - - `[AppleVppAvailableLicenses ]`: - - `[AppleVppDetails ]`: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. - - `[(Any) ]`: This indicates any property can be added to this object. - - `[AppleVppIsConfigEnabled ]`: Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''. - - `[AppleVppSupportedDeviceFamilies >]`: The supported device families for this VPP Application. - - `[AppleVppTotalLicenses ]`: - - `[Architectures >]`: - - `[AssetKind ]`: The manifest asset kind (ex: software). - - `[AssetSha256Size ]`: The incremental size to use for summing the package as it is downloaded. - - `[AssetSha256Strings >]`: The array of checksums, one each for the hash size up to the total size of the package. - - `[AutoUpdate ]`: - - `[BundleId ]`: - - `[CommandLineArguments ]`: Command line arguments to use with the application. - - `[CreatedAt ]`: - - `[Description ]`: The software app description. - - `[DesiredState ]`: State of Install or Uninstall - - `[DownloadUrl ]`: - - `[EnterpriseObjectId ]`: ID of the Enterprise with which this app is associated - - `[Format ]`: - - `[GoogleAndroidAppPricing ]`: Whether this app is free, free with in-app purchases, or paid. - - `[GoogleAndroidAppVersion ]`: Latest version currently available for this app. - - `[GoogleAndroidAuthor ]`: The name of the author of this app. - - `[GoogleAndroidAutoUpdateMode ]`: Controls the auto-update mode for the app. - - `[GoogleAndroidCategory ]`: The app category (e.g. COMMUNICATION, SOCIAL, etc.). - - `[GoogleAndroidContentRating ]`: The content rating for this app. - - `[GoogleAndroidDisplayMode ]`: The display mode of the web app. - - `[GoogleAndroidDistributionChannel ]`: How and to whom the package is made available. - - `[GoogleAndroidFeatures >]`: The array of android features for the app. - - `[GoogleAndroidFullDescription ]`: Full app description, if available. - - `[GoogleAndroidIconUrl ]`: A link to an image that can be used as an icon for the app. - - `[GoogleAndroidInstallType ]`: The type of installation to perform for an app. - - `[GoogleAndroidManagedConfigurationTemplateId ]`: The managed configurations template for the app. - - `[GoogleAndroidManagedProperties ]`: Indicates whether this app has managed properties or not. - - `[GoogleAndroidMinSdkVersion ]`: The minimum Android SDK necessary to run the app. - - `[GoogleAndroidName ]`: The name of the app in the form enterprises/{enterprise}/applications/{packageName}. - - `[GoogleAndroidPermissionGrants >]`: - - `[Id ]`: An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR. - - `[Policy ]`: The policy for granting the permission. - - `[GoogleAndroidRuntimePermission ]`: The policy for granting permission requests to apps. - - `[GoogleAndroidStartUrl ]`: The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps. - - `[GoogleAndroidType ]`: Type of this android application. - - `[GoogleAndroidUpdateTime ]`: The approximate time (within 7 days) the app was last published. - - `[GoogleAndroidVersionCode ]`: The current version of the web app. - - `[IconUrl ]`: URL to the icon for the app. - - `[Location ]`: Repository where the app is located within the package manager - - `[LocationObjectId ]`: ID of the repository where the app is located within the package manager - - `[MicrosoftStoreDoNotUpdate ]`: Indicates whether the app can be updated or not. - - `[MicrosoftStoreNonRemovable ]`: Indicates whether the app is removable by the users or not. - - `[MicrosoftStorePackageFamilyName ]`: Package Family Name for the app from Microsoft App Store. - - `[ObjectId ]`: - - `[PackageId ]`: - - `[PackageKind ]`: The package manifest kind (ex: software-package). - - `[PackageManager ]`: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. - - `[PackageSubtitle ]`: The package manifest subtitle. - - `[PackageVersion ]`: The package manifest version. - - `[PackageVersionUpdatedAt ]`: - - `[Scope ]`: The installation scope of the software app. - - `[ShortVersion ]`: - - `[StoredPackageObjectId ]`: ID of the stored package this app uses to reference the stored install media. - - `[StoredPackageVersions >]`: - - `[Metadata ]`: Dictionary of - - `[(Any) ]`: This indicates any property can be added to this object. - - `[Name ]`: - - `[RejectedReason ]`: - - `[Sha256Sum ]`: - - `[Size ]`: - - `[Status ]`: - - `[Version ]`: - - `[TeamId ]`: - - `[UpdateTool ]`: - - `[UpdateToolArguments ]`: - - `[UpdatedAt ]`: - - `[VersionlessDownloadUrl ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareAppAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareAppAssociation.md deleted file mode 100644 index e880cf129..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareAppAssociation.md +++ /dev/null @@ -1,308 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareAppAssociation.md -schema: 2.0.0 ---- - -# Set-JcSdkSoftwareAppAssociation - -## SYNOPSIS -This endpoint allows you to associate or disassociate a software application to a system or system group. - -#### Sample Request -``` -$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '{ - \"id\": \"\\", - \"op\": \"add\", - \"type\": \"system\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkSoftwareAppAssociation -ConsoleHost -SoftwareAppId [-Attributes ] - [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkSoftwareAppAssociation -ConsoleHost -SoftwareAppId - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkSoftwareAppAssociation -ConsoleHost -InputObject - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkSoftwareAppAssociation -ConsoleHost -InputObject - [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint allows you to associate or disassociate a software application to a system or system group. - -#### Sample Request -``` -$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations \\ --H 'Accept: application/json' \\ --H 'Content-Type: application/json' \\ --H 'x-api-key: {API_KEY}' \\ --d '{ - \"id\": \"\\", - \"op\": \"add\", - \"type\": \"system\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkSoftwareAppAssociation -SoftwareAppId:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkSoftwareAppAssociation -SoftwareAppId:() -Id:() -Op:() -Type:() -Attributes:() -``` - - - -## PARAMETERS - -### -Attributes -The graph attributes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -GraphOperation (SoftwareApp) - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphOperationSoftwareApp -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectID of graph object being added or removed as an association. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Op -How to modify the graph connection. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SoftwareAppId -ObjectID of the Software App. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Targets which a "software_app" can be associated to. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGraphOperationSoftwareApp - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GraphOperation (SoftwareApp) - - `Id `: The ObjectID of graph object being added or removed as an association. - - `Op `: How to modify the graph connection. - - `Type `: Targets which a "software_app" can be associated to. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemAssociation.md deleted file mode 100644 index a60a1d1f7..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemAssociation.md +++ /dev/null @@ -1,360 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemAssociation.md -schema: 2.0.0 ---- - -# Set-JcSdkSystemAssociation - -## SYNOPSIS -This endpoint allows you to manage the _direct_ associations of a System. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"attributes\": { - \"sudo\": { - \"enabled\": true, - \"withoutPassword\": false - } - }, - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"UserID\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkSystemAssociation -ConsoleHost -SystemId [-Authorization ] [-Date ] - [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### Set -``` -Set-JcSdkSystemAssociation -ConsoleHost -SystemId -Body - [-Authorization ] [-Date ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkSystemAssociation -ConsoleHost -InputObject - -Body [-Authorization ] [-Date ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkSystemAssociation -ConsoleHost -InputObject - [-Authorization ] [-Date ] [-Attributes ] [-Id ] [-Op ] - [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to manage the _direct_ associations of a System. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"attributes\": { - \"sudo\": { - \"enabled\": true, - \"withoutPassword\": false - } - }, - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"UserID\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkSystemAssociation -SystemId:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkSystemAssociation -SystemId:() -Id:() -Op:() -Type:() -Attributes:() -``` - - - -## PARAMETERS - -### -Attributes -. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authorization -Authorization header for the System Context API - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -GraphOperation (System) - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphOperationSystem -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Date -Current date header for the System Context API - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectID of graph object being added or removed as an association. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Op -How to modify the graph connection. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SystemId -ObjectID of the System. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Targets which a "system" can be associated to. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGraphOperationSystem - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GraphOperation (System) - - `Id `: The ObjectID of graph object being added or removed as an association. - - `Op `: How to modify the graph connection. - - `Type `: Targets which a "system" can be associated to. - - `[Attributes ]`: - - `[(Any) ]`: This indicates any property can be added to this object. - - `[SudoEnabled ]`: Enables sudo - - `[SudoWithoutPassword ]`: Enable sudo without password (requires 'enabled' to be true) - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroup.md deleted file mode 100644 index 55e5e1f4f..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroup.md +++ /dev/null @@ -1,425 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroup.md -schema: 2.0.0 ---- - -# Set-JcSdkSystemGroup - -## SYNOPSIS -This endpoint allows you to do a full set of the System Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Name_set - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkSystemGroup -ConsoleHost -Id [-Attributes ] [-Description ] - [-Email ] [-MemberQueryExemptions ] [-MemberQueryFilters ] - [-MemberQuerySearchFilters ] [-MemberQueryType ] [-MembershipMethod ] - [-MemberSuggestionsNotify] [-Name ] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkSystemGroup -ConsoleHost -Id -Body [-Confirm] [-WhatIf] - [] -``` - -### SetViaIdentity -``` -Set-JcSdkSystemGroup -ConsoleHost -InputObject -Body - [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkSystemGroup -ConsoleHost -InputObject [-Attributes ] - [-Description ] [-Email ] [-MemberQueryExemptions ] - [-MemberQueryFilters ] [-MemberQuerySearchFilters ] [-MemberQueryType ] - [-MembershipMethod ] [-MemberSuggestionsNotify] [-Name ] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint allows you to do a full set of the System Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"Name_set - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkSystemGroup -Id:() -Body:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkSystemGroup -Id:() -Name:() -Attributes:() -Description:() -Email:() -MemberQueryExemptions:() -MemberQueryFilters:() -MemberQueryType:() -MemberSuggestionsNotify:() -MembershipMethod:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GraphAttributes -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -Type String - -## PARAMETERS - -### -Attributes -The graph attributes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -SystemGroupPut - -```yaml -Type: JumpCloud.SDK.V2.Models.ISystemGroupPut -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Description of a System Group - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Email -Email address of a System Group - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -ObjectID of the System Group. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MemberQueryExemptions -Array of GraphObjects exempted from the query - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphObject[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberQueryFilters -For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. - -```yaml -Type: System.String[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberQuerySearchFilters -For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberQueryType -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MembershipMethod -The type of membership method for this group. -Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED.Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices).Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberSuggestionsNotify -True if notification emails are to be sent for membership suggestions. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Display name of a System Group. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.ISystemGroupPut - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.ISystemGroup - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: SystemGroupPut - - `Name `: Display name of a System Group. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - - `[Description ]`: Description of a System Group - - `[Email ]`: Email address of a System Group - - `[MemberQueryExemptions >]`: Array of GraphObjects exempted from the query - - `Id `: The ObjectID of the graph object. - - `Type `: The type of graph object. - - `[Attributes ]`: The graph attributes. - - `[MemberQueryFilters >]`: For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. - - `[MemberQuerySearchFilters ]`: For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. - - `[MemberQueryType ]`: - - `[MemberSuggestionsNotify ]`: True if notification emails are to be sent for membership suggestions. - - `[MembershipMethod ]`: The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED. Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices). Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -`MEMBERQUERYEXEMPTIONS `: Array of GraphObjects exempted from the query - - `Id `: The ObjectID of the graph object. - - `Type `: The type of graph object. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupAssociation.md deleted file mode 100644 index fe8e44005..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupAssociation.md +++ /dev/null @@ -1,314 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupAssociation.md -schema: 2.0.0 ---- - -# Set-JcSdkSystemGroupAssociation - -## SYNOPSIS -This endpoint allows you to manage the _direct_ associations of a System Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{UserID}\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkSystemGroupAssociation -ConsoleHost -GroupId [-Attributes ] - [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkSystemGroupAssociation -ConsoleHost -GroupId -Body - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkSystemGroupAssociation -ConsoleHost -InputObject - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkSystemGroupAssociation -ConsoleHost -InputObject - [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint allows you to manage the _direct_ associations of a System Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{UserID}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkSystemGroupAssociation -GroupId:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkSystemGroupAssociation -GroupId:() -Id:() -Op:() -Type:() -Attributes:() -``` - - - -## PARAMETERS - -### -Attributes -The graph attributes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -GraphOperation (SystemGroup) - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphOperationSystemGroup -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the System Group. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectID of graph object being added or removed as an association. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Op -How to modify the graph connection. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Targets which a "system_group" can be associated to. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGraphOperationSystemGroup - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GraphOperation (SystemGroup) - - `Id `: The ObjectID of graph object being added or removed as an association. - - `Op `: How to modify the graph connection. - - `Type `: Targets which a "system_group" can be associated to. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupMember.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupMember.md deleted file mode 100644 index 1ec9f9acb..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupMember.md +++ /dev/null @@ -1,323 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupMember.md -schema: 2.0.0 ---- - -# Set-JcSdkSystemGroupMember - -## SYNOPSIS -This endpoint allows you to manage the system members of a System Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system\", - \"id\": \"{System_ID}\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkSystemGroupMember -ConsoleHost -GroupId [-Authorization ] [-Date ] - [-Attributes ] [-Id ] [-Op ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkSystemGroupMember -ConsoleHost -GroupId -Body - [-Authorization ] [-Date ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkSystemGroupMember -ConsoleHost -InputObject - -Body [-Authorization ] [-Date ] [-PassThru] [-Confirm] - [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkSystemGroupMember -ConsoleHost -InputObject - [-Authorization ] [-Date ] [-Attributes ] [-Id ] [-Op ] - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to manage the system members of a System Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system\", - \"id\": \"{System_ID}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkSystemGroupMember -GroupId:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkSystemGroupMember -GroupId:() -Id:() -Op:() -Attributes:() -``` - - - -## PARAMETERS - -### -Attributes -The graph attributes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authorization -Authorization header for the System Context API - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -GraphOperation (SystemGroup-Member) - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphOperationSystemGroupMember -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Date -Current date header for the System Context API - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the System Group. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectID of graph object being added or removed as an association. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Op -How to modify the graph connection. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGraphOperationSystemGroupMember - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GraphOperation (SystemGroup-Member) - - `Id `: The ObjectID of graph object being added or removed as an association. - - `Op `: How to modify the graph connection. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserAssociation.md deleted file mode 100644 index c4e96950a..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserAssociation.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserAssociation.md -schema: 2.0.0 ---- - -# Set-JcSdkUserAssociation - -## SYNOPSIS -This endpoint allows you to manage the _direct_ associations of a User. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"attributes\": { - \"sudo\": { - \"enabled\": true, - \"withoutPassword\": false - } - }, - \"op\": \"add\", - \"type\": \"system_group\", - \"id\": \"{GroupID}\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkUserAssociation -ConsoleHost -UserId [-Attributes ] [-Id ] - [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkUserAssociation -ConsoleHost -UserId -Body [-PassThru] - [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkUserAssociation -ConsoleHost -InputObject - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkUserAssociation -ConsoleHost -InputObject [-Attributes ] - [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to manage the _direct_ associations of a User. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"attributes\": { - \"sudo\": { - \"enabled\": true, - \"withoutPassword\": false - } - }, - \"op\": \"add\", - \"type\": \"system_group\", - \"id\": \"{GroupID}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkUserAssociation -UserId:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkUserAssociation -UserId:() -Id:() -Op:() -Type:() -Attributes:() -``` - - - -## PARAMETERS - -### -Attributes -. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -GraphOperation (User) - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphOperationUser -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectID of graph object being added or removed as an association. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Op -How to modify the graph connection. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Targets which a "user" can be associated to. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -ObjectID of the User. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGraphOperationUser - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GraphOperation (User) - - `Id `: The ObjectID of graph object being added or removed as an association. - - `Op `: How to modify the graph connection. - - `Type `: Targets which a "user" can be associated to. - - `[Attributes ]`: - - `[(Any) ]`: This indicates any property can be added to this object. - - `[SudoEnabled ]`: Enables sudo - - `[SudoWithoutPassword ]`: Enable sudo without password (requires 'enabled' to be true) - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroup.md deleted file mode 100644 index 5bc9dc476..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroup.md +++ /dev/null @@ -1,443 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroup.md -schema: 2.0.0 ---- - -# Set-JcSdkUserGroup - -## SYNOPSIS -This endpoint allows you to do a full set of the User Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"group_set - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkUserGroup -ConsoleHost -Id [-Attributes ] [-Description ] - [-Email ] [-MemberQueryExemptions ] [-MemberQueryFilters ] - [-MemberQuerySearchFilters ] [-MemberQueryType ] [-MembershipMethod ] - [-MemberSuggestionsNotify] [-Name ] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkUserGroup -ConsoleHost -Id -Body [-Confirm] [-WhatIf] - [] -``` - -### SetViaIdentity -``` -Set-JcSdkUserGroup -ConsoleHost -InputObject -Body [-Confirm] - [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkUserGroup -ConsoleHost -InputObject [-Attributes ] - [-Description ] [-Email ] [-MemberQueryExemptions ] - [-MemberQueryFilters ] [-MemberQuerySearchFilters ] [-MemberQueryType ] - [-MembershipMethod ] [-MemberSuggestionsNotify] [-Name ] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint allows you to do a full set of the User Group. - -See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. - -#### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"name\": \"group_set - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkUserGroup -Id:() -Body:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -SuggestionCountAdd Int -SuggestionCountRemove Int -SuggestionCountTotal Int -Type String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkUserGroup -Id:() -Name:() -Attributes:() -Description:() -Email:() -MemberQueryExemptions:() -MemberQueryFilters:() -MemberQueryType:() -MemberSuggestionsNotify:() -MembershipMethod:() -``` - ----- ---------- -Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup -Description String -Email String -Id String -MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] -MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] -MemberQueryType String -MembershipMethod String -MemberSuggestionsNotify Boolean -Name String -SuggestionCountAdd Int -SuggestionCountRemove Int -SuggestionCountTotal Int -Type String - -## PARAMETERS - -### -Attributes -The graph attributes for a UserGroup. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -UserGroupPut - -```yaml -Type: JumpCloud.SDK.V2.Models.IUserGroupPut -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Description of a User Group - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Email -Email address of a User Group - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -ObjectID of the User Group. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MemberQueryExemptions -Array of GraphObjects exempted from the query - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphObject[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberQueryFilters -For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. - -```yaml -Type: System.String[] -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberQuerySearchFilters -For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberQueryType -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MembershipMethod -The type of membership method for this group. -Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED.Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices).Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberSuggestionsNotify -True if notification emails are to be sent for membership suggestions. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Display name of a User Group. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.IUserGroupPut - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IUserGroup - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: UserGroupPut - - `Name `: Display name of a User Group. - - `[Attributes ]`: The graph attributes for a UserGroup. - - `[(Any) ]`: This indicates any property can be added to this object. - - `[SudoEnabled ]`: Enables sudo - - `[SudoWithoutPassword ]`: Enable sudo without password (requires 'enabled' to be true) - - `[LdapGroups >]`: - - `[Name ]`: - - `[PosixGroups >]`: - - `Id `: - - `Name `: - - `[RadiusReply >]`: - - `Name `: - - `Value `: - - `[SambaEnabled ]`: - - `[Description ]`: Description of a User Group - - `[Email ]`: Email address of a User Group - - `[MemberQueryExemptions >]`: Array of GraphObjects exempted from the query - - `Id `: The ObjectID of the graph object. - - `Type `: The type of graph object. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - - `[MemberQueryFilters >]`: For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. - - `[MemberQuerySearchFilters ]`: For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. - - `[MemberQueryType ]`: - - `[MemberSuggestionsNotify ]`: True if notification emails are to be sent for membership suggestions. - - `[MembershipMethod ]`: The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED. Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices). Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -`MEMBERQUERYEXEMPTIONS `: Array of GraphObjects exempted from the query - - `Id `: The ObjectID of the graph object. - - `Type `: The type of graph object. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupAssociation.md deleted file mode 100644 index 03f43ec87..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupAssociation.md +++ /dev/null @@ -1,314 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupAssociation.md -schema: 2.0.0 ---- - -# Set-JcSdkUserGroupAssociation - -## SYNOPSIS -This endpoint manages the _direct_ associations of this User Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system\", - \"id\": \"{SystemID}\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkUserGroupAssociation -ConsoleHost -GroupId [-Attributes ] [-Id ] - [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkUserGroupAssociation -ConsoleHost -GroupId -Body - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkUserGroupAssociation -ConsoleHost -InputObject - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkUserGroupAssociation -ConsoleHost -InputObject - [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint manages the _direct_ associations of this User Group. - -A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. - - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"system\", - \"id\": \"{SystemID}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkUserGroupAssociation -GroupId:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkUserGroupAssociation -GroupId:() -Id:() -Op:() -Type:() -Attributes:() -``` - - - -## PARAMETERS - -### -Attributes -The graph attributes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -GraphOperation (UserGroup) - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphOperationUserGroup -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the User Group. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectID of graph object being added or removed as an association. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Op -How to modify the graph connection. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Targets which a "user_group" can be associated to. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGraphOperationUserGroup - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GraphOperation (UserGroup) - - `Id `: The ObjectID of graph object being added or removed as an association. - - `Op `: How to modify the graph connection. - - `Type `: Targets which a "user_group" can be associated to. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupMember.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupMember.md deleted file mode 100644 index e74d19a43..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupMember.md +++ /dev/null @@ -1,291 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupMember.md -schema: 2.0.0 ---- - -# Set-JcSdkUserGroupMember - -## SYNOPSIS -This endpoint allows you to manage the user members of a User Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{User_ID}\" - }' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkUserGroupMember -ConsoleHost -GroupId [-Attributes ] [-Id ] - [-Op ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkUserGroupMember -ConsoleHost -GroupId -Body - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentity -``` -Set-JcSdkUserGroupMember -ConsoleHost -InputObject - -Body [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkUserGroupMember -ConsoleHost -InputObject [-Attributes ] - [-Id ] [-Op ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to manage the user members of a User Group. - -#### Sample Request -``` -curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"op\": \"add\", - \"type\": \"user\", - \"id\": \"{User_ID}\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkUserGroupMember -GroupId:() -Body:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkUserGroupMember -GroupId:() -Id:() -Op:() -Attributes:() -``` - - - -## PARAMETERS - -### -Attributes -The graph attributes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -GraphOperation (UserGroup-Member) - -```yaml -Type: JumpCloud.SDK.V2.Models.IGraphOperationUserGroupMember -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -ObjectID of the User Group. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectID of graph object being added or removed as an association. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Op -How to modify the graph connection. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGraphOperationUserGroupMember - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GraphOperation (UserGroup-Member) - - `Id `: The ObjectID of graph object being added or removed as an association. - - `Op `: How to modify the graph connection. - - `[Attributes ]`: The graph attributes. - - `[(Any) ]`: This indicates any property can be added to this object. - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkWorkday.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkWorkday.md deleted file mode 100644 index e44cfb5e4..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkWorkday.md +++ /dev/null @@ -1,281 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkWorkday.md -schema: 2.0.0 ---- - -# Set-JcSdkWorkday - -## SYNOPSIS -This endpoint allows you to set the name and Custom Report URL for a Workday Instance. - -Currently, the name can not be changed from the default of `Workday Import`. - -##### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/workdays/{WorkdayID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ -\t\"reportUrl\":\"{Report_URL}\", -\t\"name\":\"{Name}\" -}\t' -``` - -## SYNTAX - -### SetExpanded (Default) -``` -Set-JcSdkWorkday -ConsoleHost -Id [-Name ] [-ReportUrl ] [-Confirm] - [-WhatIf] [] -``` - -### Set -``` -Set-JcSdkWorkday -ConsoleHost -Id -Body [-Confirm] [-WhatIf] - [] -``` - -### SetViaIdentity -``` -Set-JcSdkWorkday -ConsoleHost -InputObject -Body [-Confirm] - [-WhatIf] [] -``` - -### SetViaIdentityExpanded -``` -Set-JcSdkWorkday -ConsoleHost -InputObject [-Name ] - [-ReportUrl ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows you to set the name and Custom Report URL for a Workday Instance. - -Currently, the name can not be changed from the default of `Workday Import`. - -##### Sample Request -``` -curl -X PUT https://console.jumpcloud.com/api/v2/workdays/{WorkdayID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ -\t\"reportUrl\":\"{Report_URL}\", -\t\"name\":\"{Name}\" -}\t' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Set-JcSdkWorkday -Id:() -Body:() -``` - ----- ---------- -BasicExpiry String -BasicIsValid Boolean -BasicMessage String -Id String -LastImport String -Name String -OauthExpiry String -OauthIsValid Boolean -OauthMessage String -ReportUrl String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Set-JcSdkWorkday -Id:() -Name:() -ReportUrl:() -``` - ----- ---------- -BasicExpiry String -BasicIsValid Boolean -BasicMessage String -Id String -LastImport String -Name String -OauthExpiry String -OauthIsValid Boolean -OauthMessage String -ReportUrl String - -## PARAMETERS - -### -Body -Workday Fields - -```yaml -Type: JumpCloud.SDK.V2.Models.IWorkdayFields -Parameter Sets: Set, SetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Set, SetExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SetViaIdentity, SetViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportUrl -. - -```yaml -Type: System.String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.IWorkdayFields - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IWorkdayOutput - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: Workday Fields - - `[Name ]`: - - `[ReportUrl ]`: - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Stop-JcSdkAppleMdmDevice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Stop-JcSdkAppleMdmDevice.md deleted file mode 100644 index 36aee53d2..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Stop-JcSdkAppleMdmDevice.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Stop-JcSdkAppleMdmDevice.md -schema: 2.0.0 ---- - -# Stop-JcSdkAppleMdmDevice - -## SYNOPSIS -Shuts down a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/shutdown \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -## SYNTAX - -### Stop (Default) -``` -Stop-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId [-PassThru] [-Confirm] - [-WhatIf] [] -``` - -### StopViaIdentity -``` -Stop-JcSdkAppleMdmDevice -ConsoleHost -InputObject [-PassThru] [-Confirm] - [-WhatIf] [] -``` - -## DESCRIPTION -Shuts down a DEP-enrolled device. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/shutdown \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Stop-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -AppleMdmId -. - -```yaml -Type: System.String -Parameter Sets: Stop -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeviceId -. - -```yaml -Type: System.String -Parameter Sets: Stop -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: StopViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Sync-JcSdkAppleMdmDevice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Sync-JcSdkAppleMdmDevice.md deleted file mode 100644 index aacde8cef..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Sync-JcSdkAppleMdmDevice.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Sync-JcSdkAppleMdmDevice.md -schema: 2.0.0 ---- - -# Sync-JcSdkAppleMdmDevice - -## SYNOPSIS -Refreshes the list of devices that a JumpCloud admin has added to their virtual MDM in Apple Business Manager - ABM so that they can be DEP enrolled with JumpCloud. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/refreshdepdevices \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -## SYNTAX - -### Sync (Default) -``` -Sync-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### SyncViaIdentity -``` -Sync-JcSdkAppleMdmDevice -ConsoleHost -InputObject [-PassThru] [-Confirm] - [-WhatIf] [] -``` - -## DESCRIPTION -Refreshes the list of devices that a JumpCloud admin has added to their virtual MDM in Apple Business Manager - ABM so that they can be DEP enrolled with JumpCloud. - -#### Sample Request -``` - curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/refreshdepdevices \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Sync-JcSdkAppleMdmDevice -AppleMdmId:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -AppleMdmId -. - -```yaml -Type: System.String -Parameter Sets: Sync -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: SyncViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAppleMdmDeviceLockInformation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAppleMdmDeviceLockInformation.md deleted file mode 100644 index dba310017..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAppleMdmDeviceLockInformation.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAppleMdmDeviceLockInformation.md -schema: 2.0.0 ---- - -# Update-JcSdkAppleMdmDeviceLockInformation - -## SYNOPSIS -Refreshes the activation lock information for a device - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/refreshActivationLockInformation \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -## SYNTAX - -### Refresh (Default) -``` -Update-JcSdkAppleMdmDeviceLockInformation -ConsoleHost -AppleMdmId -DeviceId - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### RefreshViaIdentity -``` -Update-JcSdkAppleMdmDeviceLockInformation -ConsoleHost -InputObject - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Refreshes the activation lock information for a device - -#### Sample Request - -``` -curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/refreshActivationLockInformation \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Update-JcSdkAppleMdmDeviceLockInformation -AppleMdmId:() -DeviceId:() -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -AppleMdmId -. - -```yaml -Type: System.String -Parameter Sets: Refresh -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeviceId -. - -```yaml -Type: System.String -Parameter Sets: Refresh -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: RefreshViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAuthenticationPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAuthenticationPolicy.md deleted file mode 100644 index 858b2fbe8..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAuthenticationPolicy.md +++ /dev/null @@ -1,626 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAuthenticationPolicy.md -schema: 2.0.0 ---- - -# Update-JcSdkAuthenticationPolicy - -## SYNOPSIS -Patch the specified authentication policy. - -#### Sample Request -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ \"disabled\": false }' -``` - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-JcSdkAuthenticationPolicy -ConsoleHost -Id [-Conditions ] - [-CustomErrorMessage ] [-CustomErrorMessageEnabled] [-Description ] [-Disabled] - [-EffectAction ] [-MfaRequired] [-Name ] - [-ObligationMfaFactors ] [-PrimaryHelpText ] - [-PrimaryHelpUrl ] [-SecondaryHelpText ] [-SecondaryHelpUrl ] - [-TargetResources ] [-Type ] - [-UserAttributeExclusions ] - [-UserAttributeInclusions ] [-UserGroupExclusions ] - [-UserGroupInclusions ] [-UserInclusions ] [-UserVerificationRequirement ] - [-Confirm] [-WhatIf] [] -``` - -### Update -``` -Update-JcSdkAuthenticationPolicy -ConsoleHost -Id -Body [-Confirm] [-WhatIf] - [] -``` - -### UpdateViaIdentity -``` -Update-JcSdkAuthenticationPolicy -ConsoleHost -InputObject - -Body [-Confirm] [-WhatIf] [] -``` - -### UpdateViaIdentityExpanded -``` -Update-JcSdkAuthenticationPolicy -ConsoleHost -InputObject - [-Conditions ] [-CustomErrorMessage ] [-CustomErrorMessageEnabled] [-Description ] - [-Disabled] [-EffectAction ] [-MfaRequired] [-Name ] - [-ObligationMfaFactors ] [-PrimaryHelpText ] - [-PrimaryHelpUrl ] [-SecondaryHelpText ] [-SecondaryHelpUrl ] - [-TargetResources ] [-Type ] - [-UserAttributeExclusions ] - [-UserAttributeInclusions ] [-UserGroupExclusions ] - [-UserGroupInclusions ] [-UserInclusions ] [-UserVerificationRequirement ] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Patch the specified authentication policy. - -#### Sample Request -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ \"disabled\": false }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Update-JcSdkAuthenticationPolicy -Id:() -Body:() -``` - ----- ---------- -Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions -Description String -Disabled Boolean -EffectAction String -Id String -MfaRequired Boolean -Name String -TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] -Type String -UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserGroupExclusions String -UserGroupInclusions String -UserInclusions String -UserVerificationRequirement String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Update-JcSdkAuthenticationPolicy -Id:() -Conditions:() -Description:() -Disabled:() -EffectAction:() -MfaRequired:() -Name:() -TargetResources:() -Type:() -UserAttributeExclusions:() -UserAttributeInclusions:() -UserGroupExclusions:() -UserGroupInclusions:() -UserInclusions:() -UserVerificationRequirement:() -``` - ----- ---------- -Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions -Description String -Disabled Boolean -EffectAction String -Id String -MfaRequired Boolean -Name String -TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] -Type String -UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] -UserGroupExclusions String -UserGroupInclusions String -UserInclusions String -UserVerificationRequirement String - -## PARAMETERS - -### -Body -This represents an authentication policy. -See the details of each field for valid values and restrictions. - -```yaml -Type: JumpCloud.SDK.V2.Models.IAuthnPolicy -Parameter Sets: Update, UpdateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Conditions -Dictionary of \ - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomErrorMessage -The custom error message to be displayed when the policy is applied. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomErrorMessageEnabled -Indicates whether the custom error message is enabled or not. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EffectAction -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Unique identifier of the authentication policy - -```yaml -Type: System.String -Parameter Sets: Update, UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MfaRequired -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObligationMfaFactors -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IAuthnPolicyObligationsMfaFactorsItem[] -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryHelpText -The text to be displayed for the help link. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryHelpUrl -The URL to be opened when the help link is clicked. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryHelpText -The text to be displayed for the help link. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryHelpUrl -The URL to be opened when the help link is clicked. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetResources -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IAuthnPolicyResourceTarget[] -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -AuthnPolicyType - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserAttributeExclusions -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IAuthnPolicyUserAttributeFilter[] -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserAttributeInclusions -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IAuthnPolicyUserAttributeFilter[] -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserGroupExclusions -. - -```yaml -Type: System.String[] -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserGroupInclusions -. - -```yaml -Type: System.String[] -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserInclusions -. - -```yaml -Type: System.String[] -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserVerificationRequirement -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IAuthnPolicy - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IAuthnPolicy - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: This represents an authentication policy. See the details of each field for valid values and restrictions. - - `[Conditions ]`: Dictionary of - - `[(Any) ]`: This indicates any property can be added to this object. - - `[CustomErrorMessage ]`: The custom error message to be displayed when the policy is applied. - - `[CustomErrorMessageEnabled ]`: Indicates whether the custom error message is enabled or not. - - `[Description ]`: - - `[Disabled ]`: - - `[EffectAction ]`: - - `[MfaRequired ]`: - - `[Name ]`: - - `[ObligationMfaFactors >]`: - - `[Type ]`: - - `[PrimaryHelpText ]`: The text to be displayed for the help link. - - `[PrimaryHelpUrl ]`: The URL to be opened when the help link is clicked. - - `[SecondaryHelpText ]`: The text to be displayed for the help link. - - `[SecondaryHelpUrl ]`: The URL to be opened when the help link is clicked. - - `[TargetResources >]`: - - `Type `: - - `[Id ]`: Object ID of the resource target. If undefined, then all resources of the given type are targeted. - - `[Type ]`: AuthnPolicyType - - `[UserAttributeExclusions >]`: - - `[Field ]`: The only field that is currently supported is ldap_binding_user - - `[Operator ]`: - - `[Value ]`: Can be any value - string, number, boolean, array or object. - - `[UserAttributeInclusions >]`: - - `[UserGroupExclusions >]`: - - `[UserGroupInclusions >]`: - - `[UserInclusions >]`: - - `[UserVerificationRequirement ]`: - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -`OBLIGATIONMFAFACTORS `: . - - `[Type ]`: - -`TARGETRESOURCES `: . - - `Type `: - - `[Id ]`: Object ID of the resource target. If undefined, then all resources of the given type are targeted. - -`USERATTRIBUTEEXCLUSIONS `: . - - `[Field ]`: The only field that is currently supported is ldap_binding_user - - `[Operator ]`: - - `[Value ]`: Can be any value - string, number, boolean, array or object. - -`USERATTRIBUTEINCLUSIONS `: . - - `[Field ]`: The only field that is currently supported is ldap_binding_user - - `[Operator ]`: - - `[Value ]`: Can be any value - string, number, boolean, array or object. - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkBulkUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkBulkUser.md deleted file mode 100644 index ad3c88679..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkBulkUser.md +++ /dev/null @@ -1,268 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkBulkUser.md -schema: 2.0.0 ---- - -# Update-JcSdkBulkUser - -## SYNOPSIS -The endpoint allows you to update a bulk job to asynchronously update users. -See [update a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_put) for full list of attributes. - -#### Sample Request -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '[ -\t{ -\t \"id\":\"5be9fb4ddb01290001e85109\", -\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", -\t\t\"department\":\"{UPDATED_DEPARTMENT}\", -\t\t\"attributes\":[ -\t\t\t{\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} -\t\t] -\t}, -\t{ -\t \"id\":\"5be9fb4ddb01290001e85109\", -\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", -\t\t\"costCenter\":\"{UPDATED_COST_CENTER}\", -\t\t\"phoneNumbers\":[ -\t\t\t{\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, -\t\t\t{\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} -\t\t] -\t} -] -``` - -## SYNTAX - -``` -Update-JcSdkBulkUser -ConsoleHost -Body > [-SuppressEmail] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -The endpoint allows you to update a bulk job to asynchronously update users. -See [update a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_put) for full list of attributes. - -#### Sample Request -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '[ -\t{ -\t \"id\":\"5be9fb4ddb01290001e85109\", -\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", -\t\t\"department\":\"{UPDATED_DEPARTMENT}\", -\t\t\"attributes\":[ -\t\t\t{\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} -\t\t] -\t}, -\t{ -\t \"id\":\"5be9fb4ddb01290001e85109\", -\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", -\t\t\"costCenter\":\"{UPDATED_COST_CENTER}\", -\t\t\"phoneNumbers\":[ -\t\t\t{\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, -\t\t\t{\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} -\t\t] -\t} -] -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Update-JcSdkBulkUser -``` - - - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -{{ Add code here }} -``` - -{{ Add output here }} - -## PARAMETERS - -### -Body -Array of bulk-user-update - -```yaml -Type: System.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserUpdate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuppressEmail -An option indicating whether to suppress the job results email that will -otherwise be sent to the Administrator who created the job. -If true, the -email won't be sent. -If omitted or false, the email will be sent. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserUpdate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IJobIdResult - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY >`: Array of bulk-user-update - - `[AccountLocked ]`: - - `[Addresses >]`: type, poBox, extendedAddress, streetAddress, locality, region, postalCode, country - - `[Country ]`: - - `[ExtendedAddress ]`: - - `[Locality ]`: - - `[PoBox ]`: - - `[PostalCode ]`: - - `[Region ]`: - - `[StreetAddress ]`: - - `[Type ]`: - - `[AllowPublicKey ]`: - - `[AlternateEmail ]`: - - `[Attributes >]`: - - `[Name ]`: - - `[Value ]`: - - `[Company ]`: - - `[CostCenter ]`: - - `[DelegatedAuthorityId ]`: ObjectId of the target Active Directory connection - - `[DelegatedAuthorityName ]`: Authority name - - `[Department ]`: - - `[Description ]`: - - `[DisableDeviceMaxLoginAttempts ]`: - - `[Displayname ]`: - - `[Email ]`: - - `[EmployeeIdentifier ]`: Must be unique per user. - - `[EmployeeType ]`: - - `[EnableManagedUid ]`: - - `[EnableUserPortalMultifactor ]`: - - `[ExternalDn ]`: - - `[ExternalPasswordExpirationDate ]`: - - `[ExternalSourceType ]`: - - `[ExternallyManaged ]`: - - `[Firstname ]`: - - `[Id ]`: Object ID of the user being updated - - `[JobTitle ]`: - - `[Lastname ]`: - - `[LdapBindingUser ]`: - - `[Location ]`: - - `[ManagedAppleId ]`: - - `[Manager ]`: Relation with another systemuser to identify the last as a manager. - - `[MfaConfigured ]`: - - `[MfaExclusion ]`: - - `[MfaExclusionDays ]`: - - `[MfaExclusionUntil ]`: - - `[Middlename ]`: - - `[Organization ]`: Organization object id of the user - - `[Password ]`: - - `[PasswordNeverExpires ]`: - - `[PasswordlessSudo ]`: - - `[PhoneNumbers >]`: - - `[Number ]`: - - `[Type ]`: - - `[PublicKey ]`: - - `[Relationships >]`: - - `[Type ]`: - - `[Value ]`: - - `[RestrictedField ]`: - - `[RestrictedFieldId ]`: - - `[RestrictedFieldType ]`: - - `[SambaServiceUser ]`: - - `[SshKeys >]`: - - `Name `: The name of the SSH key. - - `PublicKey `: The Public SSH key. - - `[State ]`: - - `[Sudo ]`: - - `[Suspended ]`: - - `[UnixGuid ]`: - - `[UnixUid ]`: - - `[Username ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkGSuite.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkGSuite.md deleted file mode 100644 index cb67d614d..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkGSuite.md +++ /dev/null @@ -1,407 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkGSuite.md -schema: 2.0.0 ---- - -# Update-JcSdkGSuite - -## SYNOPSIS -This endpoint allows updating some attributes of a G Suite. - -##### Sample Request - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"userLockoutAction\": \"suspend\", - \"userPasswordExpirationAction\": \"maintain\" - }' -``` -Sample Request, set a default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": { - \"id\": \"{domainObjectID}\" - } - }' -``` - -Sample Request, unset the default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": {} - }' -``` - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-JcSdkGSuite -ConsoleHost -Id [-DefaultDomainId ] [-GroupsEnabled] - [-ImportFilter ] [-Name ] [-OrganizationObjectIdInputFile ] - [-UserLockoutAction ] [-UserPasswordExpirationAction ] [-Confirm] [-WhatIf] - [] -``` - -### Update -``` -Update-JcSdkGSuite -ConsoleHost -Id -Body [-Confirm] [-WhatIf] - [] -``` - -### UpdateViaIdentity -``` -Update-JcSdkGSuite -ConsoleHost -InputObject -Body [-Confirm] - [-WhatIf] [] -``` - -### UpdateViaIdentityExpanded -``` -Update-JcSdkGSuite -ConsoleHost -InputObject [-DefaultDomainId ] - [-GroupsEnabled] [-ImportFilter ] [-Name ] [-OrganizationObjectIdInputFile ] - [-UserLockoutAction ] [-UserPasswordExpirationAction ] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint allows updating some attributes of a G Suite. - -##### Sample Request - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"userLockoutAction\": \"suspend\", - \"userPasswordExpirationAction\": \"maintain\" - }' -``` -Sample Request, set a default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": { - \"id\": \"{domainObjectID}\" - } - }' -``` - -Sample Request, unset the default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": {} - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Update-JcSdkGSuite -Id:() -Body:() -``` - ----- ---------- -DefaultDomainDomain String -DefaultDomainId String -GroupsEnabled Boolean -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Update-JcSdkGSuite -Id:() -DefaultDomainId:() -GroupsEnabled:() -Name:() -UserLockoutAction:() -UserPasswordExpirationAction:() -``` - ----- ---------- -DefaultDomainDomain String -DefaultDomainId String -GroupsEnabled Boolean -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - -## PARAMETERS - -### -Body -GSuite - -```yaml -Type: JumpCloud.SDK.V2.Models.IGsuite -Parameter Sets: Update, UpdateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultDomainId -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupsEnabled -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Unique identifier of the GSuite. - -```yaml -Type: System.String -Parameter Sets: Update, UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImportFilter -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationObjectIdInputFile -Input File for OrganizationObjectId (OrganizationObjectId is the object id of the organization that the account belongs to.) - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserLockoutAction -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserPasswordExpirationAction -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IGsuite - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IGsuite - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: GSuite - - `[DefaultDomainId ]`: - - `[GroupsEnabled ]`: - - `[ImportFilter ]`: - - `[Name ]`: - - `[OrganizationObjectId ]`: OrganizationObjectId is the object id of the organization that the account belongs to. - - `[UserLockoutAction ]`: - - `[UserPasswordExpirationAction ]`: - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkIPList.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkIPList.md deleted file mode 100644 index fb4f724b2..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkIPList.md +++ /dev/null @@ -1,275 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkIPList.md -schema: 2.0.0 ---- - -# Update-JcSdkIPList - -## SYNOPSIS -Update a specific IP list. - -#### Sample Request -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{\"name\": \"New IP List Name\"}' -``` - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-JcSdkIPList -ConsoleHost -Id [-Description ] [-Ips ] - [-Name ] [-Confirm] [-WhatIf] [] -``` - -### Update -``` -Update-JcSdkIPList -ConsoleHost -Id -Body [-Confirm] [-WhatIf] - [] -``` - -### UpdateViaIdentity -``` -Update-JcSdkIPList -ConsoleHost -InputObject -Body - [-Confirm] [-WhatIf] [] -``` - -### UpdateViaIdentityExpanded -``` -Update-JcSdkIPList -ConsoleHost -InputObject [-Description ] - [-Ips ] [-Name ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Update a specific IP list. - -#### Sample Request -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/iplists/{id} \\ - -H 'accept: application/json' \\ - -H 'content-type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{\"name\": \"New IP List Name\"}' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Update-JcSdkIPList -Id:() -Body:() -``` - ----- ---------- -Description String -Id String -Ips String -Name String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Update-JcSdkIPList -Id:() -Description:() -Ips:() -Name:() -``` - ----- ---------- -Description String -Id String -Ips String -Name String - -## PARAMETERS - -### -Body -IPListRequest - -```yaml -Type: JumpCloud.SDK.V2.Models.IIPListRequest -Parameter Sets: Update, UpdateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -. - -```yaml -Type: System.String -Parameter Sets: Update, UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Ips -. - -```yaml -Type: System.String[] -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IIPListRequest - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IIPList - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: IPListRequest - - `[Description ]`: - - `[Ips >]`: - - `[Name ]`: - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkLdapServer.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkLdapServer.md deleted file mode 100644 index 38ced44d6..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkLdapServer.md +++ /dev/null @@ -1,286 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkLdapServer.md -schema: 2.0.0 ---- - -# Update-JcSdkLdapServer - -## SYNOPSIS -This endpoint allows updating some attributes of an LDAP server. - -Sample Request - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"userLockoutAction\": \"remove\", - \"userPasswordExpirationAction\": \"disable\" - }' -``` - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-JcSdkLdapServer -ConsoleHost -Id [-Id1 ] [-UserLockoutAction ] - [-UserPasswordExpirationAction ] [-Confirm] [-WhatIf] [] -``` - -### Update -``` -Update-JcSdkLdapServer -ConsoleHost -Id - -Body [-Confirm] [-WhatIf] - [] -``` - -### UpdateViaIdentity -``` -Update-JcSdkLdapServer -ConsoleHost -InputObject - -Body [-Confirm] [-WhatIf] - [] -``` - -### UpdateViaIdentityExpanded -``` -Update-JcSdkLdapServer -ConsoleHost -InputObject [-Id ] - [-UserLockoutAction ] [-UserPasswordExpirationAction ] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -This endpoint allows updating some attributes of an LDAP server. - -Sample Request - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"userLockoutAction\": \"remove\", - \"userPasswordExpirationAction\": \"disable\" - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Update-JcSdkLdapServer -Id:() -Body:() -``` - ----- ---------- -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Update-JcSdkLdapServer -Id:() -Id1:() -UserLockoutAction:() -UserPasswordExpirationAction:() -``` - ----- ---------- -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - -## PARAMETERS - -### -Body -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IPaths1Ka5IlhLdapserversIdPatchRequestbodyContentApplicationJsonSchema -Parameter Sets: Update, UpdateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Unique identifier of the LDAP server. - -```yaml -Type: System.String -Parameter Sets: Update, UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id1 -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UserLockoutAction -LDAP Server Action - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserPasswordExpirationAction -LDAP Server Action - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.IPaths1Ka5IlhLdapserversIdPatchRequestbodyContentApplicationJsonSchema - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPaths1Dvt4UsLdapserversIdPatchResponses200ContentApplicationJsonSchema - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: . - - `[Id ]`: - - `[UserLockoutAction ]`: LDAP Server Action - - `[UserPasswordExpirationAction ]`: LDAP Server Action - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkOffice365.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkOffice365.md deleted file mode 100644 index f94e37859..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkOffice365.md +++ /dev/null @@ -1,379 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkOffice365.md -schema: 2.0.0 ---- - -# Update-JcSdkOffice365 - -## SYNOPSIS -This endpoint allows updating some attributes of an Office 365 instance. - -##### - -Sample Request - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"userLockoutAction\": \"maintain\", - \"userPasswordExpirationAction\": \"suspend\", - }' -``` - -Sample Request, set a default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": { - \"id\": \"{domainObjectID}\" - } - }' -``` - -Sample Request, unset the default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": {} - }' -``` - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-JcSdkOffice365 -ConsoleHost -Office365Id [-DefaultDomainId ] [-GroupsEnabled] - [-Name ] [-UserLockoutAction ] [-UserPasswordExpirationAction ] [-Confirm] [-WhatIf] - [] -``` - -### Update -``` -Update-JcSdkOffice365 -ConsoleHost -Office365Id -Body [-Confirm] [-WhatIf] - [] -``` - -### UpdateViaIdentity -``` -Update-JcSdkOffice365 -ConsoleHost -InputObject -Body [-Confirm] - [-WhatIf] [] -``` - -### UpdateViaIdentityExpanded -``` -Update-JcSdkOffice365 -ConsoleHost -InputObject [-DefaultDomainId ] - [-GroupsEnabled] [-Name ] [-UserLockoutAction ] [-UserPasswordExpirationAction ] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint allows updating some attributes of an Office 365 instance. - -##### - -Sample Request - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"userLockoutAction\": \"maintain\", - \"userPasswordExpirationAction\": \"suspend\", - }' -``` - -Sample Request, set a default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": { - \"id\": \"{domainObjectID}\" - } - }' -``` - -Sample Request, unset the default domain - -``` -curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ - -H 'Accept: application/json' \\ - -H 'Content-Type: application/json' \\ - -H 'x-api-key: {API_KEY}' \\ - -d '{ - \"defaultDomain\": {} - }' -``` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Update-JcSdkOffice365 -Office365Id:() -Body:() -``` - ----- ---------- -DefaultDomainDomain String -DefaultDomainId String -GroupsEnabled Boolean -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Update-JcSdkOffice365 -Office365Id:() -DefaultDomainId:() -GroupsEnabled:() -Name:() -UserLockoutAction:() -UserPasswordExpirationAction:() -``` - ----- ---------- -DefaultDomainDomain String -DefaultDomainId String -GroupsEnabled Boolean -Id String -Name String -UserLockoutAction String -UserPasswordExpirationAction String - -## PARAMETERS - -### -Body -Office 365 - -```yaml -Type: JumpCloud.SDK.V2.Models.IOffice365 -Parameter Sets: Update, UpdateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultDomainId -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupsEnabled -. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Office365Id -ObjectID of the Office 365 instance. - -```yaml -Type: System.String -Parameter Sets: Update, UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserLockoutAction -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserPasswordExpirationAction -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.IOffice365 - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IOffice365 - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: Office 365 - - `[DefaultDomainId ]`: - - `[GroupsEnabled ]`: - - `[Name ]`: - - `[UserLockoutAction ]`: - - `[UserPasswordExpirationAction ]`: - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkUserPushEndpoint.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkUserPushEndpoint.md deleted file mode 100644 index 59c4c397e..000000000 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkUserPushEndpoint.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -external help file: -Module Name: JumpCloud.SDK.V2 -online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkUserPushEndpoint.md -schema: 2.0.0 ---- - -# Update-JcSdkUserPushEndpoint - -## SYNOPSIS -This endpoint will update a push endpoint associated with a user. - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-JcSdkUserPushEndpoint -ConsoleHost -PushEndpointId -UserId [-Name ] - [-State ] [-Confirm] [-WhatIf] [] -``` - -### Update -``` -Update-JcSdkUserPushEndpoint -ConsoleHost -PushEndpointId -UserId - -Body - [-Confirm] [-WhatIf] [] -``` - -### UpdateViaIdentity -``` -Update-JcSdkUserPushEndpoint -ConsoleHost -InputObject - -Body - [-Confirm] [-WhatIf] [] -``` - -### UpdateViaIdentityExpanded -``` -Update-JcSdkUserPushEndpoint -ConsoleHost -InputObject [-Name ] - [-State ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -This endpoint will update a push endpoint associated with a user. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -```powershell -Update-JcSdkUserPushEndpoint -PushEndpointId:() -UserId:() -Body:() -``` - ----- ---------- -DeviceAppVersion String -DeviceMake String -DeviceModel String -DeviceOS String -DeviceOSVersion String -DeviceUvEnabled Boolean -EnrollmentDate Datetime -Id String -LastUsedDate Datetime -Name String -State String - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -Update-JcSdkUserPushEndpoint -PushEndpointId:() -UserId:() -Name:() -State:() -``` - ----- ---------- -DeviceAppVersion String -DeviceMake String -DeviceModel String -DeviceOS String -DeviceOSVersion String -DeviceUvEnabled Boolean -EnrollmentDate Datetime -Id String -LastUsedDate Datetime -Name String -State String - -## PARAMETERS - -### -Body -. - -```yaml -Type: JumpCloud.SDK.V2.Models.IPathsO4Si39UsersUserIdPushendpointsPushEndpointIdPatchRequestbodyContentApplicationJsonSchema -Parameter Sets: Update, UpdateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConsoleHost -Region for JumpCloud API host. -Use 'console' for US or 'console.eu' for EU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter - -```yaml -Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity -Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PushEndpointId -. - -```yaml -Type: System.String -Parameter Sets: Update, UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -State -. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -. - -```yaml -Type: System.String -Parameter Sets: Update, UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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 - -### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity - -### JumpCloud.SDK.V2.Models.IPathsO4Si39UsersUserIdPushendpointsPushEndpointIdPatchRequestbodyContentApplicationJsonSchema - -## OUTPUTS - -### JumpCloud.SDK.V2.Models.IPushEndpointResponse - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`BODY `: . - - `[Name ]`: - - `[State ]`: - -`INPUTOBJECT `: Identity Parameter - - `[AccountId ]`: - - `[ActivedirectoryId ]`: - - `[AdministratorId ]`: - - `[AgentId ]`: - - `[AppleMdmId ]`: - - `[ApplicationId ]`: ObjectID of the Application. - - `[ApprovalFlowId ]`: - - `[CommandId ]`: ObjectID of the Command. - - `[CustomEmailType ]`: - - `[DeviceId ]`: - - `[GroupId ]`: ObjectID of the Policy Group. - - `[GsuiteId ]`: ObjectID of the G Suite instance. - - `[Id ]`: ObjectID of this Active Directory instance. - - `[JobId ]`: - - `[LdapserverId ]`: ObjectID of the LDAP Server. - - `[Office365Id ]`: ObjectID of the Office 365 instance. - - `[PolicyId ]`: ObjectID of the Policy. - - `[ProviderId ]`: - - `[PushEndpointId ]`: - - `[RadiusserverId ]`: ObjectID of the Radius Server. - - `[SoftwareAppId ]`: ObjectID of the Software App. - - `[SystemId ]`: ObjectID of the System. - - `[UserId ]`: ObjectID of the User. - - `[WorkdayId ]`: - -## RELATED LINKS - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/test-module.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/test-module.ps1 index 0ff3e247b..297542d04 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/test-module.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/test-module.ps1 @@ -30,7 +30,7 @@ $requireResourceModule = (($baseName -ne "Resources") -and ($Record.IsPresent -o if ($requireResourceModule) { # Load the latest Az.Accounts installed - # Import-Module -Name Az.Accounts -RequiredVersion (Get-Module -Name Az.Accounts -ListAvailable | Sort-Object -Property Version -Descending)[0].Version + Import-Module -Name Az.Accounts -RequiredVersion (Get-Module -Name Az.Accounts -ListAvailable | Sort-Object -Property Version -Descending)[0].Version $resourceModulePSD = Get-Item -Path (Join-Path $HOME '.PSSharedModules\Resources\Az.Resources.TestSupport.psd1') Import-Module -Name $resourceModulePSD.FullName } @@ -68,491 +68,12 @@ try $env:AzPSAutorestTestPlaybackMode = $true } $testFolder = Join-Path $PSScriptRoot 'test' -<# -(Get-Command -Name New-JcSdkPolicy) | ForEach-Object { - $ParameterName = $_.Name - $_.ParameterSets | ForEach-Object { - $Parameters = ($_.Parameters | Sort-Object @{e = 'IsMandatory'; desc = $true }, @{e = 'Name'; desc = $false } | ForEach-Object { - if ($_.Name -notin ('Fields', 'Filter', 'Sort', 'Search', 'Paginate', 'Break', 'HttpPipelineAppend', 'HttpPipelinePrepend', 'PassThru', 'Proxy', 'ProxyCredential', 'ProxyUseDefaultCredentials', 'CommonParameters', 'WhatIf', 'Confirm', 'Verbose', 'Debug', 'ErrorAction', 'WarningAction', 'InformationAction', 'ErrorVariable', 'WarningVariable', 'InformationVariable', 'OutVariable', 'OutBuffer', 'PipelineVariable')) - { - $ParameterType = If ($_.ParameterType.Name -eq 'switchparameter') { '' }Else { " <$($_.ParameterType.Name.ToLower())>" } - If ($_.IsMandatory) - { - "-$($_.Name)$($ParameterType)" - } - else - { - "[-$($_.Name)$($ParameterType)]" - } - } - } - ) -join ' ' - Write-Host ("`n$($_.Name): $($ParameterName) $($Parameters)") - } -} -TODO: - Clear-JcSdkSystem.Tests.ps1: Setup Orgs with a device that can be cleared each time - Lock-JcSdkSystem.Tests.ps1: Setup Orgs with a device that can be locked each time - Restart-JcSdkSystem.Tests.ps1: Setup Orgs with a device that can be restarted each time - Remove-JcSdkSystem.Tests.ps1: Disabled untill we can also create systems - Reset-JcSdkUserMfa.Tests.ps1: Configure MFA for $global:PesterTestUser - New-JcSdkDuoApplication.Tests.ps1: Set up DUO in Pester Orgs -#> -$testFolder = $testFolder # .\jcapi-powershell\SDKs\PowerShell\JumpCloud.SDK.V1\test -$moduleName = $moduleName # JumpCloud.SDK.V1 - -#region Import Modules -If ($moduleName -eq 'JumpCloud.SDK.V2') -{ - Import-Module -Name $modulePath.Replace('JumpCloud.SDK.V2', 'JumpCloud.SDK.V1') -Force -} -#endregion Import Modules -#region Define Objects -If ($moduleName -eq 'JumpCloud.SDK.V1' -or $moduleName -eq 'JumpCloud.SDK.V2' -and "MTP" -notin $Env:IncludeTagList) -{ - # Get a ApplicationTemplate - $global:PesterTestApplicationTemplate = Get-JcSdkApplicationTemplate | Select-Object -First 1 - # Get a CommandResult - $global:PesterTestCommandResult = Get-JcSdkCommandResult | Select-Object -First 1 - # Get Organization - $global:PesterTestOrganization = Get-JcSdkOrganization - # Get a System - $global:PesterTestSystem = Get-JcSdkSystem | Select-Object -First 1 - # # Create a Application - $global:PesterDefApplicationConfig = [JumpCloud.SDK.V1.Models.IApplicationConfig]@{} - $randomBookmarkName = "Bookmark$(Get-Random -Maximum 999 -Minimum 100)" - $global:PesterDefApplication = @{ - Name = 'bookmark' - ssoUrl = "https://JumpCloud$(Get-Random -Maximum 999 -Minimum 100).com" - config = $global:PesterDefApplicationConfig - DisplayName = $randomBookmarkName - DisplayLabel = $randomBookmarkName - } - # Post a command file (README.md from SDK directory) - $headers = @{} - $headers.Add("x-api-key", $env:JCApiKey) - $body = @{ - content = "./README.md" - name = "README.md" - destination = "/tmp/README.md" - } - # Upload file to ORG and create reusable global object of that File - $global:PesterDefCommandFile = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/files' -Method POST -Headers $headers -Body $body - # Declare a Command definition - $global:PesterDefCommandName = "PesterTestCommand$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - $global:PesterDefCommand = @{ - Name = $global:PesterDefCommandName - Command = 'echo "Hello World"' - User = "000000000000000000000000" - launchType = "trigger" - trigger = $global:PesterDefCommandName - commandType = "linux" - files = $global:PesterDefCommandFile._id - } - # Create a command, assign it to systems, and run it - $NewCommand = New-JcSdkCommand @global:PesterDefCommand - $global:PesterTestCommand = Get-JcSdkCommand | Where-Object { $_.Name -eq $NewCommand.Name } | Select-Object -First 1 - # Using Requests, assign the command to the system / Splatting the command object with system does not work perhaps it's been deprecated in favor of associations? - # This Association is set to run one instance of the command on a system - # It is removed in order for the Set-JcSdkCommandAssociation tests to work as expected - $CommandAssociaion = Get-JcSdkSystem | Where-Object { $_.osfamily -eq 'linux' } | Select-Object -ExpandProperty Id - $headers = @{ - "x-api-key" = $env:JCApiKey - "content-type" = "application/json" - } - $body = @{ - id = $CommandAssociaion - op = "add" - type = "system" - } | ConvertTo-Json - $response = Invoke-RestMethod -Uri "https://console.jumpcloud.com/api/v2/commands/$($global:PesterTestCommand.Id)/associations" -Method POST -Headers $headers -Body $body - # Invoke SDK Command Trigger to generate Command Results - Invoke-JcSdkCommandTrigger -Triggername $global:PesterTestCommand.trigger - # Remove the Command Associations to continue tests as normal - $body = @{ - id = $CommandAssociaion - op = "remove" - type = "system" - } | ConvertTo-Json - $response = Invoke-RestMethod -Uri "https://console.jumpcloud.com/api/v2/commands/$($global:PesterTestCommand.Id)/associations" -Method POST -Headers $headers -Body $body - # Create a User - $global:PesterDefUser = @{ - Username = "pester.test.$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - FirstName = "Pester" - LastName = "Test" - Password = "Testing123!" - Email = "pester.test@example$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ })).com" - } - # Create a User SSH Key - $global:PesterDefUserSshKey = @{ - Id = $null # Defined later in New-JcSdkUserSshKey.Tests.ps1 - Name = "PesterTestUserSshKeyName" - PublicKey = "PesterTestUserSshKeyPublicKey" - } - # Create a RADIUS Server - $global:PesterDefRadiusServer = @{ - Name = "PesterTestRadiusServer-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - SharedSecret = "Testing123!" - NetworkSourceIP = [IPAddress]::Parse([String](Get-Random)).IPAddressToString - } -} -If ($moduleName -eq 'JumpCloud.SDK.V2' -and "MTP" -notin $Env:IncludeTagList) -{ - # Get the Apple MDM - $global:PesterTestAppleMDM = Get-JcSdkAppleMdm | Select-Object -First 1 - # Get LDAP Server - $global:PesterTestLdapServer = Get-JcSdkLdapServer | Select-Object -First 1 - # Get all Directories - $global:PesterTestDirectories = Get-JcSdkDirectory - $global:PesterTestGSuite = $global:PesterTestDirectories | Where-Object { $_.type -eq "g_suite" } | Select-Object -First 1 - $global:PesterTestOffice365 = $global:PesterTestDirectories | Where-Object { $_.type -eq "office_365" } | Select-Object -First 1 - $global:PesterTestLdap = $global:PesterTestDirectories | Where-Object { $_.type -eq "ldap_server" } | Select-Object -First 1 - # Get a Policy Template - $global:PesterTestPolicyTemplate = Get-JcSdkPolicyTemplate | Select-Object -First 1 - # Create an ActiveDirectory - $global:PesterDefActiveDirectory = [JumpCloud.SDK.V2.Models.ActiveDirectory]@{ - 'domain' = "DC=ADTEST{0};DC=ORG" -f [string]( -join ((65..90) + (97..122) | Get-Random -Count 6 | ForEach-Object { [char]$_ })); - } - # Create a Authentication Policy - $global:PesterDefAuthenticationPolicy = [JumpCloud.SDK.V2.Models.AuthnPolicy]@{ - Name = "AuthenticationPolicy-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - EffectAction = 'allow' - TargetResources = [JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget]@{"type" = "user_portal" } - Type = 'user_portal' - UserGroupInclusions = $null # Defined later in New-JcSdkAuthenticationPolicy.Tests.ps1 - } - - # Create a Bulk User Configuration: - $global:pesterDefBulkUsername = "PesterBulkUser-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - $global:PesterDefBulkUser = [JumpCloud.SDK.V2.Models.BulkUserCreate]@{ - Email = "$($global:pesterDefBulkUsername)@example$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ })).com"; - Firstname = $global:pesterDefBulkUsername; - Lastname = $global:pesterDefBulkUsername; - Username = $global:pesterDefBulkUsername; - AccountLocked = $false - Activated = $true - Addresses = @( - @{ - streetAddress = "8080 Testing Ave" - type = "home" - poBox = "202" - locality = "Boulder" - region = "CO" - postalCode = "80301" - country = "US" - } - ) - AllowPublicKey = $true - #AlternateEmail = 'bulkUser11234@alderaan2.org' - Company = 'someCompany' - CostCenter = 'something' - Department = 'something' - Description = 'some description' - DisableDeviceMaxLoginAttempts = $false - Displayname = 'display' - EmployeeIdentifier = (Get-Random -min 10000000 -max 99999999) - EmployeeType = 'bulk' - EnableManagedUid = $false - EnableUserPortalMultifactor = $true - ExternallyManaged = $false - JobTitle = 'bulk' - LdapBindingUser = $false - Location = 'Singapore' - ManagedAppleId = 'bulkUser11234@alderaan2.org' - Manager = $(Get-JCSdkUser | Select-Object -First 1).Id - #MfaExclusion = $true - #MfaExclusionDays = ((Get-Date).AddDays(+7)) - Password = 'T#st1234' - PasswordNeverExpires = $false - PasswordlessSudo = $false - PhoneNumbers = @( - @{ - number = "1112223333" - type = "home" - } - @{ - number = "2221113333" - type = "mobile" - } - ) - #State = "SUSPENDED" - } - $global:pesterDefBulkUpdateUsername = "PesterBulkUser-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - $BulkUserUpdateUser = New-JCSdkUser -Email "$($global:pesterDefBulkUpdateUsername)@example$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ })).com" -Username $global:pesterDefBulkUpdateUsername -Firstname "BulkUserUpdate" -LastName "BulkUserUpdate" - $global:PesterDefUpdateBulkUser = [JumpCloud.SDK.V2.Models.BulkUserUpdate]@{ - Id = $BulkUserUpdateUser.Id - Email = "$($global:pesterDefBulkUpdateUsername)@example$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ })).com"; - Firstname = $global:pesterDefBulkUpdateUsername; ; - Lastname = $global:pesterDefBulkUpdateUsername; ; - Username = $global:pesterDefBulkUpdateUsername; ; - AccountLocked = $false - Addresses = @( - @{ - streetAddress = "8080 Testing Ave" - type = "home" - poBox = "202" - locality = "Boulder" - region = "CO" - postalCode = "80301" - country = "US" - } - ) - AllowPublicKey = $true - #AlternateEmail = 'bulkUser11234@alderaan2.org' - Company = 'someCompany' - CostCenter = 'something' - Department = 'something' - Description = 'some description' - DisableDeviceMaxLoginAttempts = $false - Displayname = 'display' - EmployeeIdentifier = (Get-Random -min 10000000 -max 99999999) - EmployeeType = 'bulk' - EnableManagedUid = $false - EnableUserPortalMultifactor = $true - ExternallyManaged = $false - JobTitle = 'bulk' - LdapBindingUser = $false - Location = 'Singapore' - ManagedAppleId = 'bulkUser11234@alderaan2.org' - Manager = $(Get-JCSdkUser | Select-Object -First 1).Id - #MfaExclusion = $true - #MfaExclusionUntil = ((Get-Date).AddDays(+7)) - Password = 'T#st1234' - PasswordNeverExpires = $false - PasswordlessSudo = $false - PhoneNumbers = @( - @{ - number = "1112223333" - type = "home" - } - @{ - number = "2221113333" - type = "mobile" - } - ) - #State = "SUSPENDED" - } - # Create a Custom Email Configuration - $global:PesterDefCustomEmailConfiguration = [JumpCloud.SDK.V2.Models.CustomEmail]@{ - Type = 'password_reset_confirmation' - # Having multiple breaks remove tests - # Type = Get-Random @('password_reset_confirmation', 'password_expiration_warning', 'lockout_notice_user', 'password_expiration', 'user_change_password') - Subject = "CUSTOM" - } - # Create a GSuite Translation Rule - $global:PesterDefGSuiteTranslationRule = [JumpCloud.SDK.V2.Models.GSuiteTranslationRule]@{ - GsuiteId = $global:PesterTestGSuite.Id - BuiltIn = 'user_work_addresses' - Direction = 'export' - } - # Create a IP List - $global:PesterDefIPList = [JumpCloud.SDK.V2.Models.IPList]@{ - Description = 'PesterIpList' - Ips = [IPAddress]::Parse([String](Get-Random)).IPAddressToString - Name = "Pester IP Test List $(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - } - # Create a LdapServer - $global:PesterDefLdapServer = @{ - Id = $PesterTestLdapServer.Id - Name = "jumpcloud" - UserLockoutAction = "remove" - UserPasswordExpirationAction = "remove" - } - # Create a Office365 Translation Rule - $global:PesterDefOffice365TranslationRule = [JumpCloud.SDK.V2.Models.Office365TranslationRule]@{ - Office365Id = $global:PesterTestOffice365.Id - BuiltIn = 'user_street_address' - } - # Create a Policy - $global:PesterDefPolicy = Get-Random @( - [JumpCloud.SDK.V2.Models.Policy]@{ - Name = "Pester_Windows - $(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - TemplateId = (Get-JcSdkPolicyTemplate | Where-Object { $_.OSMetaFamily -eq 'windows' } | Select-Object -First 1).Id - }, - [JumpCloud.SDK.V2.Models.Policy]@{ - Name = "Pester_Linux - $(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - TemplateId = (Get-JcSdkPolicyTemplate | Where-Object { $_.OSMetaFamily -eq 'linux' } | Select-Object -First 1).Id - }, - [JumpCloud.SDK.V2.Models.Policy]@{ - Name = "Pester_Darwin - $(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - TemplateId = (Get-JcSdkPolicyTemplate | Where-Object { $_.OSMetaFamily -eq 'darwin' } | Select-Object -First 1).Id - } - ) - # Create a Software App - $global:PesterDefSoftwareApp = [JumpCloud.SDK.V2.Models.SoftwareApp]@{ - DisplayName = "Adobe Reader" - Settings = [JumpCloud.SDK.V2.Models.SoftwareAppSettings]@{ - PackageId = 'adobereader' - packageManager = 'CHOCOLATEY' - Scope = 'system' - } - } - # Create a static User Group - $global:PesterDefUserGroupStatic = [JumpCloud.SDK.V2.Models.UserGroupPost]::new() - $global:PesterDefUserGroupStatic.Name = "PesterTestUserGroup-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - - # Create a User Group with Filter type membership - $UserFilter = [JumpCloud.SDK.V2.Models.MemberQuery]::new() - $UserFilter.Filters = @('description:$eq:test') - $UserFilter.QueryType = "Filter" - $global:PesterDefUserGroupFilter = [JumpCloud.SDK.V2.Models.UserGroupPost]::new() - $global:PesterDefUserGroupFilter.Name = "PesterTestUserGroupFilter-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - $global:PesterDefUserGroupFilter.MemberQueryFilters = $UserFilter.Filters - $global:PesterDefUserGroupFilter.MemberQueryType = $UserFilter.QueryType - # Create a User Group with Search type membership - $UserFilter = [JumpCloud.SDK.V2.Models.MemberQuery]::new() - $UserFilter.Filters = '{"filter":{"and":["department:$eq:Sales","company:$co:Toast"]}}' - $UserFilter.QueryType = "Search" - $global:PesterDefUserGroupSearch = [JumpCloud.SDK.V2.Models.UserGroupPost]::new() - $global:PesterDefUserGroupSearch.Name = "PesterTestUserGroupSearch-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - $global:PesterDefUserGroupSearch.MemberQuerySearchFilters = $UserFilter.Filters - $global:PesterDefUserGroupSearch.MemberQueryType = $UserFilter.QueryType - - # Create a System Group - $global:PesterDefSystemGroupStatic = [JumpCloud.SDK.V2.Models.SystemGroupPost]::new() - $global:PesterDefSystemGroupStatic.Name = "PesterTestSystemGroup-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - # Create a System Group with Filter type membership - $SystemFilter = [JumpCloud.SDK.V2.Models.MemberQuery]::new() - $SystemFilter.Filters = @('osFamily:$eq:linux', 'osFamily:$eq:windows') - $SystemFilter.QueryType = "Filter" - $global:PesterDefSystemGroupFilter = [JumpCloud.SDK.V2.Models.SystemGroupPost]::new() - $global:PesterDefSystemGroupFilter.Name = "PesterTestSystemGroupFilter-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - $global:PesterDefSystemGroupFilter.MemberQueryFilters = $systemFilter.Filters - $global:PesterDefSystemGroupFilter.MemberQueryType = $SystemFilter.QueryType - - # Create a System Group with Search type membership - $SystemFilter = [JumpCloud.SDK.V2.Models.MemberQuery]::new() - $SystemFilter.Filters = '{"filter":{"and":["osFamily:$eq:windows","hostname:$co:ISB"]}}' - $SystemFilter.QueryType = "Search" - $global:PesterDefSystemGroupSearch = [JumpCloud.SDK.V2.Models.SystemGroupPost]::new() - $global:PesterDefSystemGroupSearch.Name = "PesterTestSystemGroupSearch-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - $global:PesterDefSystemGroupSearch.MemberQuerySearchFilters = $SystemFilter.Filters - $global:PesterDefSystemGroupSearch.MemberQueryType = $SystemFilter.QueryType - - # Create a Policy Group - $global:PesterDefPolicyGroup = [JumpCloud.SDK.V2.Models.PolicyGroup]@{ - Name = "PesterTestPolicyGroup-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - } -} -If ($moduleName -eq 'JumpCloud.SDK.V1' -or $moduleName -eq 'JumpCloud.SDK.V2' -and "MTP" -in $Env:IncludeTagList) -{ - # Set MTP Keys & Continue to test - $env:JCApiKey = $env:JCApiKeyMTP - $env:JCOrgId = (Get-JcSdkOrganization | Select-Object -First 1).Id - - $global:PesterDefProviderAdminName = "ProviderAdmin-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" - - $global:PesterDefProviderAdmin = @{ - Email = "$($global:PesterDefProviderAdminName)@example$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ })).com"; - Firstname = 'AdminFirst' - Lastname = 'AdminLast' - RoleName = 'Help Desk' - } - # Get admins on an org (Required to test V1 MTP methods) - $headers = @{ - "x-api-key" = $env:JCApiKey - "x-org-id" = $env:JCOrgId - } - $global:PesterTestAdministratorUsers = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/users?skip=0&limit=20' -Method GET -Headers $headers -} -#endregion Define Objects - -#region Run Pester Tests -# If V2 is being run then run the V1 tests also because of dependencies -$moduleTestFolder = If ($moduleName -eq 'JumpCloud.SDK.V2') -{ - @($testFolder.Replace('V2', 'V1'), $testFolder) -} -else -{ - $testFolder -} -# Validate script syntax -$LintFilePath = "$PSScriptRoot/custom/generated/*.ps1" -# Import Settings: - -$ScriptAnalyzerResult = Invoke-ScriptAnalyzer -Path:("$LintFilePath") -recurse -Settings:("$PSScriptRoot/../../../Tools/PSScriptAnalyzerSettings.psd1") -If ($ScriptAnalyzerResult) -{ - $ScriptAnalyzerResult -} - -$Filter = "*" -$PesterTestFiles = @() -# Populate with test file basenames that need to be run in a specific order -$OrderedTestsSetup = @('New-JcSdkUserGroup.Tests', 'New-JcSdkAuthenticationPolicy.Tests', 'New-JcSdkCommand.Tests', 'Invoke-JcSdkCommandTrigger.Tests') -$OrderedTestsUpdate = @() -$OrderedTestsMain = @('Lock-JcSdkUser.Tests', 'Unlock-JcSdkUser.Tests') -$OrderedTestsTakeDown = @('Remove-JcSdkUserSshKey.Tests', 'Remove-JcSdkUser.Tests') -$TestFiles = Get-ChildItem -Path:($moduleTestFolder) -Recurse | Where-Object { $_.BaseName -like "*$($Filter).Tests*" } -# Add "New" tests (Setup Org) -$OrderedTestsSetup | ForEach-Object { $FileBaseName = $_; $PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -eq $FileBaseName }; } -$PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -like "New-*" -and $_.BaseName -notin $PesterTestFiles.BaseName } -# Add "Set" tests (Setup Org) -$OrderedTestsUpdate | ForEach-Object { $FileBaseName = $_; $PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -eq $FileBaseName }; } -$PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -like "Set-*" -and $_.BaseName -notin $PesterTestFiles.BaseName } -# Add tests that are not "Get" or "Remove" (Setup Org) -$OrderedTestsUpdate | ForEach-Object { $FileBaseName = $_; $PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -eq $FileBaseName }; } -$PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -notlike "Get-*" -and $_.BaseName -notlike "Remove-*" -and $_.BaseName -notin $PesterTestFiles.BaseName } -# # Add "Get" tests (Setup Org) -$OrderedTestsMain | ForEach-Object { $FileBaseName = $_; $PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -eq $FileBaseName }; } -$PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -like "Get-*" -and $_.BaseName -notin $PesterTestFiles.BaseName } -# Add "Remove" tests (Cleanup Org) -$OrderedTestsTakeDown | ForEach-Object { $FileBaseName = $_; $PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -eq $FileBaseName }; } -$PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -like "Remove-*" -and $_.BaseName -notin $PesterTestFiles.BaseName } -# Run tests -$PesterTestResultFolder = (Join-Path $testFolder "results") -If (!(Test-Path -Path:($PesterTestResultFolder))) { New-Item -Path:($PesterTestResultFolder) -ItemType:('Directory') | Out-Null } -$PesterTestResultPath = Join-Path $PesterTestResultFolder "$moduleName-TestResults.xml" -$PesterTestCoveragePath = Join-Path $PesterTestResultFolder "$moduleName-TestCoverage.xml" -# Print Test Coverage & Pester 5 Compatibility: -. "$PSScriptRoot/../../../Tools/ValidateTests.ps1" -SDKName $moduleName -# Write-Host "$($PesterTestFiles.FullName)" -$configuration = New-PesterConfiguration -$configuration.Run.Path = $($PesterTestFiles.FullName) -$configuration.Should.ErrorAction = 'Continue' -$configuration.CodeCoverage.Enabled = $false -$configuration.testresult.Enabled = $true -$configuration.testresult.OutputFormat = 'JUnitXml' -$configuration.Filter.Tag = $Env:IncludeTagList -$configuration.Filter.ExcludeTag = $Env:ExcludeTagList -$configuration.CodeCoverage.OutputPath = ($PesterTestCoveragePath) -$configuration.testresult.OutputPath = ($PesterTestResultPath) -# Invoke pester -Invoke-Pester -configuration $configuration -#endregion Run Pester Tests - -#region Clean Up (This section should ideally be taken care of by the "Remove-" tests) -If ($moduleName -eq 'JumpCloud.SDK.V1') -{ - # # Remove Commands - # $null = Get-JcSdkCommand | ForEach-Object { Remove-JcSdkCommand -Id:($_.Id) } - # # Remove Users and SSH Keys - # $null = Get-JcSdkUser | ForEach-Object { - # $UserId = $_.Id - # If ( $_.ExternallyManaged ) - # { - # Set-JcSdkUser -Id:($UserId) -ExternallyManaged:($false) - # } - # If ($_.SshKeys) - # { - # $_.SshKeys | ForEach-Object { - # Remove-JcSdkUserSshKey -Id:($_.Id) -SystemuserId:($UserId) - # } - # } - # Remove-JcSdkUser -Id:($UserId) - # } - # # Remove RADIUS Servers - # $null = Get-JcSdkRadiusServer | ForEach-Object { Remove-JcSdkRadiusServer -Id:($_.Id) } -} -If ($moduleName -eq 'JumpCloud.SDK.V2') -{ - # Remove-JcSdkCustomEmailConfiguration -CustomEmailType:('password_reset_confirmation') - # Remove-JcSdkGSuiteTranslationRule -GsuiteId:((Get-JcSdkDirectory | Where-Object { $_.type -eq "g_suite" } | Select-Object -First 1).id) -Id:((Get-JcSdkGSuiteTranslationRule -GsuiteId:((Get-JcSdkDirectory | Where-Object { $_.type -eq "g_suite" } | Select-Object -First 1).id)).id) - # Remove-JcSdkOffice365TranslationRule -Office365Id:((Get-JcSdkDirectory | Where-Object { $_.type -eq "office_365" } | Select-Object -First 1).id) -Id:((Get-JcSdkOffice365TranslationRule -Office365Id:((Get-JcSdkDirectory | Where-Object { $_.type -eq "office_365" } | Select-Object -First 1).id)).id) -} -#endregion Clean Up - + if ($null -ne $TestName) + { + Invoke-Pester -Script @{ Path = $testFolder } -TestName $TestName -ExcludeTag $ExcludeTag -EnableExit -OutputFile (Join-Path $testFolder "$moduleName-TestResults.xml") + } else { + Invoke-Pester -Script @{ Path = $testFolder } -ExcludeTag $ExcludeTag -EnableExit -OutputFile (Join-Path $testFolder "$moduleName-TestResults.xml") + } } Finally { if ($TestMode -ne 'playback') @@ -565,4 +86,3 @@ If ($moduleName -eq 'JumpCloud.SDK.V2') } Write-Host -ForegroundColor Green '-------------Done-------------' - diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/test/loadEnv.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/test/loadEnv.ps1 index d85c34bd4..9fa946467 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/test/loadEnv.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/test/loadEnv.ps1 @@ -16,17 +16,4 @@ $env = @{} if (Test-Path -Path $envFilePath) { $env = Get-Content (Join-Path $PSScriptRoot $envFile) | ConvertFrom-Json $PSDefaultParameterValues=@{"*:Tenant"=$env.Tenant} -} -# Determine default host values based on environment -$apiHost = 'api' -$consoleHost = 'console' - -if ($env:JCEnvironment -eq 'EU') { - $apiHost = 'api.eu' - $consoleHost = 'console.eu' -} - -# Set both parameter defaults so all SDKs work correctly -$PSDefaultParameterValues['*-JcSdk*:ApiHost'] = $apiHost -$PSDefaultParameterValues['*-JcSdk*:ConsoleHost'] = $consoleHost -# Write-Host "Test environment loaded. ApiHost set to: $apiHost, ConsoleHost set to: $consoleHost" +} \ No newline at end of file From 169fd3941fa3936d813d039211d0c111b5b5ac2b Mon Sep 17 00:00:00 2001 From: Joe Workman Date: Mon, 11 May 2026 09:02:53 -0600 Subject: [PATCH 05/11] DI generate --- SDKs/PowerShell/JumpCloud.SDK.V2/.gitignore | 4 +- .../JumpCloud.SDK.V2/JumpCloud.SDK.V2.nuspec | 6 +- .../JumpCloud.SDK.V2/JumpCloud.SDK.V2.psd1 | 323 +- .../JumpCloud.SDK.V2/check-dependencies.ps1 | 3 +- .../docs/exports/Clear-JcSdkAppleMdmDevice.md | 267 ++ ...Clear-JcSdkAppleMdmDeviceActivationLock.md | 218 ++ .../docs/exports/Get-JcSdkAccessRequest.md | 207 + .../exports/Get-JcSdkAccessRequestProgress.md | 147 + .../docs/exports/Get-JcSdkActiveDirectory.md | 229 ++ .../exports/Get-JcSdkActiveDirectoryAgent.md | 203 + .../Get-JcSdkActiveDirectoryAssociation.md | 183 + .../Get-JcSdkActiveDirectoryTraverseUser.md | 203 + ...t-JcSdkActiveDirectoryTraverseUserGroup.md | 203 + .../Get-JcSdkAdministratorOrganization.md | 85 + .../Get-JcSdkAdministratorOrganizationLink.md | 85 + .../docs/exports/Get-JcSdkAppleMdm.md | 111 + .../docs/exports/Get-JcSdkAppleMdmDevice.md | 283 ++ .../Get-JcSdkAppleMdmEnrollmentProfile.md | 103 + .../Get-JcSdkApplicationAssociation.md | 181 + .../Get-JcSdkApplicationTraverseUser.md | 203 + .../Get-JcSdkApplicationTraverseUserGroup.md | 203 + .../docs/exports/Get-JcSdkApprovalFlow.md | 207 + .../exports/Get-JcSdkApprovalFlowSetting.md | 76 + .../exports/Get-JcSdkAuthenticationPolicy.md | 248 ++ .../docs/exports/Get-JcSdkBulkUserState.md | 129 + .../docs/exports/Get-JcSdkBulkUsersResult.md | 162 + .../exports/Get-JcSdkCommandAssociation.md | 182 + .../exports/Get-JcSdkCommandTraverseSystem.md | 203 + .../Get-JcSdkCommandTraverseSystemGroup.md | 203 + .../Get-JcSdkCustomEmailConfiguration.md | 146 + .../exports/Get-JcSdkCustomEmailTemplate.md | 72 + .../docs/exports/Get-JcSdkDirectory.md | 122 + .../docs/exports/Get-JcSdkDuoAccount.md | 162 + .../docs/exports/Get-JcSdkDuoApplication.md | 181 + .../docs/exports/Get-JcSdkGSuite.md | 162 + .../exports/Get-JcSdkGSuiteAssociation.md | 182 + .../exports/Get-JcSdkGSuiteTranslationRule.md | 244 ++ .../exports/Get-JcSdkGSuiteTraverseUser.md | 203 + .../Get-JcSdkGSuiteTraverseUserGroup.md | 203 + .../exports/Get-JcSdkGSuiteUsersToImport.md | 134 + .../docs/exports/Get-JcSdkGroup.md | 182 + .../Get-JcSdkGsuiteUsersToImportFormatted.md | 149 + .../docs/exports/Get-JcSdkIPList.md | 226 ++ .../docs/exports/Get-JcSdkLdapServer.md | 229 ++ .../exports/Get-JcSdkLdapServerAssociation.md | 183 + .../exports/Get-JcSdkLdapServerSambaDomain.md | 242 ++ .../Get-JcSdkLdapServerTraverseUser.md | 203 + .../Get-JcSdkLdapServerTraverseUserGroup.md | 203 + .../Get-JcSdkNextScheduledBulkUserState.md | 105 + .../docs/exports/Get-JcSdkOffice365.md | 168 + .../exports/Get-JcSdkOffice365Association.md | 185 + .../Get-JcSdkOffice365TranslationRule.md | 246 ++ .../exports/Get-JcSdkOffice365TraverseUser.md | 218 ++ .../Get-JcSdkOffice365TraverseUserGroup.md | 203 + .../Get-JcSdkOffice365UsersToImport.md | 167 + .../Get-JcSdkOrganizationPolicyResult.md | 158 + .../docs/exports/Get-JcSdkPolicy.md | 251 ++ .../exports/Get-JcSdkPolicyAssociation.md | 180 + .../docs/exports/Get-JcSdkPolicyGroup.md | 231 ++ .../Get-JcSdkPolicyGroupAssociation.md | 127 + .../exports/Get-JcSdkPolicyGroupMember.md | 267 ++ .../exports/Get-JcSdkPolicyGroupMembership.md | 203 + .../Get-JcSdkPolicyGroupTraverseSystem.md | 203 + ...Get-JcSdkPolicyGroupTraverseSystemGroup.md | 203 + .../docs/exports/Get-JcSdkPolicyResult.md | 256 ++ .../docs/exports/Get-JcSdkPolicyStatus.md | 173 + .../docs/exports/Get-JcSdkPolicyTemplate.md | 245 ++ .../exports/Get-JcSdkPolicyTraverseSystem.md | 203 + .../Get-JcSdkPolicyTraverseSystemGroup.md | 203 + .../exports/Get-JcSdkProviderAdministrator.md | 164 + .../exports/Get-JcSdkProviderOrganization.md | 164 + .../docs/exports/Get-JcSdkProvidersInvoice.md | 187 + .../Get-JcSdkRadiusServerAssociation.md | 181 + .../Get-JcSdkRadiusServerTraverseUser.md | 205 + .../Get-JcSdkRadiusServerTraverseUserGroup.md | 203 + .../docs/exports/Get-JcSdkSoftwareApp.md | 211 ++ .../Get-JcSdkSoftwareAppAssociation.md | 181 + .../exports/Get-JcSdkSoftwareAppStatus.md | 207 + .../Get-JcSdkSoftwareAppTraverseSystem.md | 203 + ...Get-JcSdkSoftwareAppTraverseSystemGroup.md | 203 + .../docs/exports/Get-JcSdkSubscription.md | 92 + .../exports/Get-JcSdkSystemAssociation.md | 215 ++ .../docs/exports/Get-JcSdkSystemFdeKey.md | 137 + .../docs/exports/Get-JcSdkSystemGroup.md | 241 ++ .../Get-JcSdkSystemGroupAssociation.md | 182 + .../exports/Get-JcSdkSystemGroupMember.md | 162 + .../exports/Get-JcSdkSystemGroupMembership.md | 205 + .../Get-JcSdkSystemGroupTraverseCommand.md | 227 ++ .../Get-JcSdkSystemGroupTraversePolicy.md | 207 + ...Get-JcSdkSystemGroupTraversePolicyGroup.md | 205 + .../Get-JcSdkSystemGroupTraverseUser.md | 203 + .../Get-JcSdkSystemGroupTraverseUserGroup.md | 205 + .../docs/exports/Get-JcSdkSystemInsightAlf.md | 122 + .../Get-JcSdkSystemInsightAlfException.md | 117 + .../Get-JcSdkSystemInsightAlfExplicitAuth.md | 116 + .../docs/exports/Get-JcSdkSystemInsightApp.md | 140 + .../Get-JcSdkSystemInsightAppCompatShim.md | 121 + .../Get-JcSdkSystemInsightAuthorizedKey.md | 119 + ...JcSdkSystemInsightAzureInstanceMetadata.md | 131 + .../Get-JcSdkSystemInsightAzureInstanceTag.md | 118 + .../exports/Get-JcSdkSystemInsightBattery.md | 133 + .../Get-JcSdkSystemInsightBitlockerInfo.md | 121 + .../Get-JcSdkSystemInsightBrowserPlugin.md | 125 + .../Get-JcSdkSystemInsightCertificate.md | 135 + .../Get-JcSdkSystemInsightChassisInfo.md | 128 + .../Get-JcSdkSystemInsightChromeExtension.md | 126 + .../Get-JcSdkSystemInsightConnectivity.md | 124 + .../exports/Get-JcSdkSystemInsightCrash.md | 131 + .../Get-JcSdkSystemInsightCupDestination.md | 117 + .../Get-JcSdkSystemInsightDiskEncryption.md | 122 + .../exports/Get-JcSdkSystemInsightDiskInfo.md | 126 + .../Get-JcSdkSystemInsightDnsResolver.md | 120 + .../exports/Get-JcSdkSystemInsightEtcHost.md | 117 + .../Get-JcSdkSystemInsightFirefoxAddon.md | 129 + .../exports/Get-JcSdkSystemInsightGroup.md | 120 + .../Get-JcSdkSystemInsightIeExtension.md | 119 + .../Get-JcSdkSystemInsightInterfaceAddress.md | 122 + .../Get-JcSdkSystemInsightInterfaceDetail.md | 149 + .../Get-JcSdkSystemInsightKernelInfo.md | 119 + .../exports/Get-JcSdkSystemInsightLaunchd.md | 136 + .../Get-JcSdkSystemInsightLinuxPackage.md | 133 + .../Get-JcSdkSystemInsightLoggedinUser.md | 121 + .../Get-JcSdkSystemInsightLogicalDrive.md | 121 + .../Get-JcSdkSystemInsightManagedPolicy.md | 121 + .../exports/Get-JcSdkSystemInsightMount.md | 126 + .../Get-JcSdkSystemInsightOSVersion.md | 125 + .../exports/Get-JcSdkSystemInsightPatch.md | 123 + .../exports/Get-JcSdkSystemInsightProgram.md | 130 + .../Get-JcSdkSystemInsightPythonPackage.md | 121 + .../Get-JcSdkSystemInsightSafariExtension.md | 125 + .../Get-JcSdkSystemInsightScheduledTask.md | 124 + .../Get-JcSdkSystemInsightSecureboot.md | 117 + .../exports/Get-JcSdkSystemInsightService.md | 126 + .../exports/Get-JcSdkSystemInsightShadow.md | 125 + .../Get-JcSdkSystemInsightSharedFolder.md | 117 + .../Get-JcSdkSystemInsightSharedResource.md | 123 + ...Get-JcSdkSystemInsightSharingPreference.md | 125 + .../Get-JcSdkSystemInsightSipConfig.md | 118 + .../Get-JcSdkSystemInsightStartupItem.md | 121 + .../Get-JcSdkSystemInsightSystemControl.md | 122 + .../Get-JcSdkSystemInsightSystemInfo.md | 130 + .../exports/Get-JcSdkSystemInsightTpmInfo.md | 124 + .../exports/Get-JcSdkSystemInsightUptime.md | 120 + .../Get-JcSdkSystemInsightUsbDevice.md | 127 + .../exports/Get-JcSdkSystemInsightUser.md | 131 + .../Get-JcSdkSystemInsightUserAssist.md | 119 + .../Get-JcSdkSystemInsightUserGroup.md | 117 + .../Get-JcSdkSystemInsightUserSshKey.md | 118 + .../Get-JcSdkSystemInsightWifiNetwork.md | 127 + .../Get-JcSdkSystemInsightWifiStatus.md | 128 + ...JcSdkSystemInsightWindowsSecurityCenter.md | 122 + ...cSdkSystemInsightWindowsSecurityProduct.md | 121 + .../docs/exports/Get-JcSdkSystemMember.md | 235 ++ .../exports/Get-JcSdkSystemPolicyStatus.md | 175 + .../exports/Get-JcSdkSystemTraverseCommand.md | 229 ++ .../exports/Get-JcSdkSystemTraversePolicy.md | 211 ++ .../Get-JcSdkSystemTraversePolicyGroup.md | 235 ++ .../exports/Get-JcSdkSystemTraverseUser.md | 235 ++ .../Get-JcSdkSystemTraverseUserGroup.md | 235 ++ .../docs/exports/Get-JcSdkUserAssociation.md | 184 + .../docs/exports/Get-JcSdkUserGroup.md | 247 ++ .../exports/Get-JcSdkUserGroupAssociation.md | 182 + .../docs/exports/Get-JcSdkUserGroupMember.md | 160 + .../exports/Get-JcSdkUserGroupMembership.md | 203 + ...t-JcSdkUserGroupTraverseActiveDirectory.md | 199 + .../Get-JcSdkUserGroupTraverseApplication.md | 203 + .../Get-JcSdkUserGroupTraverseDirectory.md | 205 + .../Get-JcSdkUserGroupTraverseGSuite.md | 205 + .../Get-JcSdkUserGroupTraverseLdapServer.md | 203 + .../Get-JcSdkUserGroupTraverseOffice365.md | 203 + .../Get-JcSdkUserGroupTraverseRadiusServer.md | 205 + .../Get-JcSdkUserGroupTraverseSystem.md | 203 + .../Get-JcSdkUserGroupTraverseSystemGroup.md | 203 + .../docs/exports/Get-JcSdkUserMember.md | 203 + .../docs/exports/Get-JcSdkUserPushEndpoint.md | 179 + .../Get-JcSdkUserTraverseActiveDirectory.md | 203 + .../Get-JcSdkUserTraverseApplication.md | 203 + .../exports/Get-JcSdkUserTraverseDirectory.md | 203 + .../exports/Get-JcSdkUserTraverseGSuite.md | 203 + .../Get-JcSdkUserTraverseLdapServer.md | 203 + .../exports/Get-JcSdkUserTraverseOffice365.md | 203 + .../Get-JcSdkUserTraverseRadiusServer.md | 203 + .../exports/Get-JcSdkUserTraverseSystem.md | 203 + .../Get-JcSdkUserTraverseSystemGroup.md | 203 + .../docs/exports/Get-JcSdkWorkday.md | 241 ++ .../docs/exports/Get-JcSdkWorkdayWorker.md | 181 + .../docs/exports/Grant-JcSdkWorkday.md | 312 ++ .../docs/exports/Import-JcSdkScim.md | 263 ++ .../docs/exports/Import-JcSdkWorkday.md | 297 ++ .../docs/exports/Import-JcSdkWorkdayResult.md | 175 + .../Invoke-JcSdkReclaimSoftwareAppLicense.md | 190 + .../docs/exports/JumpCloud.SDK.V2.md | 3316 +++++++++++++++++ .../docs/exports/Lock-JcSdkAppleMdmDevice.md | 267 ++ .../docs/exports/New-JcSdkActiveDirectory.md | 243 ++ .../exports/New-JcSdkActiveDirectoryAgent.md | 251 ++ .../New-JcSdkAdministratorOrganization.md | 221 ++ .../docs/exports/New-JcSdkApprovalFlow.md | 464 +++ .../exports/New-JcSdkAuthenticationPolicy.md | 583 +++ .../docs/exports/New-JcSdkBulkUser.md | 321 ++ .../docs/exports/New-JcSdkBulkUserState.md | 247 ++ .../New-JcSdkCustomEmailConfiguration.md | 264 ++ .../docs/exports/New-JcSdkDuoAccount.md | 123 + .../docs/exports/New-JcSdkDuoApplication.md | 301 ++ .../exports/New-JcSdkGSuiteTranslationRule.md | 263 ++ .../docs/exports/New-JcSdkIPList.md | 218 ++ .../exports/New-JcSdkLdapServerSambaDomain.md | 263 ++ .../New-JcSdkOffice365TranslationRule.md | 263 ++ .../docs/exports/New-JcSdkPolicy.md | 260 ++ .../docs/exports/New-JcSdkPolicyGroup.md | 179 + .../exports/New-JcSdkProviderAdministrator.md | 409 ++ .../docs/exports/New-JcSdkSoftwareApp.md | 402 ++ .../docs/exports/New-JcSdkSystemGroup.md | 353 ++ .../docs/exports/New-JcSdkUserGroup.md | 369 ++ .../docs/exports/New-JcSdkWorkday.md | 280 ++ .../exports/Remove-JcSdkActiveDirectory.md | 189 + .../Remove-JcSdkActiveDirectoryAgent.md | 216 ++ .../Remove-JcSdkAdministratorOrganization.md | 200 + .../docs/exports/Remove-JcSdkAppleMdm.md | 222 ++ .../exports/Remove-JcSdkAppleMdmDevice.md | 225 ++ .../exports/Remove-JcSdkApplicationLogo.md | 185 + .../docs/exports/Remove-JcSdkApprovalFlow.md | 185 + .../Remove-JcSdkAuthenticationPolicy.md | 200 + .../docs/exports/Remove-JcSdkBulkUserState.md | 199 + .../Remove-JcSdkCustomEmailConfiguration.md | 185 + .../docs/exports/Remove-JcSdkDuoAccount.md | 187 + .../exports/Remove-JcSdkDuoApplication.md | 205 + .../Remove-JcSdkGSuiteTranslationRule.md | 220 ++ .../docs/exports/Remove-JcSdkIPList.md | 189 + .../Remove-JcSdkLdapServerSambaDomain.md | 216 ++ .../Remove-JcSdkOffice365TranslationRule.md | 220 ++ .../docs/exports/Remove-JcSdkPolicy.md | 202 + .../docs/exports/Remove-JcSdkPolicyGroup.md | 209 ++ .../Remove-JcSdkProviderAdministrator.md | 202 + .../docs/exports/Remove-JcSdkSoftwareApp.md | 205 + .../docs/exports/Remove-JcSdkSystemGroup.md | 214 ++ .../docs/exports/Remove-JcSdkUserGroup.md | 216 ++ .../exports/Remove-JcSdkUserPushEndpoint.md | 196 + .../Remove-JcSdkWorkdayAuthorization.md | 201 + .../exports/Restart-JcSdkAppleMdmDevice.md | 267 ++ .../docs/exports/Set-JcSdkAccessRequest.md | 301 ++ .../exports/Set-JcSdkAccessRequestApproval.md | 212 ++ .../Set-JcSdkActiveDirectoryAssociation.md | 313 ++ .../docs/exports/Set-JcSdkAppleMdm.md | 755 ++++ .../Set-JcSdkApplicationAssociation.md | 310 ++ .../docs/exports/Set-JcSdkApprovalFlow.md | 517 +++ .../exports/Set-JcSdkApprovalFlowSetting.md | 251 ++ .../exports/Set-JcSdkCommandAssociation.md | 314 ++ .../Set-JcSdkCustomEmailConfiguration.md | 335 ++ .../docs/exports/Set-JcSdkDuoApplication.md | 316 ++ .../exports/Set-JcSdkGSuiteAssociation.md | 314 ++ .../docs/exports/Set-JcSdkIPList.md | 285 ++ .../exports/Set-JcSdkLdapServerAssociation.md | 312 ++ .../exports/Set-JcSdkLdapServerSambaDomain.md | 278 ++ .../exports/Set-JcSdkOffice365Association.md | 312 ++ .../docs/exports/Set-JcSdkPolicy.md | 311 ++ .../exports/Set-JcSdkPolicyAssociation.md | 312 ++ .../docs/exports/Set-JcSdkPolicyGroup.md | 251 ++ .../Set-JcSdkPolicyGroupAssociation.md | 314 ++ .../exports/Set-JcSdkPolicyGroupMember.md | 291 ++ .../Set-JcSdkRadiusServerAssociation.md | 316 ++ .../docs/exports/Set-JcSdkSoftwareApp.md | 561 +++ .../Set-JcSdkSoftwareAppAssociation.md | 308 ++ .../exports/Set-JcSdkSystemAssociation.md | 360 ++ .../docs/exports/Set-JcSdkSystemGroup.md | 425 +++ .../Set-JcSdkSystemGroupAssociation.md | 314 ++ .../exports/Set-JcSdkSystemGroupMember.md | 323 ++ .../docs/exports/Set-JcSdkUserAssociation.md | 327 ++ .../docs/exports/Set-JcSdkUserGroup.md | 443 +++ .../exports/Set-JcSdkUserGroupAssociation.md | 314 ++ .../docs/exports/Set-JcSdkUserGroupMember.md | 291 ++ .../docs/exports/Set-JcSdkWorkday.md | 281 ++ .../docs/exports/Stop-JcSdkAppleMdmDevice.md | 218 ++ .../docs/exports/Sync-JcSdkAppleMdmDevice.md | 203 + ...date-JcSdkAppleMdmDeviceLockInformation.md | 220 ++ .../Update-JcSdkAuthenticationPolicy.md | 626 ++++ .../docs/exports/Update-JcSdkBulkUser.md | 268 ++ .../docs/exports/Update-JcSdkGSuite.md | 407 ++ .../docs/exports/Update-JcSdkIPList.md | 275 ++ .../docs/exports/Update-JcSdkLdapServer.md | 286 ++ .../docs/exports/Update-JcSdkOffice365.md | 379 ++ .../exports/Update-JcSdkUserPushEndpoint.md | 272 ++ .../JumpCloud.SDK.V2/test-module.ps1 | 494 ++- .../JumpCloud.SDK.V2/test/loadEnv.ps1 | 15 +- 283 files changed, 62065 insertions(+), 32 deletions(-) create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDevice.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDeviceActivationLock.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequest.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequestProgress.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectory.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAgent.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUser.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUserGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganization.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganizationLink.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdm.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmDevice.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmEnrollmentProfile.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUser.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUserGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlow.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlowSetting.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAuthenticationPolicy.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUserState.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUsersResult.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystem.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystemGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailConfiguration.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailTemplate.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDirectory.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoAccount.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoApplication.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuite.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTranslationRule.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUser.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUserGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteUsersToImport.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGsuiteUsersToImportFormatted.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkIPList.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServer.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerSambaDomain.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUser.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUserGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkNextScheduledBulkUserState.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365Association.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TranslationRule.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUser.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUserGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365UsersToImport.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOrganizationPolicyResult.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicy.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMember.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMembership.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystem.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystemGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyResult.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyStatus.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTemplate.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystem.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystemGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderAdministrator.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderOrganization.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProvidersInvoice.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUser.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUserGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareApp.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppStatus.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystem.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystemGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSubscription.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemFdeKey.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMember.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMembership.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseCommand.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicy.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicyGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUser.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUserGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlf.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfException.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfExplicitAuth.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightApp.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAppCompatShim.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAuthorizedKey.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceMetadata.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceTag.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBattery.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBitlockerInfo.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBrowserPlugin.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCertificate.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChassisInfo.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChromeExtension.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightConnectivity.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCrash.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCupDestination.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskEncryption.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskInfo.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDnsResolver.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightEtcHost.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightFirefoxAddon.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightIeExtension.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceAddress.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceDetail.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightKernelInfo.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLaunchd.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLinuxPackage.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLoggedinUser.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLogicalDrive.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightManagedPolicy.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightMount.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightOSVersion.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPatch.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightProgram.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPythonPackage.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSafariExtension.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightScheduledTask.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSecureboot.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightService.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightShadow.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedFolder.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedResource.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharingPreference.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSipConfig.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightStartupItem.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemControl.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemInfo.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightTpmInfo.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUptime.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUsbDevice.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUser.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserAssist.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserSshKey.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiNetwork.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiStatus.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityCenter.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityProduct.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemMember.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemPolicyStatus.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseCommand.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicy.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicyGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUser.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUserGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMember.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMembership.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseActiveDirectory.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseApplication.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseDirectory.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseGSuite.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseLdapServer.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseOffice365.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseRadiusServer.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystem.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystemGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserMember.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserPushEndpoint.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseActiveDirectory.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseApplication.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseDirectory.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseGSuite.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseLdapServer.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseOffice365.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseRadiusServer.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystem.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystemGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkday.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkdayWorker.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Grant-JcSdkWorkday.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkScim.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkday.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkdayResult.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Invoke-JcSdkReclaimSoftwareAppLicense.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/JumpCloud.SDK.V2.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Lock-JcSdkAppleMdmDevice.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectory.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectoryAgent.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAdministratorOrganization.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkApprovalFlow.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAuthenticationPolicy.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUser.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUserState.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkCustomEmailConfiguration.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoAccount.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoApplication.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkGSuiteTranslationRule.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkIPList.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkLdapServerSambaDomain.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkOffice365TranslationRule.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicy.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicyGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkProviderAdministrator.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSoftwareApp.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSystemGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkUserGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkWorkday.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectory.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectoryAgent.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAdministratorOrganization.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdm.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdmDevice.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApplicationLogo.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApprovalFlow.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAuthenticationPolicy.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkBulkUserState.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkCustomEmailConfiguration.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoAccount.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoApplication.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkGSuiteTranslationRule.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkIPList.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkLdapServerSambaDomain.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkOffice365TranslationRule.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicy.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicyGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkProviderAdministrator.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSoftwareApp.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSystemGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserPushEndpoint.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkWorkdayAuthorization.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Restart-JcSdkAppleMdmDevice.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequest.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequestApproval.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkActiveDirectoryAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAppleMdm.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApplicationAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlow.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlowSetting.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCommandAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCustomEmailConfiguration.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkDuoApplication.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkGSuiteAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkIPList.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerSambaDomain.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkOffice365Association.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicy.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupMember.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkRadiusServerAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareApp.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareAppAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupMember.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroup.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupAssociation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupMember.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkWorkday.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Stop-JcSdkAppleMdmDevice.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Sync-JcSdkAppleMdmDevice.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAppleMdmDeviceLockInformation.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAuthenticationPolicy.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkBulkUser.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkGSuite.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkIPList.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkLdapServer.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkOffice365.md create mode 100644 SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkUserPushEndpoint.md diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/.gitignore b/SDKs/PowerShell/JumpCloud.SDK.V2/.gitignore index 6ec158bd9..de788ced9 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/.gitignore +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/.gitignore @@ -2,8 +2,10 @@ bin obj .vs generated +!custom/generated internal exports +!docs/exports tools test/*-TestResults.xml license.txt @@ -13,4 +15,4 @@ license.txt /*.psm1 /*.snk /*.csproj -/*.nuspec \ No newline at end of file +/*.nuspec diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.nuspec b/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.nuspec index 405cedbe1..d68102a68 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.nuspec +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.nuspec @@ -1,4 +1,4 @@ - + JumpCloud.SDK.V2 @@ -9,9 +9,11 @@ https://github.com/TheJumpCloud/jcapi-powershell/tree/$(branch)/LICENSE https://github.com/TheJumpCloud/jcapi-powershell/tree/$(branch)/SDKs/PowerShell/JumpCloud.SDK.V2/ The JumpCloud V2 PowerShell SDK - + + (c) JumpCloud. All rights reserved. JumpCloud, DaaS, Jump, Cloud, Directory + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.psd1 b/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.psd1 index 0ff2eeedc..a15db575d 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.psd1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.psd1 @@ -1,23 +1,306 @@ +# +# Module manifest for module 'JumpCloud.SDK.V2' +# +# Generated by: JumpCloud +# +# Generated on: 5/11/2026 +# + @{ - GUID = '4dd823c0-5661-4a3b-aea8-f54997fa5d89' - RootModule = './JumpCloud.SDK.V2.psm1' - ModuleVersion = '0.3.0' - CompatiblePSEditions = 'Core', 'Desktop' - Author = 'JumpCloud' - CompanyName = 'JumpCloud' - Copyright = '(c) JumpCloud. All rights reserved.' - Description = 'The JumpCloud V2 PowerShell SDK' - PowerShellVersion = '5.1' - DotNetFrameworkVersion = '4.7.2' - RequiredAssemblies = './bin/JumpCloud.SDK.V2.private.dll' - FormatsToProcess = @() - FunctionsToExport = 'Clear-JcSdkAppleMdmDevice', 'Clear-JcSdkAppleMdmDeviceActivationLock', 'Get-JcSdkAccessRequest', 'Get-JcSdkAccessRequestProgress', 'Get-JcSdkActiveDirectory', 'Get-JcSdkActiveDirectoryAgent', 'Get-JcSdkActiveDirectoryAssociation', 'Get-JcSdkActiveDirectoryTraverseUser', 'Get-JcSdkActiveDirectoryTraverseUserGroup', 'Get-JcSdkAdministratorOrganization', 'Get-JcSdkAdministratorOrganizationLink', 'Get-JcSdkAppleMdm', 'Get-JcSdkAppleMdmDevice', 'Get-JcSdkAppleMdmEnrollmentProfile', 'Get-JcSdkApplicationAssociation', 'Get-JcSdkApplicationTraverseUser', 'Get-JcSdkApplicationTraverseUserGroup', 'Get-JcSdkApprovalFlow', 'Get-JcSdkApprovalFlowSetting', 'Get-JcSdkAuthenticationPolicy', 'Get-JcSdkBulkUsersResult', 'Get-JcSdkBulkUserState', 'Get-JcSdkCommandAssociation', 'Get-JcSdkCommandTraverseSystem', 'Get-JcSdkCommandTraverseSystemGroup', 'Get-JcSdkCustomEmailConfiguration', 'Get-JcSdkCustomEmailTemplate', 'Get-JcSdkDirectory', 'Get-JcSdkDuoAccount', 'Get-JcSdkDuoApplication', 'Get-JcSdkGroup', 'Get-JcSdkGSuite', 'Get-JcSdkGSuiteAssociation', 'Get-JcSdkGSuiteTranslationRule', 'Get-JcSdkGSuiteTraverseUser', 'Get-JcSdkGSuiteTraverseUserGroup', 'Get-JcSdkGSuiteUsersToImport', 'Get-JcSdkGsuiteUsersToImportFormatted', 'Get-JcSdkIPList', 'Get-JcSdkLdapServer', 'Get-JcSdkLdapServerAssociation', 'Get-JcSdkLdapServerSambaDomain', 'Get-JcSdkLdapServerTraverseUser', 'Get-JcSdkLdapServerTraverseUserGroup', 'Get-JcSdkNextScheduledBulkUserState', 'Get-JcSdkOffice365', 'Get-JcSdkOffice365Association', 'Get-JcSdkOffice365TranslationRule', 'Get-JcSdkOffice365TraverseUser', 'Get-JcSdkOffice365TraverseUserGroup', 'Get-JcSdkOffice365UsersToImport', 'Get-JcSdkOrganizationPolicyResult', 'Get-JcSdkPolicy', 'Get-JcSdkPolicyAssociation', 'Get-JcSdkPolicyGroup', 'Get-JcSdkPolicyGroupAssociation', 'Get-JcSdkPolicyGroupMember', 'Get-JcSdkPolicyGroupMembership', 'Get-JcSdkPolicyGroupTraverseSystem', 'Get-JcSdkPolicyGroupTraverseSystemGroup', 'Get-JcSdkPolicyResult', 'Get-JcSdkPolicyStatus', 'Get-JcSdkPolicyTemplate', 'Get-JcSdkPolicyTraverseSystem', 'Get-JcSdkPolicyTraverseSystemGroup', 'Get-JcSdkProviderAdministrator', 'Get-JcSdkProviderOrganization', 'Get-JcSdkProvidersInvoice', 'Get-JcSdkRadiusServerAssociation', 'Get-JcSdkRadiusServerTraverseUser', 'Get-JcSdkRadiusServerTraverseUserGroup', 'Get-JcSdkSoftwareApp', 'Get-JcSdkSoftwareAppAssociation', 'Get-JcSdkSoftwareAppStatus', 'Get-JcSdkSoftwareAppTraverseSystem', 'Get-JcSdkSoftwareAppTraverseSystemGroup', 'Get-JcSdkSubscription', 'Get-JcSdkSystemAssociation', 'Get-JcSdkSystemFdeKey', 'Get-JcSdkSystemGroup', 'Get-JcSdkSystemGroupAssociation', 'Get-JcSdkSystemGroupMember', 'Get-JcSdkSystemGroupMembership', 'Get-JcSdkSystemGroupTraverseCommand', 'Get-JcSdkSystemGroupTraversePolicy', 'Get-JcSdkSystemGroupTraversePolicyGroup', 'Get-JcSdkSystemGroupTraverseUser', 'Get-JcSdkSystemGroupTraverseUserGroup', 'Get-JcSdkSystemInsightAlf', 'Get-JcSdkSystemInsightAlfException', 'Get-JcSdkSystemInsightAlfExplicitAuth', 'Get-JcSdkSystemInsightApp', 'Get-JcSdkSystemInsightAppCompatShim', 'Get-JcSdkSystemInsightAuthorizedKey', 'Get-JcSdkSystemInsightAzureInstanceMetadata', 'Get-JcSdkSystemInsightAzureInstanceTag', 'Get-JcSdkSystemInsightBattery', 'Get-JcSdkSystemInsightBitlockerInfo', 'Get-JcSdkSystemInsightBrowserPlugin', 'Get-JcSdkSystemInsightCertificate', 'Get-JcSdkSystemInsightChassisInfo', 'Get-JcSdkSystemInsightChromeExtension', 'Get-JcSdkSystemInsightConnectivity', 'Get-JcSdkSystemInsightCrash', 'Get-JcSdkSystemInsightCupDestination', 'Get-JcSdkSystemInsightDiskEncryption', 'Get-JcSdkSystemInsightDiskInfo', 'Get-JcSdkSystemInsightDnsResolver', 'Get-JcSdkSystemInsightEtcHost', 'Get-JcSdkSystemInsightFirefoxAddon', 'Get-JcSdkSystemInsightGroup', 'Get-JcSdkSystemInsightIeExtension', 'Get-JcSdkSystemInsightInterfaceAddress', 'Get-JcSdkSystemInsightInterfaceDetail', 'Get-JcSdkSystemInsightKernelInfo', 'Get-JcSdkSystemInsightLaunchd', 'Get-JcSdkSystemInsightLinuxPackage', 'Get-JcSdkSystemInsightLoggedinUser', 'Get-JcSdkSystemInsightLogicalDrive', 'Get-JcSdkSystemInsightManagedPolicy', 'Get-JcSdkSystemInsightMount', 'Get-JcSdkSystemInsightOSVersion', 'Get-JcSdkSystemInsightPatch', 'Get-JcSdkSystemInsightProgram', 'Get-JcSdkSystemInsightPythonPackage', 'Get-JcSdkSystemInsightSafariExtension', 'Get-JcSdkSystemInsightScheduledTask', 'Get-JcSdkSystemInsightSecureboot', 'Get-JcSdkSystemInsightService', 'Get-JcSdkSystemInsightShadow', 'Get-JcSdkSystemInsightSharedFolder', 'Get-JcSdkSystemInsightSharedResource', 'Get-JcSdkSystemInsightSharingPreference', 'Get-JcSdkSystemInsightSipConfig', 'Get-JcSdkSystemInsightStartupItem', 'Get-JcSdkSystemInsightSystemControl', 'Get-JcSdkSystemInsightSystemInfo', 'Get-JcSdkSystemInsightTpmInfo', 'Get-JcSdkSystemInsightUptime', 'Get-JcSdkSystemInsightUsbDevice', 'Get-JcSdkSystemInsightUser', 'Get-JcSdkSystemInsightUserAssist', 'Get-JcSdkSystemInsightUserGroup', 'Get-JcSdkSystemInsightUserSshKey', 'Get-JcSdkSystemInsightWifiNetwork', 'Get-JcSdkSystemInsightWifiStatus', 'Get-JcSdkSystemInsightWindowsSecurityCenter', 'Get-JcSdkSystemInsightWindowsSecurityProduct', 'Get-JcSdkSystemMember', 'Get-JcSdkSystemPolicyStatus', 'Get-JcSdkSystemTraverseCommand', 'Get-JcSdkSystemTraversePolicy', 'Get-JcSdkSystemTraversePolicyGroup', 'Get-JcSdkSystemTraverseUser', 'Get-JcSdkSystemTraverseUserGroup', 'Get-JcSdkUserAssociation', 'Get-JcSdkUserGroup', 'Get-JcSdkUserGroupAssociation', 'Get-JcSdkUserGroupMember', 'Get-JcSdkUserGroupMembership', 'Get-JcSdkUserGroupTraverseActiveDirectory', 'Get-JcSdkUserGroupTraverseApplication', 'Get-JcSdkUserGroupTraverseDirectory', 'Get-JcSdkUserGroupTraverseGSuite', 'Get-JcSdkUserGroupTraverseLdapServer', 'Get-JcSdkUserGroupTraverseOffice365', 'Get-JcSdkUserGroupTraverseRadiusServer', 'Get-JcSdkUserGroupTraverseSystem', 'Get-JcSdkUserGroupTraverseSystemGroup', 'Get-JcSdkUserMember', 'Get-JcSdkUserPushEndpoint', 'Get-JcSdkUserTraverseActiveDirectory', 'Get-JcSdkUserTraverseApplication', 'Get-JcSdkUserTraverseDirectory', 'Get-JcSdkUserTraverseGSuite', 'Get-JcSdkUserTraverseLdapServer', 'Get-JcSdkUserTraverseOffice365', 'Get-JcSdkUserTraverseRadiusServer', 'Get-JcSdkUserTraverseSystem', 'Get-JcSdkUserTraverseSystemGroup', 'Get-JcSdkWorkday', 'Get-JcSdkWorkdayWorker', 'Grant-JcSdkWorkday', 'Import-JcSdkScim', 'Import-JcSdkWorkday', 'Import-JcSdkWorkdayResult', 'Invoke-JcSdkReclaimSoftwareAppLicense', 'Lock-JcSdkAppleMdmDevice', 'New-JcSdkActiveDirectory', 'New-JcSdkActiveDirectoryAgent', 'New-JcSdkAdministratorOrganization', 'New-JcSdkApprovalFlow', 'New-JcSdkAuthenticationPolicy', 'New-JcSdkBulkUser', 'New-JcSdkBulkUserState', 'New-JcSdkCustomEmailConfiguration', 'New-JcSdkDuoAccount', 'New-JcSdkDuoApplication', 'New-JcSdkGSuiteTranslationRule', 'New-JcSdkIPList', 'New-JcSdkLdapServerSambaDomain', 'New-JcSdkOffice365TranslationRule', 'New-JcSdkPolicy', 'New-JcSdkPolicyGroup', 'New-JcSdkProviderAdministrator', 'New-JcSdkSoftwareApp', 'New-JcSdkSystemGroup', 'New-JcSdkUserGroup', 'New-JcSdkWorkday', 'Remove-JcSdkActiveDirectory', 'Remove-JcSdkActiveDirectoryAgent', 'Remove-JcSdkAdministratorOrganization', 'Remove-JcSdkAppleMdm', 'Remove-JcSdkAppleMdmDevice', 'Remove-JcSdkApplicationLogo', 'Remove-JcSdkApprovalFlow', 'Remove-JcSdkAuthenticationPolicy', 'Remove-JcSdkBulkUserState', 'Remove-JcSdkCustomEmailConfiguration', 'Remove-JcSdkDuoAccount', 'Remove-JcSdkDuoApplication', 'Remove-JcSdkGSuiteTranslationRule', 'Remove-JcSdkIPList', 'Remove-JcSdkLdapServerSambaDomain', 'Remove-JcSdkOffice365TranslationRule', 'Remove-JcSdkPolicy', 'Remove-JcSdkPolicyGroup', 'Remove-JcSdkProviderAdministrator', 'Remove-JcSdkSoftwareApp', 'Remove-JcSdkSystemGroup', 'Remove-JcSdkUserGroup', 'Remove-JcSdkUserPushEndpoint', 'Remove-JcSdkWorkdayAuthorization', 'Restart-JcSdkAppleMdmDevice', 'Set-JcSdkAccessRequest', 'Set-JcSdkAccessRequestApproval', 'Set-JcSdkActiveDirectoryAssociation', 'Set-JcSdkAppleMdm', 'Set-JcSdkApplicationAssociation', 'Set-JcSdkApprovalFlow', 'Set-JcSdkApprovalFlowSetting', 'Set-JcSdkCommandAssociation', 'Set-JcSdkCustomEmailConfiguration', 'Set-JcSdkDuoApplication', 'Set-JcSdkGSuiteAssociation', 'Set-JcSdkIPList', 'Set-JcSdkLdapServerAssociation', 'Set-JcSdkLdapServerSambaDomain', 'Set-JcSdkOffice365Association', 'Set-JcSdkPolicy', 'Set-JcSdkPolicyAssociation', 'Set-JcSdkPolicyGroup', 'Set-JcSdkPolicyGroupAssociation', 'Set-JcSdkPolicyGroupMember', 'Set-JcSdkRadiusServerAssociation', 'Set-JcSdkSoftwareApp', 'Set-JcSdkSoftwareAppAssociation', 'Set-JcSdkSystemAssociation', 'Set-JcSdkSystemGroup', 'Set-JcSdkSystemGroupAssociation', 'Set-JcSdkSystemGroupMember', 'Set-JcSdkUserAssociation', 'Set-JcSdkUserGroup', 'Set-JcSdkUserGroupAssociation', 'Set-JcSdkUserGroupMember', 'Set-JcSdkWorkday', 'Stop-JcSdkAppleMdmDevice', 'Sync-JcSdkAppleMdmDevice', 'Update-JcSdkAppleMdmDeviceLockInformation', 'Update-JcSdkAuthenticationPolicy', 'Update-JcSdkBulkUser', 'Update-JcSdkGSuite', 'Update-JcSdkIPList', 'Update-JcSdkLdapServer', 'Update-JcSdkOffice365', 'Update-JcSdkUserPushEndpoint' - PrivateData = @{ + +# Script module or binary module file associated with this manifest. +RootModule = './JumpCloud.SDK.V2.psm1' + +# Version number of this module. +ModuleVersion = '0.3.0' + +# Supported PSEditions +CompatiblePSEditions = 'Core', 'Desktop' + +# ID used to uniquely identify this module +GUID = 'ff397964-2121-4c89-a916-34b5c30d7187' + +# Author of this module +Author = 'JumpCloud' + +# Company or vendor of this module +CompanyName = 'JumpCloud' + +# Copyright statement for this module +Copyright = '(c) JumpCloud. All rights reserved.' + +# Description of the functionality provided by this module +Description = 'The JumpCloud V2 PowerShell SDK' + +# Minimum version of the PowerShell engine required by this module +PowerShellVersion = '5.1' + +# Name of the PowerShell host required by this module +# PowerShellHostName = '' + +# Minimum version of the PowerShell host required by this module +# PowerShellHostVersion = '' + +# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. +DotNetFrameworkVersion = '4.7.2' + +# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. +# ClrVersion = '' + +# Processor architecture (None, X86, Amd64) required by this module +# ProcessorArchitecture = '' + +# Modules that must be imported into the global environment prior to importing this module +# RequiredModules = @() + +# Assemblies that must be loaded prior to importing this module +RequiredAssemblies = './bin/JumpCloud.SDK.V2.private.dll' + +# Script files (.ps1) that are run in the caller's environment prior to importing this module. +# ScriptsToProcess = @() + +# Type files (.ps1xml) to be loaded when importing this module +# TypesToProcess = @() + +# Format files (.ps1xml) to be loaded when importing this module +# FormatsToProcess = @() + +# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess +# 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 = 'Clear-JcSdkAppleMdmDevice', + 'Clear-JcSdkAppleMdmDeviceActivationLock', 'Get-JcSdkAccessRequest', + 'Get-JcSdkAccessRequestProgress', 'Get-JcSdkActiveDirectory', + 'Get-JcSdkActiveDirectoryAgent', + 'Get-JcSdkActiveDirectoryAssociation', + 'Get-JcSdkActiveDirectoryTraverseUser', + 'Get-JcSdkActiveDirectoryTraverseUserGroup', + 'Get-JcSdkAdministratorOrganization', + 'Get-JcSdkAdministratorOrganizationLink', 'Get-JcSdkAppleMdm', + 'Get-JcSdkAppleMdmDevice', 'Get-JcSdkAppleMdmEnrollmentProfile', + 'Get-JcSdkApplicationAssociation', + 'Get-JcSdkApplicationTraverseUser', + 'Get-JcSdkApplicationTraverseUserGroup', 'Get-JcSdkApprovalFlow', + 'Get-JcSdkApprovalFlowSetting', 'Get-JcSdkAuthenticationPolicy', + 'Get-JcSdkBulkUsersResult', 'Get-JcSdkBulkUserState', + 'Get-JcSdkCommandAssociation', 'Get-JcSdkCommandTraverseSystem', + 'Get-JcSdkCommandTraverseSystemGroup', + 'Get-JcSdkCustomEmailConfiguration', 'Get-JcSdkCustomEmailTemplate', + 'Get-JcSdkDirectory', 'Get-JcSdkDuoAccount', + 'Get-JcSdkDuoApplication', 'Get-JcSdkGroup', 'Get-JcSdkGSuite', + 'Get-JcSdkGSuiteAssociation', 'Get-JcSdkGSuiteTranslationRule', + 'Get-JcSdkGSuiteTraverseUser', 'Get-JcSdkGSuiteTraverseUserGroup', + 'Get-JcSdkGSuiteUsersToImport', + 'Get-JcSdkGsuiteUsersToImportFormatted', 'Get-JcSdkIPList', + 'Get-JcSdkLdapServer', 'Get-JcSdkLdapServerAssociation', + 'Get-JcSdkLdapServerSambaDomain', 'Get-JcSdkLdapServerTraverseUser', + 'Get-JcSdkLdapServerTraverseUserGroup', + 'Get-JcSdkNextScheduledBulkUserState', 'Get-JcSdkOffice365', + 'Get-JcSdkOffice365Association', + 'Get-JcSdkOffice365TranslationRule', + 'Get-JcSdkOffice365TraverseUser', + 'Get-JcSdkOffice365TraverseUserGroup', + 'Get-JcSdkOffice365UsersToImport', + 'Get-JcSdkOrganizationPolicyResult', 'Get-JcSdkPolicy', + 'Get-JcSdkPolicyAssociation', 'Get-JcSdkPolicyGroup', + 'Get-JcSdkPolicyGroupAssociation', 'Get-JcSdkPolicyGroupMember', + 'Get-JcSdkPolicyGroupMembership', + 'Get-JcSdkPolicyGroupTraverseSystem', + 'Get-JcSdkPolicyGroupTraverseSystemGroup', 'Get-JcSdkPolicyResult', + 'Get-JcSdkPolicyStatus', 'Get-JcSdkPolicyTemplate', + 'Get-JcSdkPolicyTraverseSystem', + 'Get-JcSdkPolicyTraverseSystemGroup', + 'Get-JcSdkProviderAdministrator', 'Get-JcSdkProviderOrganization', + 'Get-JcSdkProvidersInvoice', 'Get-JcSdkRadiusServerAssociation', + 'Get-JcSdkRadiusServerTraverseUser', + 'Get-JcSdkRadiusServerTraverseUserGroup', 'Get-JcSdkSoftwareApp', + 'Get-JcSdkSoftwareAppAssociation', 'Get-JcSdkSoftwareAppStatus', + 'Get-JcSdkSoftwareAppTraverseSystem', + 'Get-JcSdkSoftwareAppTraverseSystemGroup', 'Get-JcSdkSubscription', + 'Get-JcSdkSystemAssociation', 'Get-JcSdkSystemFdeKey', + 'Get-JcSdkSystemGroup', 'Get-JcSdkSystemGroupAssociation', + 'Get-JcSdkSystemGroupMember', 'Get-JcSdkSystemGroupMembership', + 'Get-JcSdkSystemGroupTraverseCommand', + 'Get-JcSdkSystemGroupTraversePolicy', + 'Get-JcSdkSystemGroupTraversePolicyGroup', + 'Get-JcSdkSystemGroupTraverseUser', + 'Get-JcSdkSystemGroupTraverseUserGroup', + 'Get-JcSdkSystemInsightAlf', 'Get-JcSdkSystemInsightAlfException', + 'Get-JcSdkSystemInsightAlfExplicitAuth', + 'Get-JcSdkSystemInsightApp', 'Get-JcSdkSystemInsightAppCompatShim', + 'Get-JcSdkSystemInsightAuthorizedKey', + 'Get-JcSdkSystemInsightAzureInstanceMetadata', + 'Get-JcSdkSystemInsightAzureInstanceTag', + 'Get-JcSdkSystemInsightBattery', + 'Get-JcSdkSystemInsightBitlockerInfo', + 'Get-JcSdkSystemInsightBrowserPlugin', + 'Get-JcSdkSystemInsightCertificate', + 'Get-JcSdkSystemInsightChassisInfo', + 'Get-JcSdkSystemInsightChromeExtension', + 'Get-JcSdkSystemInsightConnectivity', 'Get-JcSdkSystemInsightCrash', + 'Get-JcSdkSystemInsightCupDestination', + 'Get-JcSdkSystemInsightDiskEncryption', + 'Get-JcSdkSystemInsightDiskInfo', + 'Get-JcSdkSystemInsightDnsResolver', + 'Get-JcSdkSystemInsightEtcHost', + 'Get-JcSdkSystemInsightFirefoxAddon', 'Get-JcSdkSystemInsightGroup', + 'Get-JcSdkSystemInsightIeExtension', + 'Get-JcSdkSystemInsightInterfaceAddress', + 'Get-JcSdkSystemInsightInterfaceDetail', + 'Get-JcSdkSystemInsightKernelInfo', 'Get-JcSdkSystemInsightLaunchd', + 'Get-JcSdkSystemInsightLinuxPackage', + 'Get-JcSdkSystemInsightLoggedinUser', + 'Get-JcSdkSystemInsightLogicalDrive', + 'Get-JcSdkSystemInsightManagedPolicy', + 'Get-JcSdkSystemInsightMount', 'Get-JcSdkSystemInsightOSVersion', + 'Get-JcSdkSystemInsightPatch', 'Get-JcSdkSystemInsightProgram', + 'Get-JcSdkSystemInsightPythonPackage', + 'Get-JcSdkSystemInsightSafariExtension', + 'Get-JcSdkSystemInsightScheduledTask', + 'Get-JcSdkSystemInsightSecureboot', 'Get-JcSdkSystemInsightService', + 'Get-JcSdkSystemInsightShadow', + 'Get-JcSdkSystemInsightSharedFolder', + 'Get-JcSdkSystemInsightSharedResource', + 'Get-JcSdkSystemInsightSharingPreference', + 'Get-JcSdkSystemInsightSipConfig', + 'Get-JcSdkSystemInsightStartupItem', + 'Get-JcSdkSystemInsightSystemControl', + 'Get-JcSdkSystemInsightSystemInfo', 'Get-JcSdkSystemInsightTpmInfo', + 'Get-JcSdkSystemInsightUptime', 'Get-JcSdkSystemInsightUsbDevice', + 'Get-JcSdkSystemInsightUser', 'Get-JcSdkSystemInsightUserAssist', + 'Get-JcSdkSystemInsightUserGroup', + 'Get-JcSdkSystemInsightUserSshKey', + 'Get-JcSdkSystemInsightWifiNetwork', + 'Get-JcSdkSystemInsightWifiStatus', + 'Get-JcSdkSystemInsightWindowsSecurityCenter', + 'Get-JcSdkSystemInsightWindowsSecurityProduct', + 'Get-JcSdkSystemMember', 'Get-JcSdkSystemPolicyStatus', + 'Get-JcSdkSystemTraverseCommand', 'Get-JcSdkSystemTraversePolicy', + 'Get-JcSdkSystemTraversePolicyGroup', 'Get-JcSdkSystemTraverseUser', + 'Get-JcSdkSystemTraverseUserGroup', 'Get-JcSdkUserAssociation', + 'Get-JcSdkUserGroup', 'Get-JcSdkUserGroupAssociation', + 'Get-JcSdkUserGroupMember', 'Get-JcSdkUserGroupMembership', + 'Get-JcSdkUserGroupTraverseActiveDirectory', + 'Get-JcSdkUserGroupTraverseApplication', + 'Get-JcSdkUserGroupTraverseDirectory', + 'Get-JcSdkUserGroupTraverseGSuite', + 'Get-JcSdkUserGroupTraverseLdapServer', + 'Get-JcSdkUserGroupTraverseOffice365', + 'Get-JcSdkUserGroupTraverseRadiusServer', + 'Get-JcSdkUserGroupTraverseSystem', + 'Get-JcSdkUserGroupTraverseSystemGroup', 'Get-JcSdkUserMember', + 'Get-JcSdkUserPushEndpoint', 'Get-JcSdkUserTraverseActiveDirectory', + 'Get-JcSdkUserTraverseApplication', + 'Get-JcSdkUserTraverseDirectory', 'Get-JcSdkUserTraverseGSuite', + 'Get-JcSdkUserTraverseLdapServer', 'Get-JcSdkUserTraverseOffice365', + 'Get-JcSdkUserTraverseRadiusServer', 'Get-JcSdkUserTraverseSystem', + 'Get-JcSdkUserTraverseSystemGroup', 'Get-JcSdkWorkday', + 'Get-JcSdkWorkdayWorker', 'Grant-JcSdkWorkday', 'Import-JcSdkScim', + 'Import-JcSdkWorkday', 'Import-JcSdkWorkdayResult', + 'Invoke-JcSdkReclaimSoftwareAppLicense', 'Lock-JcSdkAppleMdmDevice', + 'New-JcSdkActiveDirectory', 'New-JcSdkActiveDirectoryAgent', + 'New-JcSdkAdministratorOrganization', 'New-JcSdkApprovalFlow', + 'New-JcSdkAuthenticationPolicy', 'New-JcSdkBulkUser', + 'New-JcSdkBulkUserState', 'New-JcSdkCustomEmailConfiguration', + 'New-JcSdkDuoAccount', 'New-JcSdkDuoApplication', + 'New-JcSdkGSuiteTranslationRule', 'New-JcSdkIPList', + 'New-JcSdkLdapServerSambaDomain', + 'New-JcSdkOffice365TranslationRule', 'New-JcSdkPolicy', + 'New-JcSdkPolicyGroup', 'New-JcSdkProviderAdministrator', + 'New-JcSdkSoftwareApp', 'New-JcSdkSystemGroup', 'New-JcSdkUserGroup', + 'New-JcSdkWorkday', 'Remove-JcSdkActiveDirectory', + 'Remove-JcSdkActiveDirectoryAgent', + 'Remove-JcSdkAdministratorOrganization', 'Remove-JcSdkAppleMdm', + 'Remove-JcSdkAppleMdmDevice', 'Remove-JcSdkApplicationLogo', + 'Remove-JcSdkApprovalFlow', 'Remove-JcSdkAuthenticationPolicy', + 'Remove-JcSdkBulkUserState', 'Remove-JcSdkCustomEmailConfiguration', + 'Remove-JcSdkDuoAccount', 'Remove-JcSdkDuoApplication', + 'Remove-JcSdkGSuiteTranslationRule', 'Remove-JcSdkIPList', + 'Remove-JcSdkLdapServerSambaDomain', + 'Remove-JcSdkOffice365TranslationRule', 'Remove-JcSdkPolicy', + 'Remove-JcSdkPolicyGroup', 'Remove-JcSdkProviderAdministrator', + 'Remove-JcSdkSoftwareApp', 'Remove-JcSdkSystemGroup', + 'Remove-JcSdkUserGroup', 'Remove-JcSdkUserPushEndpoint', + 'Remove-JcSdkWorkdayAuthorization', 'Restart-JcSdkAppleMdmDevice', + 'Set-JcSdkAccessRequest', 'Set-JcSdkAccessRequestApproval', + 'Set-JcSdkActiveDirectoryAssociation', 'Set-JcSdkAppleMdm', + 'Set-JcSdkApplicationAssociation', 'Set-JcSdkApprovalFlow', + 'Set-JcSdkApprovalFlowSetting', 'Set-JcSdkCommandAssociation', + 'Set-JcSdkCustomEmailConfiguration', 'Set-JcSdkDuoApplication', + 'Set-JcSdkGSuiteAssociation', 'Set-JcSdkIPList', + 'Set-JcSdkLdapServerAssociation', 'Set-JcSdkLdapServerSambaDomain', + 'Set-JcSdkOffice365Association', 'Set-JcSdkPolicy', + 'Set-JcSdkPolicyAssociation', 'Set-JcSdkPolicyGroup', + 'Set-JcSdkPolicyGroupAssociation', 'Set-JcSdkPolicyGroupMember', + 'Set-JcSdkRadiusServerAssociation', 'Set-JcSdkSoftwareApp', + 'Set-JcSdkSoftwareAppAssociation', 'Set-JcSdkSystemAssociation', + 'Set-JcSdkSystemGroup', 'Set-JcSdkSystemGroupAssociation', + 'Set-JcSdkSystemGroupMember', 'Set-JcSdkUserAssociation', + 'Set-JcSdkUserGroup', 'Set-JcSdkUserGroupAssociation', + 'Set-JcSdkUserGroupMember', 'Set-JcSdkWorkday', + 'Stop-JcSdkAppleMdmDevice', 'Sync-JcSdkAppleMdmDevice', + 'Update-JcSdkAppleMdmDeviceLockInformation', + 'Update-JcSdkAuthenticationPolicy', 'Update-JcSdkBulkUser', + 'Update-JcSdkGSuite', 'Update-JcSdkIPList', 'Update-JcSdkLdapServer', + 'Update-JcSdkOffice365', 'Update-JcSdkUserPushEndpoint' + +# 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 = @() + +# Variables to export from this module +# VariablesToExport = @() + +# Aliases 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 aliases to export. +AliasesToExport = @() + +# DSC resources to export from this module +# DscResourcesToExport = @() + +# List of all modules packaged with this module +# ModuleList = @() + +# List of all files packaged with this module +# FileList = @() + +# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. +PrivateData = @{ + PSData = @{ - Tags = 'JumpCloud,', 'DaaS,', 'Jump,', 'Cloud,', 'Directory' - LicenseUri = 'https://github.com/TheJumpCloud/jcapi-powershell/tree/master/LICENSE' - ProjectUri = 'https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/' - ReleaseNotes = '' - } - } + + # Tags applied to this module. These help with module discovery in online galleries. + Tags = 'JumpCloud,','DaaS,','Jump,','Cloud,','Directory' + + # A URL to the license for this module. + LicenseUri = 'https://github.com/TheJumpCloud/jcapi-powershell/tree/master/LICENSE' + + # A URL to the main website for this project. + ProjectUri = 'https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/' + + # A URL to an icon representing this module. + # IconUri = '' + + # ReleaseNotes of this module + # ReleaseNotes = '' + + # Prerelease string of this module + # Prerelease = '' + + # Flag to indicate whether the module requires explicit user acceptance for install/update/save + # RequireLicenseAcceptance = $false + + # External dependent modules of this module + # ExternalModuleDependencies = @() + + } # End of PSData hashtable + + } # End of PrivateData hashtable + +# HelpInfo URI of this module +# HelpInfoURI = '' + +# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. +# DefaultCommandPrefix = '' + } + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/check-dependencies.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/check-dependencies.ps1 index b999d9d54..6566187bc 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/check-dependencies.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/check-dependencies.ps1 @@ -47,9 +47,10 @@ $resourceModule = Join-Path $HOME '.PSSharedModules\Resources\Az.Resources.TestS if ($Resources.IsPresent -and ((-not (Test-Path -Path $resourceModule)) -or $RegenerateSupportModule.IsPresent)) { Write-Host -ForegroundColor Green "Building local Resource module used for test..." Set-Location $resourceDir - $null = autorest .\README.md --use:@autorest/powershell@3.0.414 --output-folder=$HOME/.PSSharedModules/Resources + $null = npx autorest .\README.md --version:3.10.8 --use:@autorest/powershell@3.0.414 --output-folder=$HOME/.PSSharedModules/Resources $null = Copy-Item custom/* $HOME/.PSSharedModules/Resources/custom/ Set-Location $HOME/.PSSharedModules/Resources $null = .\build-module.ps1 Set-Location $PSScriptRoot } + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDevice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDevice.md new file mode 100644 index 000000000..55baa82ad --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDevice.md @@ -0,0 +1,267 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDevice.md +schema: 2.0.0 +--- + +# Clear-JcSdkAppleMdmDevice + +## SYNOPSIS +Erases a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/erase \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +## SYNTAX + +### ClearExpanded (Default) +``` +Clear-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId [-Pin ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Clear +``` +Clear-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId + -Body + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### ClearViaIdentity +``` +Clear-JcSdkAppleMdmDevice -ConsoleHost -InputObject + -Body + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### ClearViaIdentityExpanded +``` +Clear-JcSdkAppleMdmDevice -ConsoleHost -InputObject [-Pin ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Erases a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/erase \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Clear-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Pin:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Clear-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Body:() +``` + + + +## PARAMETERS + +### -AppleMdmId +. + +```yaml +Type: System.String +Parameter Sets: Clear, ClearExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IPaths1FfbqfwApplemdmsAppleMdmIdDevicesDeviceIdErasePostRequestbodyContentApplicationJsonSchema +Parameter Sets: Clear, ClearViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +. + +```yaml +Type: System.String +Parameter Sets: Clear, ClearExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: ClearViaIdentity, ClearViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pin +6-digit PIN, required for MacOS, to erase the device + +```yaml +Type: System.String +Parameter Sets: ClearExpanded, ClearViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.IPaths1FfbqfwApplemdmsAppleMdmIdDevicesDeviceIdErasePostRequestbodyContentApplicationJsonSchema + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: . + - `[Pin ]`: 6-digit PIN, required for MacOS, to erase the device + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDeviceActivationLock.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDeviceActivationLock.md new file mode 100644 index 000000000..88ae08aae --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDeviceActivationLock.md @@ -0,0 +1,218 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Clear-JcSdkAppleMdmDeviceActivationLock.md +schema: 2.0.0 +--- + +# Clear-JcSdkAppleMdmDeviceActivationLock + +## SYNOPSIS +Clears the activation lock on the specified device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/clearActivationLock \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +## SYNTAX + +### Clear (Default) +``` +Clear-JcSdkAppleMdmDeviceActivationLock -ConsoleHost -AppleMdmId -DeviceId + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### ClearViaIdentity +``` +Clear-JcSdkAppleMdmDeviceActivationLock -ConsoleHost -InputObject [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Clears the activation lock on the specified device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/clearActivationLock \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Clear-JcSdkAppleMdmDeviceActivationLock -AppleMdmId:() -DeviceId:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -AppleMdmId +. + +```yaml +Type: System.String +Parameter Sets: Clear +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +. + +```yaml +Type: System.String +Parameter Sets: Clear +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: ClearViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequest.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequest.md new file mode 100644 index 000000000..8ad1840b0 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequest.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequest.md +schema: 2.0.0 +--- + +# Get-JcSdkAccessRequest + +## SYNOPSIS +Endpoint that returns the workflow access request by id + +## SYNTAX + +### List (Default) +``` +Get-JcSdkAccessRequest -ConsoleHost [-Fields >] [-Filter >] + [-OrganizationObjectId ] [-Sort ] [] +``` + +### Get +``` +Get-JcSdkAccessRequest -ConsoleHost -Id [-OrganizationObjectId ] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkAccessRequest -ConsoleHost -InputObject + [-OrganizationObjectId ] [] +``` + +## DESCRIPTION +Endpoint that returns the workflow access request by id + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkAccessRequest -Id:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkAccessRequest -Fields:() -Filter:() -Sort:() +``` + + + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OrganizationObjectId +. + +```yaml +Type: System.Byte[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAllWorkflowAccessRequestResponse + +### JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetWorkflowAccessRequestResponse + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequestProgress.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequestProgress.md new file mode 100644 index 000000000..b9a96f65e --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequestProgress.md @@ -0,0 +1,147 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAccessRequestProgress.md +schema: 2.0.0 +--- + +# Get-JcSdkAccessRequestProgress + +## SYNOPSIS +Endpoint for getting the approval progress of a access request + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkAccessRequestProgress -ConsoleHost -Id [-OrganizationObjectId ] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkAccessRequestProgress -ConsoleHost -InputObject + [-OrganizationObjectId ] [] +``` + +## DESCRIPTION +Endpoint for getting the approval progress of a access request + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkAccessRequestProgress -Id:() +``` + + + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OrganizationObjectId +. + +```yaml +Type: System.Byte[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAccessRequestApprovalProgressResponse + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectory.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectory.md new file mode 100644 index 000000000..33b8be968 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectory.md @@ -0,0 +1,229 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectory.md +schema: 2.0.0 +--- + +# Get-JcSdkActiveDirectory + +## SYNOPSIS +This endpoint returns a specific Active Directory. + +#### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkActiveDirectory -ConsoleHost [-Fields >] [-Filter >] + [-Sort >] [] +``` + +### Get +``` +Get-JcSdkActiveDirectory -ConsoleHost -Id [] +``` + +### GetViaIdentity +``` +Get-JcSdkActiveDirectory -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint returns a specific Active Directory. + +#### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkActiveDirectory -Fields:() -Filter:() -Sort:() +``` + +---- ---------- +Domain String +Id String +PrimaryAgent String +UseCase String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkActiveDirectory -Id:() +``` + +---- ---------- +Domain String +Id String +PrimaryAgent String +UseCase String + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of this Active Directory instance. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IActiveDirectory + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAgent.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAgent.md new file mode 100644 index 000000000..017dac6be --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAgent.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAgent.md +schema: 2.0.0 +--- + +# Get-JcSdkActiveDirectoryAgent + +## SYNOPSIS +This endpoint returns an Active Directory agent. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkActiveDirectoryAgent -ConsoleHost -ActivedirectoryId [-Sort >] + [] +``` + +### Get +``` +Get-JcSdkActiveDirectoryAgent -ConsoleHost -ActivedirectoryId -AgentId + [] +``` + +### GetViaIdentity +``` +Get-JcSdkActiveDirectoryAgent -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint returns an Active Directory agent. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -Sort:() +``` + +---- ---------- +ContactAt String +Hostname String +Id String +SourceIP String +State String +Version String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -AgentId:() +``` + +---- ---------- +ContactAt String +Hostname String +Id String +SourceIP String +State String +Version String + +## PARAMETERS + +### -ActivedirectoryId +. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentId +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IActiveDirectoryAgentList + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAssociation.md new file mode 100644 index 000000000..11f92c40c --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAssociation.md @@ -0,0 +1,183 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryAssociation.md +schema: 2.0.0 +--- + +# Get-JcSdkActiveDirectoryAssociation + +## SYNOPSIS +This endpoint returns the direct associations of this Active Directory instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. + + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/associations?targets=user \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkActiveDirectoryAssociation -ConsoleHost -ActivedirectoryId -Targets + [] +``` + +### GetViaIdentity +``` +Get-JcSdkActiveDirectoryAssociation -ConsoleHost -InputObject + -Targets [] +``` + +## DESCRIPTION +This endpoint returns the direct associations of this Active Directory instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. + + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/associations?targets=user \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkActiveDirectoryAssociation -ActivedirectoryId:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ActivedirectoryId +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Targets +Targets which a "active_directory" can be associated to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphConnection + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUser.md new file mode 100644 index 000000000..762e8a389 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUser.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUser.md +schema: 2.0.0 +--- + +# Get-JcSdkActiveDirectoryTraverseUser + +## SYNOPSIS +This endpoint will return all Users bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Active Directory instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Active Directory instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/users \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkActiveDirectoryTraverseUser -ConsoleHost -ActivedirectoryId + [-Filter >] [] +``` + +### GetViaIdentity +``` +Get-JcSdkActiveDirectoryTraverseUser -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Users bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Active Directory instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Active Directory instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/users \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkActiveDirectoryTraverseUser -ActivedirectoryId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ActivedirectoryId +ObjectID of the Active Directory instance. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUserGroup.md new file mode 100644 index 000000000..36d5a591d --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUserGroup.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkActiveDirectoryTraverseUserGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkActiveDirectoryTraverseUserGroup + +## SYNOPSIS +This endpoint will return all Users Groups bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Active Directory instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Active Directory instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/usergroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkActiveDirectoryTraverseUserGroup -ConsoleHost -ActivedirectoryId + [-Filter >] [] +``` + +### GetViaIdentity +``` +Get-JcSdkActiveDirectoryTraverseUserGroup -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Users Groups bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Active Directory instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Active Directory instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/usergroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkActiveDirectoryTraverseUserGroup -ActivedirectoryId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ActivedirectoryId +ObjectID of the Active Directory instance. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganization.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganization.md new file mode 100644 index 000000000..4bcad3da6 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganization.md @@ -0,0 +1,85 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganization.md +schema: 2.0.0 +--- + +# Get-JcSdkAdministratorOrganization + +## SYNOPSIS +This endpoint returns the association links between an Administrator and Organizations. + +## SYNTAX + +``` +Get-JcSdkAdministratorOrganization -ConsoleHost -Id [] +``` + +## DESCRIPTION +This endpoint returns the association links between an Administrator and Organizations. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkAdministratorOrganization +``` + +---- ---------- +Administrator String +Organization String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganizationLink.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganizationLink.md new file mode 100644 index 000000000..9c4982de4 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganizationLink.md @@ -0,0 +1,85 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAdministratorOrganizationLink.md +schema: 2.0.0 +--- + +# Get-JcSdkAdministratorOrganizationLink + +## SYNOPSIS +This endpoint returns the association links between an Organization and Administrators. + +## SYNTAX + +``` +Get-JcSdkAdministratorOrganizationLink -ConsoleHost -Id [] +``` + +## DESCRIPTION +This endpoint returns the association links between an Organization and Administrators. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkAdministratorOrganizationLink +``` + +---- ---------- +Administrator String +Organization String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdm.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdm.md new file mode 100644 index 000000000..59523c047 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdm.md @@ -0,0 +1,111 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdm.md +schema: 2.0.0 +--- + +# Get-JcSdkAppleMdm + +## SYNOPSIS +Get a list of all Apple MDM configurations. +An empty topic indicates that a signed certificate from Apple has not been provided to the PUT endpoint yet. + +Note: currently only one MDM configuration per organization is supported. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/applemdms \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +``` +Get-JcSdkAppleMdm -ConsoleHost [-Filter >] [] +``` + +## DESCRIPTION +Get a list of all Apple MDM configurations. +An empty topic indicates that a signed certificate from Apple has not been provided to the PUT endpoint yet. + +Note: currently only one MDM configuration per organization is supported. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/applemdms \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkAppleMdm +``` + +Get Apple MDM Server information within a JumpCloud Tenant + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IAppleMdm + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmDevice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmDevice.md new file mode 100644 index 000000000..78a30a533 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmDevice.md @@ -0,0 +1,283 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmDevice.md +schema: 2.0.0 +--- + +# Get-JcSdkAppleMdmDevice + +## SYNOPSIS +Gets a single Apple MDM device. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ + -H 'accept: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId [-Filter >] + [-Sort >] [-XTotalCount ] [] +``` + +### Get +``` +Get-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId [] +``` + +### GetViaIdentity +``` +Get-JcSdkAppleMdmDevice -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +Gets a single Apple MDM device. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ + -H 'accept: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkAppleMdmDevice -AppleMdmId:() -Filter:() -Sort:() -XTotalCount:() +``` + +---- ---------- +CreatedAt String +DepRegistered Boolean +DeviceInformationActivationLockAllowedWhileSupervised Boolean +DeviceInformationAvailableDeviceCapacity System.Nullable[float] DeviceInformationAvailableDeviceCapacity {get;set;} +DeviceInformationDeviceCapacity System.Nullable[float] DeviceInformationDeviceCapacity {get;set;} +DeviceInformationDeviceName String +DeviceInformationIccid String +DeviceInformationImei String +DeviceInformationIsSupervised Boolean +DeviceInformationModelName String +DeviceInformationSecondIccid String +DeviceInformationSecondImei String +DeviceInformationSecondSubscriberCarrierNetwork String +DeviceInformationSubscriberCarrierNetwork String +DeviceInformationWifiMac String +Enrolled Boolean +HasActivationLockBypassCodes Boolean +Id String +OSVersion String +SecurityInfoEnrolledViaDep Boolean +SecurityInfoIsActivationLockManageable Boolean +SecurityInfoIsUserEnrollment Boolean +SecurityInfoPasscodePresent Boolean +SecurityInfoUserApprovedEnrollment Boolean +SerialNumber String +Udid String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() +``` + +---- ---------- +CreatedAt String +DepRegistered Boolean +DeviceInformationActivationLockAllowedWhileSupervised Boolean +DeviceInformationAvailableDeviceCapacity System.Nullable[float] DeviceInformationAvailableDeviceCapacity {get;set;} +DeviceInformationDeviceCapacity System.Nullable[float] DeviceInformationDeviceCapacity {get;set;} +DeviceInformationDeviceName String +DeviceInformationIccid String +DeviceInformationImei String +DeviceInformationIsSupervised Boolean +DeviceInformationModelName String +DeviceInformationSecondIccid String +DeviceInformationSecondImei String +DeviceInformationSecondSubscriberCarrierNetwork String +DeviceInformationSubscriberCarrierNetwork String +DeviceInformationWifiMac String +Enrolled Boolean +HasActivationLockBypassCodes Boolean +Id String +OSVersion String +SecurityInfoEnrolledViaDep Boolean +SecurityInfoIsActivationLockManageable Boolean +SecurityInfoIsUserEnrollment Boolean +SecurityInfoPasscodePresent Boolean +SecurityInfoUserApprovedEnrollment Boolean +SerialNumber String +Udid String + +## PARAMETERS + +### -AppleMdmId +. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XTotalCount +. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IAppleMdmDevice + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmEnrollmentProfile.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmEnrollmentProfile.md new file mode 100644 index 000000000..91079d518 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmEnrollmentProfile.md @@ -0,0 +1,103 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAppleMdmEnrollmentProfile.md +schema: 2.0.0 +--- + +# Get-JcSdkAppleMdmEnrollmentProfile + +## SYNOPSIS +Get a list of enrollment profiles for an apple mdm. + +Note: currently only one enrollment profile is supported. + +#### Sample Request +``` + curl https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/enrollmentprofiles \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +``` +Get-JcSdkAppleMdmEnrollmentProfile -ConsoleHost -AppleMdmId [] +``` + +## DESCRIPTION +Get a list of enrollment profiles for an apple mdm. + +Note: currently only one enrollment profile is supported. + +#### Sample Request +``` + curl https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/enrollmentprofiles \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkAppleMdmEnrollmentProfile -AppleMdmId 5ecfd88e63336c651d4f4n59 +``` + +Get a list of enrollment profiles for an apple mdm + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkAppleMdmEnrollmentProfile -AppleMdmId 5ecfd88e63336c651d4f4n59 -Id 5ecfd88e63336c651d4f4n60 +``` + +Get an enrollment profile by Id + +## PARAMETERS + +### -AppleMdmId +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IAppleMdm + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationAssociation.md new file mode 100644 index 000000000..2f483a775 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationAssociation.md @@ -0,0 +1,181 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationAssociation.md +schema: 2.0.0 +--- + +# Get-JcSdkApplicationAssociation + +## SYNOPSIS +This endpoint will return the _direct_ associations of an Application. +A direct association can be a non-homogeneous relationship between 2 different objects, for example Applications and User Groups. + + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations?targets=user_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkApplicationAssociation -ConsoleHost -ApplicationId -Targets + [] +``` + +### GetViaIdentity +``` +Get-JcSdkApplicationAssociation -ConsoleHost -InputObject -Targets + [] +``` + +## DESCRIPTION +This endpoint will return the _direct_ associations of an Application. +A direct association can be a non-homogeneous relationship between 2 different objects, for example Applications and User Groups. + + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations?targets=user_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkApplicationAssociation -ApplicationId:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ApplicationId +ObjectID of the Application. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Targets +Targets which a "active_directory" can be associated to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphConnection + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUser.md new file mode 100644 index 000000000..af67d5641 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUser.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUser.md +schema: 2.0.0 +--- + +# Get-JcSdkApplicationTraverseUser + +## SYNOPSIS +This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkApplicationTraverseUser -ConsoleHost -ApplicationId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkApplicationTraverseUser -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkApplicationTraverseUser -ApplicationId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ApplicationId +ObjectID of the Application. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUserGroup.md new file mode 100644 index 000000000..87e4c13ff --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUserGroup.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApplicationTraverseUserGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkApplicationTraverseUserGroup + +## SYNOPSIS +This endpoint will return all Users Groups bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Application to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Application. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/usergroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkApplicationTraverseUserGroup -ConsoleHost -ApplicationId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkApplicationTraverseUserGroup -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Users Groups bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Application to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Application. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/usergroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkApplicationTraverseUserGroup -ApplicationId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ApplicationId +ObjectID of the Application. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlow.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlow.md new file mode 100644 index 000000000..d830b2aff --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlow.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlow.md +schema: 2.0.0 +--- + +# Get-JcSdkApprovalFlow + +## SYNOPSIS +Endpoint for getting workflow by id + +## SYNTAX + +### List (Default) +``` +Get-JcSdkApprovalFlow -ConsoleHost [-Fields >] [-Filter >] + [-OrganizationObjectId ] [-Sort ] [] +``` + +### Get +``` +Get-JcSdkApprovalFlow -ConsoleHost -ApprovalFlowId [-OrganizationObjectId ] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkApprovalFlow -ConsoleHost -InputObject + [-OrganizationObjectId ] [] +``` + +## DESCRIPTION +Endpoint for getting workflow by id + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkApprovalFlow -ApprovalFlowId:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkApprovalFlow -Fields:() -Filter:() -Sort:() +``` + + + +## PARAMETERS + +### -ApprovalFlowId +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OrganizationObjectId +. + +```yaml +Type: System.Byte[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IJumpcloudIngressoAccessWorkflow + +### JumpCloud.SDK.V2.Models.IJumpcloudIngressoGetAllAccessWorkFlowsResponse + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlowSetting.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlowSetting.md new file mode 100644 index 000000000..bd330af92 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlowSetting.md @@ -0,0 +1,76 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkApprovalFlowSetting.md +schema: 2.0.0 +--- + +# Get-JcSdkApprovalFlowSetting + +## SYNOPSIS +Endpoint for getting workflow settings for an organisation + +## SYNTAX + +``` +Get-JcSdkApprovalFlowSetting -ConsoleHost [-OrganizationObjectId ] [] +``` + +## DESCRIPTION +Endpoint for getting workflow settings for an organisation + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkApprovalFlowSetting +``` + + + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationObjectId +. + +```yaml +Type: System.Byte[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IJumpcloudIngressoAccessWorkflowSettings + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAuthenticationPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAuthenticationPolicy.md new file mode 100644 index 000000000..5e015893b --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAuthenticationPolicy.md @@ -0,0 +1,248 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkAuthenticationPolicy.md +schema: 2.0.0 +--- + +# Get-JcSdkAuthenticationPolicy + +## SYNOPSIS +Return a specific authentication policy. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkAuthenticationPolicy -ConsoleHost [-Filter >] [-Sort >] + [-XTotalCount ] [] +``` + +### Get +``` +Get-JcSdkAuthenticationPolicy -ConsoleHost -Id [] +``` + +### GetViaIdentity +``` +Get-JcSdkAuthenticationPolicy -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +Return a specific authentication policy. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkAuthenticationPolicy -Filter:() -Sort:() -XTotalCount:() +``` + +---- ---------- +Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions +Description String +Disabled Boolean +EffectAction String +Id String +MfaRequired Boolean +Name String +TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] +Type String +UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserGroupExclusions String +UserGroupInclusions String +UserInclusions String +UserVerificationRequirement String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkAuthenticationPolicy -Id:() +``` + +---- ---------- +Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions +Description String +Disabled Boolean +EffectAction String +Id String +MfaRequired Boolean +Name String +TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] +Type String +UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserGroupExclusions String +UserGroupInclusions String +UserInclusions String +UserVerificationRequirement String + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Unique identifier of the authentication policy + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XTotalCount +. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IAuthnPolicy + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUserState.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUserState.md new file mode 100644 index 000000000..2d43f59d2 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUserState.md @@ -0,0 +1,129 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUserState.md +schema: 2.0.0 +--- + +# Get-JcSdkBulkUserState + +## SYNOPSIS +The endpoint allows you to list scheduled statechange jobs. +#### Sample Request +``` +curl -X GET \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ + -H 'x-api-key: {API_KEY}' \\ + -H 'Content-Type: application/json' \\ + -H 'Accept: application/json' +``` + +## SYNTAX + +``` +Get-JcSdkBulkUserState -ConsoleHost [-Filter >] [-Userid ] [] +``` + +## DESCRIPTION +The endpoint allows you to list scheduled statechange jobs. +#### Sample Request +``` +curl -X GET \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ + -H 'x-api-key: {API_KEY}' \\ + -H 'Content-Type: application/json' \\ + -H 'Accept: application/json' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkBulkUserState +``` + +---- ---------- +ScheduledDate String +ScheduledJobId String +State String +SystemUserId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Userid +The systemuser id to filter by. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IScheduledUserstateResult + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUsersResult.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUsersResult.md new file mode 100644 index 000000000..432be9818 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUsersResult.md @@ -0,0 +1,162 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkBulkUsersResult.md +schema: 2.0.0 +--- + +# Get-JcSdkBulkUsersResult + +## SYNOPSIS +This endpoint will return the results of particular user import or get job request. + +#### Sample Request +``` +curl -X GET \\ + https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkBulkUsersResult -ConsoleHost -JobId [] +``` + +### GetViaIdentity +``` +Get-JcSdkBulkUsersResult -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint will return the results of particular user import or get job request. + +#### Sample Request +``` +curl -X GET \\ + https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkBulkUsersResult -JobId:() +``` + +---- ---------- +CreatedAt String +Id String +Meta JumpCloud.SDK.V2.Models.JobWorkresultMeta +PersistedFields JumpCloud.SDK.V2.Models.JobWorkresultPersistedFields +Status String +StatusMsg String +UpdatedAt String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobId +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IJobWorkresult + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandAssociation.md new file mode 100644 index 000000000..c414ed439 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandAssociation.md @@ -0,0 +1,182 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandAssociation.md +schema: 2.0.0 +--- + +# Get-JcSdkCommandAssociation + +## SYNOPSIS +This endpoint will return the _direct_ associations of this Command. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations?targets=system_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkCommandAssociation -ConsoleHost -CommandId -Targets [] +``` + +### GetViaIdentity +``` +Get-JcSdkCommandAssociation -ConsoleHost -InputObject -Targets + [] +``` + +## DESCRIPTION +This endpoint will return the _direct_ associations of this Command. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations?targets=system_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkCommandAssociation -CommandId:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -CommandId +ObjectID of the Command. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Targets +Targets which a "active_directory" can be associated to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphConnection + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystem.md new file mode 100644 index 000000000..52e9960f9 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystem.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystem.md +schema: 2.0.0 +--- + +# Get-JcSdkCommandTraverseSystem + +## SYNOPSIS +This endpoint will return all Systems bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Command to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Command. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systems \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkCommandTraverseSystem -ConsoleHost -CommandId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkCommandTraverseSystem -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Systems bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Command to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Command. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systems \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkCommandTraverseSystem -CommandId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -CommandId +ObjectID of the Command. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystemGroup.md new file mode 100644 index 000000000..212613c1d --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystemGroup.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCommandTraverseSystemGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkCommandTraverseSystemGroup + +## SYNOPSIS +This endpoint will return all System Groups bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Command to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Command. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systemgroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkCommandTraverseSystemGroup -ConsoleHost -CommandId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkCommandTraverseSystemGroup -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all System Groups bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Command to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Command. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systemgroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkCommandTraverseSystemGroup -CommandId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -CommandId +ObjectID of the Command. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailConfiguration.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailConfiguration.md new file mode 100644 index 000000000..352dd2992 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailConfiguration.md @@ -0,0 +1,146 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailConfiguration.md +schema: 2.0.0 +--- + +# Get-JcSdkCustomEmailConfiguration + +## SYNOPSIS +Get the custom email configuration for the specified custom email type + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkCustomEmailConfiguration -ConsoleHost -CustomEmailType [] +``` + +### GetViaIdentity +``` +Get-JcSdkCustomEmailConfiguration -ConsoleHost -InputObject + [] +``` + +## DESCRIPTION +Get the custom email configuration for the specified custom email type + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkCustomEmailConfiguration -CustomEmailType:() +``` + +---- ---------- +Body String +Button String +Header String +Id String +NextStepContactInfo String +Subject String +Title String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomEmailType +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ICustomEmail + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailTemplate.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailTemplate.md new file mode 100644 index 000000000..4d76a640b --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailTemplate.md @@ -0,0 +1,72 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkCustomEmailTemplate.md +schema: 2.0.0 +--- + +# Get-JcSdkCustomEmailTemplate + +## SYNOPSIS +Get the list of custom email templates + +## SYNTAX + +``` +Get-JcSdkCustomEmailTemplate -ConsoleHost [] +``` + +## DESCRIPTION +Get the list of custom email templates + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkCustomEmailTemplate +``` + +---- ---------- +Description String +DisplayName String +Fields JumpCloud.SDK.V2.Models.CustomEmailTemplateField[] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ICustomEmailTemplate + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDirectory.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDirectory.md new file mode 100644 index 000000000..15ebdf09b --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDirectory.md @@ -0,0 +1,122 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDirectory.md +schema: 2.0.0 +--- + +# Get-JcSdkDirectory + +## SYNOPSIS +This endpoint returns all active directories (LDAP, O365 Suite, G-Suite). + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/directories \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +``` +Get-JcSdkDirectory -ConsoleHost [-Fields >] [-Sort >] [] +``` + +## DESCRIPTION +This endpoint returns all active directories (LDAP, O365 Suite, G-Suite). + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/directories \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkDirectory +``` + +---- ---------- +DefaultDomainDomain String +DefaultDomainId String +Id String +Name String +OAuthStatus JumpCloud.SDK.V2.Models.DirectoryOAuthStatus +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IDirectory + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoAccount.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoAccount.md new file mode 100644 index 000000000..d2dc9f049 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoAccount.md @@ -0,0 +1,162 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoAccount.md +schema: 2.0.0 +--- + +# Get-JcSdkDuoAccount + +## SYNOPSIS +This endpoint returns a specific Duo account. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkDuoAccount -ConsoleHost [] +``` + +### Get +``` +Get-JcSdkDuoAccount -ConsoleHost -Id [] +``` + +### GetViaIdentity +``` +Get-JcSdkDuoAccount -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint returns a specific Duo account. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkDuoAccount +``` + +---- ---------- +Id String +Name String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkDuoAccount -Id:() +``` + +---- ---------- +Id String +Name String + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of the Duo Account + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IDuoAccount + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoApplication.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoApplication.md new file mode 100644 index 000000000..2546fba24 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoApplication.md @@ -0,0 +1,181 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkDuoApplication.md +schema: 2.0.0 +--- + +# Get-JcSdkDuoApplication + +## SYNOPSIS +This endpoint returns a specific Duo application that is associated with the specified Duo account. + +#### Sample Request +``` + curl https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkDuoApplication -ConsoleHost -AccountId [] +``` + +### Get +``` +Get-JcSdkDuoApplication -ConsoleHost -AccountId -ApplicationId [] +``` + +### GetViaIdentity +``` +Get-JcSdkDuoApplication -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint returns a specific Duo application that is associated with the specified Duo account. + +#### Sample Request +``` + curl https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkDuoApplication -AccountId:() +``` + +---- ---------- +ApiHost String +Id String +IntegrationKey String +Name String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkDuoApplication -AccountId:() -ApplicationId:() +``` + +---- ---------- +ApiHost String +Id String +IntegrationKey String +Name String + +## PARAMETERS + +### -AccountId +. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IDuoApplication + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuite.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuite.md new file mode 100644 index 000000000..64f8ebf2a --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuite.md @@ -0,0 +1,162 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuite.md +schema: 2.0.0 +--- + +# Get-JcSdkGSuite + +## SYNOPSIS +This endpoint returns a specific G Suite. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkGSuite -ConsoleHost -Id [] +``` + +### GetViaIdentity +``` +Get-JcSdkGSuite -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint returns a specific G Suite. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkGSuite -Id:() +``` + +---- ---------- +DefaultDomainDomain String +DefaultDomainId String +GroupsEnabled Boolean +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Unique identifier of the GSuite. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGsuite + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteAssociation.md new file mode 100644 index 000000000..7d6c976be --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteAssociation.md @@ -0,0 +1,182 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteAssociation.md +schema: 2.0.0 +--- + +# Get-JcSdkGSuiteAssociation + +## SYNOPSIS +This endpoint returns the _direct_ associations of this G Suite instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. + + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations?targets=user_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkGSuiteAssociation -ConsoleHost -GsuiteId -Targets [] +``` + +### GetViaIdentity +``` +Get-JcSdkGSuiteAssociation -ConsoleHost -InputObject -Targets + [] +``` + +## DESCRIPTION +This endpoint returns the _direct_ associations of this G Suite instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. + + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations?targets=user_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkGSuiteAssociation -GsuiteId:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GsuiteId +ObjectID of the G Suite instance. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Targets +Targets which a "active_directory" can be associated to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphConnection + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTranslationRule.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTranslationRule.md new file mode 100644 index 000000000..33ed5816b --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTranslationRule.md @@ -0,0 +1,244 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTranslationRule.md +schema: 2.0.0 +--- + +# Get-JcSdkGSuiteTranslationRule + +## SYNOPSIS +This endpoint returns a specific translation rule for a specific G Suite instance. +These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. + +###### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkGSuiteTranslationRule -ConsoleHost -GsuiteId [-Fields >] + [-Filter >] [-Sort >] [] +``` + +### Get +``` +Get-JcSdkGSuiteTranslationRule -ConsoleHost -GsuiteId -Id [] +``` + +### GetViaIdentity +``` +Get-JcSdkGSuiteTranslationRule -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint returns a specific translation rule for a specific G Suite instance. +These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. + +###### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkGSuiteTranslationRule -GsuiteId:() -Fields:() -Filter:() -Sort:() +``` + +---- ---------- +BuiltIn String +Direction String +Id String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkGSuiteTranslationRule -GsuiteId:() -Id:() +``` + +---- ---------- +BuiltIn String +Direction String +Id String + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GsuiteId +. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGSuiteTranslationRule + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUser.md new file mode 100644 index 000000000..46210d1e2 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUser.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUser.md +schema: 2.0.0 +--- + +# Get-JcSdkGSuiteTraverseUser + +## SYNOPSIS +This endpoint will return all Users bound to a G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this G Suite instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this G Suite instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/users \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkGSuiteTraverseUser -ConsoleHost -GsuiteId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkGSuiteTraverseUser -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Users bound to a G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this G Suite instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this G Suite instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/users \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkGSuiteTraverseUser -GsuiteId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GsuiteId +ObjectID of the G Suite instance. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUserGroup.md new file mode 100644 index 000000000..a47cec523 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUserGroup.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteTraverseUserGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkGSuiteTraverseUserGroup + +## SYNOPSIS +This endpoint will return all User Groups bound to an G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this G Suite instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this G Suite instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSuite_ID}/usergroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkGSuiteTraverseUserGroup -ConsoleHost -GsuiteId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkGSuiteTraverseUserGroup -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all User Groups bound to an G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this G Suite instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this G Suite instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSuite_ID}/usergroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkGSuiteTraverseUserGroup -GsuiteId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GsuiteId +ObjectID of the G Suite instance. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteUsersToImport.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteUsersToImport.md new file mode 100644 index 000000000..40c43803c --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteUsersToImport.md @@ -0,0 +1,134 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGSuiteUsersToImport.md +schema: 2.0.0 +--- + +# Get-JcSdkGSuiteUsersToImport + +## SYNOPSIS +Lists G Suite users available for import. + +## SYNTAX + +``` +Get-JcSdkGSuiteUsersToImport -ConsoleHost -GsuiteId [-OrderBy ] [-Query ] + [-SortOrder ] [] +``` + +## DESCRIPTION +Lists G Suite users available for import. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkGSuiteUsersToImport +``` + +---- ---------- +NextPageToken String +Users JumpCloud.SDK.V2.Models.Get200ApplicationJsonPropertiesItemsItem[] + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GsuiteId +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderBy +Google Directory API sort field parameter. +See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +Google Directory API search parameter. +See https://developers.google.com/admin-sdk/directory/v1/guides/search-users. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortOrder +Google Directory API sort direction parameter. +See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPathsC7Pl4LGsuitesGsuiteIdImportUsersGetResponses200ContentApplicationJsonSchema + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGroup.md new file mode 100644 index 000000000..f2d22da9e --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGroup.md @@ -0,0 +1,182 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkGroup + +## SYNOPSIS +This endpoint returns all Groups that exist in your organization. + +#### Available filter fields: + - `name` + - `disabled` + - `type` + - `memberQueryErrorFlags` + +#### Sample Request + +``` + curl -X GET \\ + https://console.jumpcloud.com/api/v2/groups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +``` +Get-JcSdkGroup -ConsoleHost [-Fields >] [-Filter >] [-Sort >] + [-XUnfilteredTotalCount ] [] +``` + +## DESCRIPTION +This endpoint returns all Groups that exist in your organization. + +#### Available filter fields: + - `name` + - `disabled` + - `type` + - `memberQueryErrorFlags` + +#### Sample Request + +``` + curl -X GET \\ + https://console.jumpcloud.com/api/v2/groups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkGroup +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +Name String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XUnfilteredTotalCount +If provided in the request with any non-empty value, this header will be returned on the response populated with the total count of objects without filters taken into account + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGroup + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGsuiteUsersToImportFormatted.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGsuiteUsersToImportFormatted.md new file mode 100644 index 000000000..6e6bb818a --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGsuiteUsersToImportFormatted.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkGsuiteUsersToImportFormatted.md +schema: 2.0.0 +--- + +# Get-JcSdkGsuiteUsersToImportFormatted + +## SYNOPSIS +Lists available G Suite users for import, translated to the Jumpcloud user schema. + +## SYNTAX + +``` +Get-JcSdkGsuiteUsersToImportFormatted -ConsoleHost -GsuiteId [-AllowEmptyFields] + [-OrderBy ] [-Query ] [-SortOrder ] [] +``` + +## DESCRIPTION +Lists available G Suite users for import, translated to the Jumpcloud user schema. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkGsuiteUsersToImportFormatted +``` + +---- ---------- +NextPageToken String +Users JumpCloud.SDK.V2.Models.User[] + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -AllowEmptyFields +[EXPERIMENTAL] Allow empty fields of the user object to be sent in the response + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GsuiteId +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderBy +Google Directory API sort field parameter. +See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +Google Directory API search parameter. +See https://developers.google.com/admin-sdk/directory/v1/guides/search-users. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortOrder +Google Directory API sort direction parameter. +See https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPathsKa8FhwGsuitesGsuiteIdImportJumpcloudusersGetResponses200ContentApplicationJsonSchema + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkIPList.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkIPList.md new file mode 100644 index 000000000..4835b972d --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkIPList.md @@ -0,0 +1,226 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkIPList.md +schema: 2.0.0 +--- + +# Get-JcSdkIPList + +## SYNOPSIS +Return a specific IP list. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkIPList -ConsoleHost [-Filter >] [-Sort >] [-XTotalCount ] + [] +``` + +### Get +``` +Get-JcSdkIPList -ConsoleHost -Id [] +``` + +### GetViaIdentity +``` +Get-JcSdkIPList -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +Return a specific IP list. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkIPList -Filter:() -Sort:() -XTotalCount:() +``` + +---- ---------- +Description String +Id String +Ips String +Name String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkIPList -Id:() +``` + +---- ---------- +Description String +Id String +Ips String +Name String + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XTotalCount +. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IIPList + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServer.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServer.md new file mode 100644 index 000000000..447dd5134 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServer.md @@ -0,0 +1,229 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServer.md +schema: 2.0.0 +--- + +# Get-JcSdkLdapServer + +## SYNOPSIS +This endpoint returns a specific LDAP server. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkLdapServer -ConsoleHost [-Fields >] [-Filter >] + [-Sort >] [] +``` + +### Get +``` +Get-JcSdkLdapServer -ConsoleHost -Id [] +``` + +### GetViaIdentity +``` +Get-JcSdkLdapServer -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint returns a specific LDAP server. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkLdapServer -Fields:() -Filter:() -Sort:() +``` + +---- ---------- +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkLdapServer -Id:() +``` + +---- ---------- +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Unique identifier of the LDAP server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ILdapServer + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerAssociation.md new file mode 100644 index 000000000..cff658a15 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerAssociation.md @@ -0,0 +1,183 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerAssociation.md +schema: 2.0.0 +--- + +# Get-JcSdkLdapServerAssociation + +## SYNOPSIS +This endpoint returns the _direct_ associations of this LDAP Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. + +#### Sample Request + +``` + curl -X GET 'https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations?targets=user_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkLdapServerAssociation -ConsoleHost -LdapserverId -Targets + [] +``` + +### GetViaIdentity +``` +Get-JcSdkLdapServerAssociation -ConsoleHost -InputObject -Targets + [] +``` + +## DESCRIPTION +This endpoint returns the _direct_ associations of this LDAP Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. + +#### Sample Request + +``` + curl -X GET 'https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations?targets=user_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkLdapServerAssociation -LdapserverId:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LdapserverId +ObjectID of the LDAP Server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Targets +Targets which a "active_directory" can be associated to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphConnection + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerSambaDomain.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerSambaDomain.md new file mode 100644 index 000000000..3a00d205b --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerSambaDomain.md @@ -0,0 +1,242 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerSambaDomain.md +schema: 2.0.0 +--- + +# Get-JcSdkLdapServerSambaDomain + +## SYNOPSIS +This endpoint returns a specific samba domain for an LDAP server. + +##### Sample Request +``` +curl -X GET \\ + https://console.jumpcloud.com/api/v2/ldapservers/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkLdapServerSambaDomain -ConsoleHost -LdapserverId [-Fields >] + [-Filter >] [-Sort >] [] +``` + +### Get +``` +Get-JcSdkLdapServerSambaDomain -ConsoleHost -Id -LdapserverId [] +``` + +### GetViaIdentity +``` +Get-JcSdkLdapServerSambaDomain -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint returns a specific samba domain for an LDAP server. + +##### Sample Request +``` +curl -X GET \\ + https://console.jumpcloud.com/api/v2/ldapservers/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkLdapServerSambaDomain -LdapserverId:() -Fields:() -Filter:() -Sort:() +``` + +---- ---------- +Id String +Name String +Sid String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkLdapServerSambaDomain -LdapserverId:() -Id:() +``` + +---- ---------- +Id String +Name String +Sid String + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Unique identifier of the samba domain. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LdapserverId +Unique identifier of the LDAP server. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISambaDomain + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUser.md new file mode 100644 index 000000000..affa23518 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUser.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUser.md +schema: 2.0.0 +--- + +# Get-JcSdkLdapServerTraverseUser + +## SYNOPSIS +This endpoint will return all Users bound to an LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this LDAP server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this LDAP server instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkLdapServerTraverseUser -ConsoleHost -LdapserverId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkLdapServerTraverseUser -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Users bound to an LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this LDAP server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this LDAP server instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkLdapServerTraverseUser -LdapserverId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LdapserverId +ObjectID of the LDAP Server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUserGroup.md new file mode 100644 index 000000000..2147a8099 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUserGroup.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkLdapServerTraverseUserGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkLdapServerTraverseUserGroup + +## SYNOPSIS +This endpoint will return all Users Groups bound to a LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this LDAP server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this LDAP server instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkLdapServerTraverseUserGroup -ConsoleHost -LdapserverId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkLdapServerTraverseUserGroup -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Users Groups bound to a LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this LDAP server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this LDAP server instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkLdapServerTraverseUserGroup -LdapserverId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LdapserverId +ObjectID of the LDAP Server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkNextScheduledBulkUserState.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkNextScheduledBulkUserState.md new file mode 100644 index 000000000..3ac5945b1 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkNextScheduledBulkUserState.md @@ -0,0 +1,105 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkNextScheduledBulkUserState.md +schema: 2.0.0 +--- + +# Get-JcSdkNextScheduledBulkUserState + +## SYNOPSIS +This endpoint is used to lookup the next upcoming scheduled state change for each user in the +given list. +The users parameter is limited to 100 items per request. +The results are also limited +to 100 items. +This endpoint returns a max of 1 event per state per user. +For example, if a user +has 3 ACTIVATED events scheduled it will return the next upcoming activation event. +However, if a +user also has a SUSPENDED event scheduled along with the ACTIVATED events it will return the next +upcoming activation event _and_ the next upcoming suspension event. + +## SYNTAX + +``` +Get-JcSdkNextScheduledBulkUserState -ConsoleHost -Users > [] +``` + +## DESCRIPTION +This endpoint is used to lookup the next upcoming scheduled state change for each user in the +given list. +The users parameter is limited to 100 items per request. +The results are also limited +to 100 items. +This endpoint returns a max of 1 event per state per user. +For example, if a user +has 3 ACTIVATED events scheduled it will return the next upcoming activation event. +However, if a +user also has a SUSPENDED event scheduled along with the ACTIVATED events it will return the next +upcoming activation event _and_ the next upcoming suspension event. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkNextScheduledBulkUserState +``` + +---- ---------- +EventsCount Int +Results JumpCloud.SDK.V2.Models.ScheduledUserstateResult[] + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Users +A list of system user IDs, limited to 100 items. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPathsUbbqf1BulkUserstatesEventlistNextGetResponses200ContentApplicationJsonSchema + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365.md new file mode 100644 index 000000000..6f2b67492 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365.md @@ -0,0 +1,168 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365.md +schema: 2.0.0 +--- + +# Get-JcSdkOffice365 + +## SYNOPSIS +This endpoint returns a specific Office 365 instance. + +##### + +Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkOffice365 -ConsoleHost -Office365Id [] +``` + +### GetViaIdentity +``` +Get-JcSdkOffice365 -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint returns a specific Office 365 instance. + +##### + +Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkOffice365 -Office365Id:() +``` + +---- ---------- +DefaultDomainDomain String +DefaultDomainId String +GroupsEnabled Boolean +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Office365Id +ObjectID of the Office 365 instance. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IOffice365 + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365Association.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365Association.md new file mode 100644 index 000000000..e2904378f --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365Association.md @@ -0,0 +1,185 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365Association.md +schema: 2.0.0 +--- + +# Get-JcSdkOffice365Association + +## SYNOPSIS +This endpoint returns _direct_ associations of an Office 365 instance. + + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations?targets=user_group' \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkOffice365Association -ConsoleHost -Office365Id -Targets + [] +``` + +### GetViaIdentity +``` +Get-JcSdkOffice365Association -ConsoleHost -InputObject -Targets + [] +``` + +## DESCRIPTION +This endpoint returns _direct_ associations of an Office 365 instance. + + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations?targets=user_group' \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkOffice365Association -Office365Id:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Office365Id +ObjectID of the Office 365 instance. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Targets +Targets which a "active_directory" can be associated to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphConnection + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TranslationRule.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TranslationRule.md new file mode 100644 index 000000000..7bd960047 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TranslationRule.md @@ -0,0 +1,246 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TranslationRule.md +schema: 2.0.0 +--- + +# Get-JcSdkOffice365TranslationRule + +## SYNOPSIS +This endpoint returns a specific translation rule for a specific Office 365 instance. +These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. + +###### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkOffice365TranslationRule -ConsoleHost -Office365Id [-Fields >] + [-Filter >] [-Sort >] [] +``` + +### Get +``` +Get-JcSdkOffice365TranslationRule -ConsoleHost -Id -Office365Id + [] +``` + +### GetViaIdentity +``` +Get-JcSdkOffice365TranslationRule -ConsoleHost -InputObject + [] +``` + +## DESCRIPTION +This endpoint returns a specific translation rule for a specific Office 365 instance. +These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. + +###### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkOffice365TranslationRule -Office365Id:() -Fields:() -Filter:() -Sort:() +``` + +---- ---------- +BuiltIn String +Direction String +Id String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkOffice365TranslationRule -Office365Id:() -Id:() +``` + +---- ---------- +BuiltIn String +Direction String +Id String + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Office365Id +. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IOffice365TranslationRule + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUser.md new file mode 100644 index 000000000..c803af049 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUser.md @@ -0,0 +1,218 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUser.md +schema: 2.0.0 +--- + +# Get-JcSdkOffice365TraverseUser + +## SYNOPSIS +This endpoint will return all Users bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Office 365 instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Office 365 instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkOffice365TraverseUser -ConsoleHost -Office365Id [-Filter >] + [-SyncStatus] [] +``` + +### GetViaIdentity +``` +Get-JcSdkOffice365TraverseUser -ConsoleHost -InputObject + [-Filter >] [-SyncStatus] [] +``` + +## DESCRIPTION +This endpoint will return all Users bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Office 365 instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Office 365 instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkOffice365TraverseUser -Office365Id:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Office365Id +ObjectID of the Office 365 suite. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncStatus +Include sync status for users + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUserGroup.md new file mode 100644 index 000000000..62d6fa0b2 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUserGroup.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365TraverseUserGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkOffice365TraverseUserGroup + +## SYNOPSIS +This endpoint will return all Users Groups bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Office 365 instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Office 365 instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkOffice365TraverseUserGroup -ConsoleHost -Office365Id [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkOffice365TraverseUserGroup -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Users Groups bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Office 365 instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Office 365 instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkOffice365TraverseUserGroup -Office365Id:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Office365Id +ObjectID of the Office 365 suite. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365UsersToImport.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365UsersToImport.md new file mode 100644 index 000000000..552109d8c --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365UsersToImport.md @@ -0,0 +1,167 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOffice365UsersToImport.md +schema: 2.0.0 +--- + +# Get-JcSdkOffice365UsersToImport + +## SYNOPSIS +Lists Office 365 users available for import. + +## SYNTAX + +``` +Get-JcSdkOffice365UsersToImport -ConsoleHost -Office365Id [-Count] [-Filter ] + [-Orderby ] [-Search ] [-ConsistencyLevel ] [] +``` + +## DESCRIPTION +Lists Office 365 users available for import. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkOffice365UsersToImport +``` + +---- ---------- +SkipToken String +Top Int +Users JumpCloud.SDK.V2.Models.Paths1Hu9JikOffice365SOffice365IdImportUsersGetResponses200ContentApplicationJsonSchemaPropertiesUsersItem… + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsistencyLevel +Defines the consistency header for O365 requests. +See https://docs.microsoft.com/en-us/graph/api/user-list?view=graph-rest-1.0&tabs=http#request-headers + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Count +Office 365 API count parameter. +See https://docs.microsoft.com/en-us/graph/api/user-list?view=graph-rest-1.0&tabs=http#optional-query-parameters. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Office 365 API filter parameter. +See https://docs.microsoft.com/en-us/graph/api/user-list?view=graph-rest-1.0&tabs=http#optional-query-parameters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Office365Id +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Orderby +Office 365 API orderby parameter. +See https://docs.microsoft.com/en-us/graph/api/user-list?view=graph-rest-1.0&tabs=http#optional-query-parameters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Search +Office 365 API search parameter. +See https://docs.microsoft.com/en-us/graph/api/user-list?view=graph-rest-1.0&tabs=http#optional-query-parameters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPaths1J0ThkrOffice365SOffice365IdImportUsersGetResponses200ContentApplicationJsonSchema + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOrganizationPolicyResult.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOrganizationPolicyResult.md new file mode 100644 index 000000000..d3c2e2656 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOrganizationPolicyResult.md @@ -0,0 +1,158 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkOrganizationPolicyResult.md +schema: 2.0.0 +--- + +# Get-JcSdkOrganizationPolicyResult + +## SYNOPSIS +This endpoint returns all policy results for an organization. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## SYNTAX + +``` +Get-JcSdkOrganizationPolicyResult -ConsoleHost [-Fields >] [-Filter >] + [-Sort >] [] +``` + +## DESCRIPTION +This endpoint returns all policy results for an organization. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkOrganizationPolicyResult +``` + +---- ---------- +Detail String +EndedAt Datetime +ExitStatus System.Nullable[long] ExitStatus {get;set;} +Id String +PolicyId String +StartedAt Datetime +State String +StdErr String +StdOut String +Success Boolean +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPolicyResult + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicy.md new file mode 100644 index 000000000..e77480ae0 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicy.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicy.md +schema: 2.0.0 +--- + +# Get-JcSdkPolicy + +## SYNOPSIS +This endpoint returns a specific policy. + +###### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/policies/{PolicyID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkPolicy -ConsoleHost [-Fields >] [-Filter >] [-Sort >] + [] +``` + +### Get +``` +Get-JcSdkPolicy -ConsoleHost -Id [] +``` + +### GetViaIdentity +``` +Get-JcSdkPolicy -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint returns a specific policy. + +###### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/policies/{PolicyID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkPolicy -Fields:() -Filter:() -Sort:() +``` + +---- ---------- +Id String +Name String +TemplateActivation String +TemplateAlert String +TemplateBehavior String +TemplateDeliveryTypes String +TemplateDescription String +TemplateDisplayName String +TemplateId String +TemplateName String +TemplateOSMetaFamily String +TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] +TemplateReference String +TemplateState String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkPolicy -Id:() +``` + +---- ---------- +Id String +Name String +TemplateActivation String +TemplateAlert String +TemplateBehavior String +TemplateDeliveryTypes String +TemplateDescription String +TemplateDisplayName String +TemplateId String +TemplateName String +TemplateOSMetaFamily String +TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] +TemplateReference String +TemplateState String + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of the Policy object. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPolicy + +### JumpCloud.SDK.V2.Models.IPolicyWithDetails + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyAssociation.md new file mode 100644 index 000000000..b219d63fc --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyAssociation.md @@ -0,0 +1,180 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyAssociation.md +schema: 2.0.0 +--- + +# Get-JcSdkPolicyAssociation + +## SYNOPSIS +This endpoint returns the _direct_ associations of a Policy. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations?targets=system_group \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkPolicyAssociation -ConsoleHost -PolicyId -Targets [] +``` + +### GetViaIdentity +``` +Get-JcSdkPolicyAssociation -ConsoleHost -InputObject -Targets + [] +``` + +## DESCRIPTION +This endpoint returns the _direct_ associations of a Policy. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations?targets=system_group \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkPolicyAssociation -PolicyId:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PolicyId +ObjectID of the Policy. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Targets +Targets which a "active_directory" can be associated to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphConnection + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroup.md new file mode 100644 index 000000000..61c74eb9c --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroup.md @@ -0,0 +1,231 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkPolicyGroup + +## SYNOPSIS +This endpoint returns the details of a Policy Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkPolicyGroup -ConsoleHost [-Fields >] [-Filter >] + [-Sort >] [] +``` + +### Get +``` +Get-JcSdkPolicyGroup -ConsoleHost -Id [] +``` + +### GetViaIdentity +``` +Get-JcSdkPolicyGroup -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint returns the details of a Policy Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkPolicyGroup -Fields:() -Filter:() -Sort:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +Name String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkPolicyGroup -Id:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +Name String +Type String + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of the Policy Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPolicyGroup + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupAssociation.md new file mode 100644 index 000000000..d64e50f4e --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupAssociation.md @@ -0,0 +1,127 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupAssociation.md +schema: 2.0.0 +--- + +# Get-JcSdkPolicyGroupAssociation + +## SYNOPSIS +This endpoint returns the _direct_ associations of this Policy Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations?targets=system \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +``` +Get-JcSdkPolicyGroupAssociation -ConsoleHost -GroupId -Targets [] +``` + +## DESCRIPTION +This endpoint returns the _direct_ associations of this Policy Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations?targets=system \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkPolicyGroupAssociation +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the Policy Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Targets +Targets which a "active_directory" can be associated to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphConnection + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMember.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMember.md new file mode 100644 index 000000000..d5ae8b8f8 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMember.md @@ -0,0 +1,267 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMember.md +schema: 2.0.0 +--- + +# Get-JcSdkPolicyGroupMember + +## SYNOPSIS +This endpoint returns all the Policy Groups a Policy is a member of. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/memberof \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkPolicyGroupMember -ConsoleHost -PolicyId [-Filter >] + [-Sort >] [-Authorization ] [-Date ] [] +``` + +### GetViaIdentity +``` +Get-JcSdkPolicyGroupMember -ConsoleHost -InputObject [-Filter >] + [-Sort >] [-Authorization ] [-Date ] [] +``` + +### List +``` +Get-JcSdkPolicyGroupMember -ConsoleHost -GroupId [] +``` + +## DESCRIPTION +This endpoint returns all the Policy Groups a Policy is a member of. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/memberof \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkPolicyGroupMember -PolicyId:() -Filter:() -Sort:() -Authorization:() -Date:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkPolicyGroupMember -GroupId:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +## PARAMETERS + +### -Authorization +Authorization header for the System Context API + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Date +Current date header for the System Context API + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the Policy Group. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PolicyId +ObjectID of the Policy. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphConnection + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMembership.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMembership.md new file mode 100644 index 000000000..23aacfb9c --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMembership.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupMembership.md +schema: 2.0.0 +--- + +# Get-JcSdkPolicyGroupMembership + +## SYNOPSIS +This endpoint returns all Policy members that are a member of this Policy Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/membership \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkPolicyGroupMembership -ConsoleHost -GroupId [-Filter >] + [-Sort >] [] +``` + +### GetViaIdentity +``` +Get-JcSdkPolicyGroupMembership -ConsoleHost -InputObject + [-Filter >] [-Sort >] [] +``` + +## DESCRIPTION +This endpoint returns all Policy members that are a member of this Policy Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/membership \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkPolicyGroupMembership -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the Policy Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystem.md new file mode 100644 index 000000000..97fdc534a --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystem.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystem.md +schema: 2.0.0 +--- + +# Get-JcSdkPolicyGroupTraverseSystem + +## SYNOPSIS +This endpoint will return all Systems bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkPolicyGroupTraverseSystem -ConsoleHost -GroupId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkPolicyGroupTraverseSystem -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Systems bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkPolicyGroupTraverseSystem -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the Policy Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystemGroup.md new file mode 100644 index 000000000..d7b0f8bfb --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystemGroup.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyGroupTraverseSystemGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkPolicyGroupTraverseSystemGroup + +## SYNOPSIS +This endpoint will return all System Groups bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkPolicyGroupTraverseSystemGroup -ConsoleHost -GroupId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkPolicyGroupTraverseSystemGroup -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all System Groups bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkPolicyGroupTraverseSystemGroup -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the Policy Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyResult.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyResult.md new file mode 100644 index 000000000..707fdc975 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyResult.md @@ -0,0 +1,256 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyResult.md +schema: 2.0.0 +--- + +# Get-JcSdkPolicyResult + +## SYNOPSIS +This endpoint will return the policy results for a specific policy. + +##### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policyresults/{Policy_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkPolicyResult -ConsoleHost -Id [] +``` + +### GetViaIdentity +``` +Get-JcSdkPolicyResult -ConsoleHost -InputObject [] +``` + +### List +``` +Get-JcSdkPolicyResult -ConsoleHost -PolicyId [-Fields >] + [-Filter >] [-Sort >] [] +``` + +## DESCRIPTION +This endpoint will return the policy results for a specific policy. + +##### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policyresults/{Policy_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkPolicyResult -Id:() +``` + +---- ---------- +Detail String +EndedAt Datetime +ExitStatus System.Nullable[long] ExitStatus {get;set;} +Id String +PolicyId String +StartedAt Datetime +State String +StdErr String +StdOut String +Success Boolean +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkPolicyResult -PolicyId:() -Fields:() -Filter:() -Sort:() +``` + +---- ---------- +Detail String +EndedAt Datetime +ExitStatus System.Nullable[long] ExitStatus {get;set;} +Id String +PolicyId String +StartedAt Datetime +State String +StdErr String +StdOut String +Success Boolean +SystemId String + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of the Policy Result. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PolicyId +. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPolicyResult + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyStatus.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyStatus.md new file mode 100644 index 000000000..3fe36462c --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyStatus.md @@ -0,0 +1,173 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyStatus.md +schema: 2.0.0 +--- + +# Get-JcSdkPolicyStatus + +## SYNOPSIS +This endpoint returns the latest policy results for a specific policy. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## SYNTAX + +``` +Get-JcSdkPolicyStatus -ConsoleHost -PolicyId [-Fields >] + [-Filter >] [-Sort >] [] +``` + +## DESCRIPTION +This endpoint returns the latest policy results for a specific policy. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkPolicyStatus +``` + +---- ---------- +Detail String +EndedAt Datetime +ExitStatus System.Nullable[long] ExitStatus {get;set;} +Id String +PolicyId String +StartedAt Datetime +State String +StdErr String +StdOut String +Success Boolean +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPolicyResult + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTemplate.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTemplate.md new file mode 100644 index 000000000..63d3f456c --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTemplate.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTemplate.md +schema: 2.0.0 +--- + +# Get-JcSdkPolicyTemplate + +## SYNOPSIS +This endpoint returns a specific policy template. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/policytemplates/{Policy_Template_ID}\\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkPolicyTemplate -ConsoleHost [-Fields >] [-Filter >] + [-Sort >] [] +``` + +### Get +``` +Get-JcSdkPolicyTemplate -ConsoleHost -Id [] +``` + +### GetViaIdentity +``` +Get-JcSdkPolicyTemplate -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint returns a specific policy template. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/policytemplates/{Policy_Template_ID}\\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkPolicyTemplate -Fields:() -Filter:() -Sort:() +``` + +---- ---------- +Activation String +Alert String +Behavior String +DeliveryTypes String +Description String +DisplayName String +Id String +Name String +OSMetaFamily String +OSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] +Reference String +State String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkPolicyTemplate -Id:() +``` + +---- ---------- +Activation String +Alert String +Behavior String +DeliveryTypes String +Description String +DisplayName String +Id String +Name String +OSMetaFamily String +OSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] +Reference String +State String + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of the Policy Template. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPolicyTemplate + +### JumpCloud.SDK.V2.Models.IPolicyTemplateWithDetails + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystem.md new file mode 100644 index 000000000..d364a01a7 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystem.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystem.md +schema: 2.0.0 +--- + +# Get-JcSdkPolicyTraverseSystem + +## SYNOPSIS +This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkPolicyTraverseSystem -ConsoleHost -PolicyId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkPolicyTraverseSystem -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkPolicyTraverseSystem -PolicyId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PolicyId +ObjectID of the Command. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystemGroup.md new file mode 100644 index 000000000..6e9197fac --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystemGroup.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkPolicyTraverseSystemGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkPolicyTraverseSystemGroup + +## SYNOPSIS +This endpoint will return all Systems Groups bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkPolicyTraverseSystemGroup -ConsoleHost -PolicyId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkPolicyTraverseSystemGroup -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Systems Groups bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkPolicyTraverseSystemGroup -PolicyId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PolicyId +ObjectID of the Command. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderAdministrator.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderAdministrator.md new file mode 100644 index 000000000..381b450f9 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderAdministrator.md @@ -0,0 +1,164 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderAdministrator.md +schema: 2.0.0 +--- + +# Get-JcSdkProviderAdministrator + +## SYNOPSIS +This endpoint returns a list of the Administrators associated with the Provider. +You must be associated with the provider to use this route. + +## SYNTAX + +``` +Get-JcSdkProviderAdministrator -ConsoleHost -ProviderId [-Fields >] + [-Filter >] [-Sort >] [-SortIgnoreCase >] [] +``` + +## DESCRIPTION +This endpoint returns a list of the Administrators associated with the Provider. +You must be associated with the provider to use this route. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkProviderAdministrator +``` + +---- ---------- +Results JumpCloud.SDK.V2.Models.Administrator[] +TotalCount Int + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderId +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortIgnoreCase +The comma separated fields used to sort the collection, ignoring case. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPathsYwlyndProvidersProviderIdAdministratorsGetResponses200ContentApplicationJsonSchema + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderOrganization.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderOrganization.md new file mode 100644 index 000000000..fb7ae88fa --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderOrganization.md @@ -0,0 +1,164 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProviderOrganization.md +schema: 2.0.0 +--- + +# Get-JcSdkProviderOrganization + +## SYNOPSIS +This endpoint returns a list of the Organizations associated with the Provider. +You must be associated with the provider to use this route. + +## SYNTAX + +``` +Get-JcSdkProviderOrganization -ConsoleHost -ProviderId [-Fields >] + [-Filter >] [-Sort >] [-SortIgnoreCase >] [] +``` + +## DESCRIPTION +This endpoint returns a list of the Organizations associated with the Provider. +You must be associated with the provider to use this route. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkProviderOrganization +``` + +---- ---------- +Results JumpCloud.SDK.V2.Models.Organization[] +TotalCount Int + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderId +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortIgnoreCase +The comma separated fields used to sort the collection, ignoring case. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPaths1O3J7V8ProvidersProviderIdOrganizationsGetResponses200ContentApplicationJsonSchema + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProvidersInvoice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProvidersInvoice.md new file mode 100644 index 000000000..37b7479f3 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProvidersInvoice.md @@ -0,0 +1,187 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkProvidersInvoice.md +schema: 2.0.0 +--- + +# Get-JcSdkProvidersInvoice + +## SYNOPSIS +Retrieves a list of invoices for this provider. +You must be associated to the provider to use this endpoint. + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkProvidersInvoice -ConsoleHost -ProviderId [-Filter >] + [-Sort >] [] +``` + +### GetViaIdentity +``` +Get-JcSdkProvidersInvoice -ConsoleHost -InputObject [-Filter >] + [-Sort >] [] +``` + +## DESCRIPTION +Retrieves a list of invoices for this provider. +You must be associated to the provider to use this endpoint. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkProvidersInvoice -ProviderId:() +``` + +---- ---------- +Records JumpCloud.SDK.V2.Models.ProviderInvoice[] +TotalCount Int + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProviderId +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IProviderInvoiceResponse + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerAssociation.md new file mode 100644 index 000000000..d3300c760 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerAssociation.md @@ -0,0 +1,181 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerAssociation.md +schema: 2.0.0 +--- + +# Get-JcSdkRadiusServerAssociation + +## SYNOPSIS +This endpoint returns the _direct_ associations of a Radius Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations?targets=user_group \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkRadiusServerAssociation -ConsoleHost -RadiusserverId -Targets + [] +``` + +### GetViaIdentity +``` +Get-JcSdkRadiusServerAssociation -ConsoleHost -InputObject -Targets + [] +``` + +## DESCRIPTION +This endpoint returns the _direct_ associations of a Radius Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations?targets=user_group \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkRadiusServerAssociation -RadiusserverId:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RadiusserverId +ObjectID of the Radius Server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Targets +Targets which a "active_directory" can be associated to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphConnection + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUser.md new file mode 100644 index 000000000..b3c601121 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUser.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUser.md +schema: 2.0.0 +--- + +# Get-JcSdkRadiusServerTraverseUser + +## SYNOPSIS +This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. + +See `/members` and `/associations` endpoints to manage those collections. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkRadiusServerTraverseUser -ConsoleHost -RadiusserverId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkRadiusServerTraverseUser -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. + +See `/members` and `/associations` endpoints to manage those collections. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkRadiusServerTraverseUser -RadiusserverId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RadiusserverId +ObjectID of the Radius Server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUserGroup.md new file mode 100644 index 000000000..92d72ecf4 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUserGroup.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkRadiusServerTraverseUserGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkRadiusServerTraverseUserGroup + +## SYNOPSIS +This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkRadiusServerTraverseUserGroup -ConsoleHost -RadiusserverId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkRadiusServerTraverseUserGroup -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkRadiusServerTraverseUserGroup -RadiusserverId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RadiusserverId +ObjectID of the Radius Server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareApp.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareApp.md new file mode 100644 index 000000000..2177b96fa --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareApp.md @@ -0,0 +1,211 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareApp.md +schema: 2.0.0 +--- + +# Get-JcSdkSoftwareApp + +## SYNOPSIS +Retrieves a Software Application. +The optional isConfigEnabled and appConfiguration apple_vpp attributes are populated in this response. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkSoftwareApp -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +### Get +``` +Get-JcSdkSoftwareApp -ConsoleHost -Id [] +``` + +### GetViaIdentity +``` +Get-JcSdkSoftwareApp -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +Retrieves a Software Application. +The optional isConfigEnabled and appConfiguration apple_vpp attributes are populated in this response. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSoftwareApp -Filter:() -Sort:() +``` + +---- ---------- +DisplayName String +Id String +Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkSoftwareApp -Id:() +``` + +---- ---------- +DisplayName String +Id String +Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISoftwareApp + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppAssociation.md new file mode 100644 index 000000000..f670194ec --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppAssociation.md @@ -0,0 +1,181 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppAssociation.md +schema: 2.0.0 +--- + +# Get-JcSdkSoftwareAppAssociation + +## SYNOPSIS +This endpoint will return the _direct_ associations of a Software Application. +A direct association can be a non-homogeneous relationship between 2 different objects, for example Software Application and System Groups. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations?targets=system_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSoftwareAppAssociation -ConsoleHost -SoftwareAppId -Targets + [] +``` + +### GetViaIdentity +``` +Get-JcSdkSoftwareAppAssociation -ConsoleHost -InputObject -Targets + [] +``` + +## DESCRIPTION +This endpoint will return the _direct_ associations of a Software Application. +A direct association can be a non-homogeneous relationship between 2 different objects, for example Software Application and System Groups. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations?targets=system_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSoftwareAppAssociation -SoftwareAppId:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SoftwareAppId +ObjectID of the Software App. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Targets +Targets which a "active_directory" can be associated to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphConnection + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppStatus.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppStatus.md new file mode 100644 index 000000000..3dfb84a30 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppStatus.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppStatus.md +schema: 2.0.0 +--- + +# Get-JcSdkSoftwareAppStatus + +## SYNOPSIS +This endpoint allows you to get the status of the provided Software Application on associated JumpCloud systems. + +#### Sample Request +``` +$ curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/statuses \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSoftwareAppStatus -ConsoleHost -SoftwareAppId [-Filter >] + [-Sort >] [] +``` + +### GetViaIdentity +``` +Get-JcSdkSoftwareAppStatus -ConsoleHost -InputObject [-Filter >] + [-Sort >] [] +``` + +## DESCRIPTION +This endpoint allows you to get the status of the provided Software Application on associated JumpCloud systems. + +#### Sample Request +``` +$ curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/statuses \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSoftwareAppStatus -SoftwareAppId:() +``` + +---- ---------- +Code Int +Details String +Id String +SoftwareAppId String +State String +SystemId String +Timestamp String +Version String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SoftwareAppId +ObjectID of the Software App. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISoftwareAppStatus + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystem.md new file mode 100644 index 000000000..06ae2fce9 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystem.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystem.md +schema: 2.0.0 +--- + +# Get-JcSdkSoftwareAppTraverseSystem + +## SYNOPSIS +This endpoint will return all Systems bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Software App to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Software App. + +See `/associations` endpoint to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSoftwareAppTraverseSystem -ConsoleHost -SoftwareAppId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkSoftwareAppTraverseSystem -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Systems bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Software App to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Software App. + +See `/associations` endpoint to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSoftwareAppTraverseSystem -SoftwareAppId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SoftwareAppId +ObjectID of the Software App. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystemGroup.md new file mode 100644 index 000000000..1b8fcafac --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystemGroup.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSoftwareAppTraverseSystemGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkSoftwareAppTraverseSystemGroup + +## SYNOPSIS +This endpoint will return all Systems Groups bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Software App to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Software App. + +See `/associations` endpoint to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSoftwareAppTraverseSystemGroup -ConsoleHost -SoftwareAppId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkSoftwareAppTraverseSystemGroup -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Systems Groups bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Software App to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Software App. + +See `/associations` endpoint to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSoftwareAppTraverseSystemGroup -SoftwareAppId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SoftwareAppId +ObjectID of the Software App. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSubscription.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSubscription.md new file mode 100644 index 000000000..22b176bcf --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSubscription.md @@ -0,0 +1,92 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSubscription.md +schema: 2.0.0 +--- + +# Get-JcSdkSubscription + +## SYNOPSIS +This endpoint returns all pricing & packaging subscriptions. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/subscriptions \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## SYNTAX + +``` +Get-JcSdkSubscription -ConsoleHost [] +``` + +## DESCRIPTION +This endpoint returns all pricing & packaging subscriptions. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/subscriptions \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSubscription +``` + +---- ---------- +AnnualPrice float AnnualPrice {get;set;} +DisplayName String +Features JumpCloud.SDK.V2.Models.Feature[] +ListPrice float ListPrice {get;set;} +ProductCode String +UpgradeRecommendation String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISubscription + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemAssociation.md new file mode 100644 index 000000000..55aa2e4e1 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemAssociation.md @@ -0,0 +1,215 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemAssociation.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemAssociation + +## SYNOPSIS +This endpoint returns the _direct_ associations of a System. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations?targets=user \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSystemAssociation -ConsoleHost -SystemId -Targets + [-Authorization ] [-Date ] [] +``` + +### GetViaIdentity +``` +Get-JcSdkSystemAssociation -ConsoleHost -InputObject -Targets + [-Authorization ] [-Date ] [] +``` + +## DESCRIPTION +This endpoint returns the _direct_ associations of a System. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations?targets=user \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemAssociation -SystemId:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -Authorization +Authorization header for the System Context API + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Date +Current date header for the System Context API + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SystemId +ObjectID of the System. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Targets +Targets which a "active_directory" can be associated to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphConnection + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemFdeKey.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemFdeKey.md new file mode 100644 index 000000000..87c6d84f1 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemFdeKey.md @@ -0,0 +1,137 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemFdeKey.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemFdeKey + +## SYNOPSIS +This endpoint will return the current (latest) fde key saved for a system. + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSystemFdeKey -ConsoleHost -SystemId [] +``` + +### GetViaIdentity +``` +Get-JcSdkSystemFdeKey -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint will return the current (latest) fde key saved for a system. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemFdeKey -SystemId:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SystemId +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemfdekey + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroup.md new file mode 100644 index 000000000..0e54ebb31 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroup.md @@ -0,0 +1,241 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemGroup + +## SYNOPSIS +This endpoint returns the details of a System Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkSystemGroup -ConsoleHost [-Fields >] [-Filter >] + [-Sort >] [] +``` + +### Get +``` +Get-JcSdkSystemGroup -ConsoleHost -Id [] +``` + +### GetViaIdentity +``` +Get-JcSdkSystemGroup -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint returns the details of a System Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemGroup -Fields:() -Filter:() -Sort:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkSystemGroup -Id:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +Type String + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of the System Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemGroup + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupAssociation.md new file mode 100644 index 000000000..7e9d843f1 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupAssociation.md @@ -0,0 +1,182 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupAssociation.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemGroupAssociation + +## SYNOPSIS +This endpoint returns the _direct_ associations of a System Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations?targets=user \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSystemGroupAssociation -ConsoleHost -GroupId -Targets [] +``` + +### GetViaIdentity +``` +Get-JcSdkSystemGroupAssociation -ConsoleHost -InputObject -Targets + [] +``` + +## DESCRIPTION +This endpoint returns the _direct_ associations of a System Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations?targets=user \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemGroupAssociation -GroupId:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the System Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Targets +Targets which a "active_directory" can be associated to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphConnection + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMember.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMember.md new file mode 100644 index 000000000..4ebd45950 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMember.md @@ -0,0 +1,162 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMember.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemGroupMember + +## SYNOPSIS +This endpoint returns the system members of a System Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSystemGroupMember -ConsoleHost -GroupId [] +``` + +### GetViaIdentity +``` +Get-JcSdkSystemGroupMember -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint returns the system members of a System Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemGroupMember -GroupId:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the System Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphConnection + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMembership.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMembership.md new file mode 100644 index 000000000..890b0672c --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMembership.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupMembership.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemGroupMembership + +## SYNOPSIS +This endpoint returns all Systems that are a member of this System Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID/membership \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSystemGroupMembership -ConsoleHost -GroupId [-Filter >] + [-Sort >] [] +``` + +### GetViaIdentity +``` +Get-JcSdkSystemGroupMembership -ConsoleHost -InputObject + [-Filter >] [-Sort >] [] +``` + +## DESCRIPTION +This endpoint returns all Systems that are a member of this System Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID/membership \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemGroupMembership -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the System Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseCommand.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseCommand.md new file mode 100644 index 000000000..6f3bfe92f --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseCommand.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseCommand.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemGroupTraverseCommand + +## SYNOPSIS +This endpoint will return all Commands bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/commands \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSystemGroupTraverseCommand -ConsoleHost -GroupId [-Details ] + [-Filter >] [] +``` + +### GetViaIdentity +``` +Get-JcSdkSystemGroupTraverseCommand -ConsoleHost -InputObject + [-Details ] [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Commands bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/commands \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemGroupTraverseCommand -GroupId:() +``` + +---- ---------- +Command String +CommandType String +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +LaunchType String +Name String +Organization String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Schedule String +ScheduleRepeatType String +Timeout String +TimeToLiveSeconds Int +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Details +This will provide detail descriptive response for the request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the System Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ICommandsGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicy.md new file mode 100644 index 000000000..1ea167bf0 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicy.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicy.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemGroupTraversePolicy + +## SYNOPSIS +This endpoint will return all Policies bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +This endpoint is not public yet as we haven't finished the code. + +##### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policies \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSystemGroupTraversePolicy -ConsoleHost -GroupId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkSystemGroupTraversePolicy -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Policies bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +This endpoint is not public yet as we haven't finished the code. + +##### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policies \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemGroupTraversePolicy -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the System Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicyGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicyGroup.md new file mode 100644 index 000000000..9490cdc6b --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicyGroup.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraversePolicyGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemGroupTraversePolicyGroup + +## SYNOPSIS +This endpoint will return all Policy Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policygroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSystemGroupTraversePolicyGroup -ConsoleHost -GroupId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkSystemGroupTraversePolicyGroup -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Policy Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policygroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemGroupTraversePolicyGroup -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the System Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUser.md new file mode 100644 index 000000000..6fa519183 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUser.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUser.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemGroupTraverseUser + +## SYNOPSIS +This endpoint will return all Users bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSystemGroupTraverseUser -ConsoleHost -GroupId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkSystemGroupTraverseUser -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Users bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemGroupTraverseUser -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the System Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUserGroup.md new file mode 100644 index 000000000..fc73b908f --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUserGroup.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemGroupTraverseUserGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemGroupTraverseUserGroup + +## SYNOPSIS +This endpoint will return all User Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSystemGroupTraverseUserGroup -ConsoleHost -GroupId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkSystemGroupTraverseUserGroup -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all User Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemGroupTraverseUserGroup -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the System Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlf.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlf.md new file mode 100644 index 000000000..a25f023c2 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlf.md @@ -0,0 +1,122 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlf.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightAlf + +## SYNOPSIS +Valid filter fields are `system_id` and `global_state`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightAlf -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `global_state`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightAlf +``` + +---- ---------- +AllowSignedEnabled Int +CollectionTime String +FirewallUnload Int +GlobalState Int +LoggingEnabled Int +LoggingOption Int +StealthEnabled Int +SystemId String +Version String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsAlf + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfException.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfException.md new file mode 100644 index 000000000..fac36bc01 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfException.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfException.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightAlfException + +## SYNOPSIS +Valid filter fields are `system_id` and `state`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightAlfException -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `state`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightAlfException +``` + +---- ---------- +CollectionTime String +Path String +State System.Nullable[float] State {get;set;} +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsAlfExceptions + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfExplicitAuth.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfExplicitAuth.md new file mode 100644 index 000000000..69d98c371 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfExplicitAuth.md @@ -0,0 +1,116 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAlfExplicitAuth.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightAlfExplicitAuth + +## SYNOPSIS +Valid filter fields are `system_id` and `process`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightAlfExplicitAuth -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `process`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightAlfExplicitAuth +``` + +---- ---------- +CollectionTime String +Process String +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsAlfExplicitAuths + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightApp.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightApp.md new file mode 100644 index 000000000..d30e91e12 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightApp.md @@ -0,0 +1,140 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightApp.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightApp + +## SYNOPSIS +Lists all apps for macOS devices. +For Windows devices, use [List System Insights Programs](#operation/systeminsights_list_programs). + +Valid filter fields are `system_id` and `bundle_name`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightApp -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Lists all apps for macOS devices. +For Windows devices, use [List System Insights Programs](#operation/systeminsights_list_programs). + +Valid filter fields are `system_id` and `bundle_name`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightApp +``` + +---- ---------- +ApplescriptEnabled String +BundleExecutable String +BundleIdentifier String +BundleName String +BundlePackageType String +BundleShortVersion String +BundleVersion String +Category String +CollectionTime String +Compiler String +Copyright String +DevelopmentRegion String +DisplayName String +Element String +Environment String +InfoString +LastOpenedTime System.Nullable[float] LastOpenedTime {get;set;} +MinimumSystemVersion String +Name String +Path String +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsApps + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAppCompatShim.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAppCompatShim.md new file mode 100644 index 000000000..88853df22 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAppCompatShim.md @@ -0,0 +1,121 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAppCompatShim.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightAppCompatShim + +## SYNOPSIS +Valid filter fields are `system_id` and `enabled`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightAppCompatShim -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `enabled`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightAppCompatShim +``` + +---- ---------- +CollectionTime String +Description String +Executable String +InstallTime System.Nullable[float] InstallTime {get;set;} +Path String +SdbId String +SystemId String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsAppcompatShims + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAuthorizedKey.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAuthorizedKey.md new file mode 100644 index 000000000..9386cb108 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAuthorizedKey.md @@ -0,0 +1,119 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAuthorizedKey.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightAuthorizedKey + +## SYNOPSIS +Valid filter fields are `system_id` and `uid`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightAuthorizedKey -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `uid`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightAuthorizedKey +``` + +---- ---------- +Algorithm String +CollectionTime String +Key String +KeyFile String +SystemId String +Uid String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsAuthorizedKeys + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceMetadata.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceMetadata.md new file mode 100644 index 000000000..80c49df5a --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceMetadata.md @@ -0,0 +1,131 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceMetadata.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightAzureInstanceMetadata + +## SYNOPSIS +Valid filter fields are `system_id`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightAzureInstanceMetadata -ConsoleHost [-Filter >] + [-Sort >] [] +``` + +## DESCRIPTION +Valid filter fields are `system_id`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightAzureInstanceMetadata +``` + +---- ---------- +CollectionTime String +Location String +Name String +Offer String +OSType String +PlacementGroupId String +PlatformFaultDomain String +PlatformUpdateDomain String +Publisher String +ResourceGroupName String +Sku String +SubscriptionId String +SystemId String +Version String +VMId String +VMScaleSetName String +VMSize String +Zone String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsAzureInstanceMetadata + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceTag.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceTag.md new file mode 100644 index 000000000..d59d5da6a --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceTag.md @@ -0,0 +1,118 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightAzureInstanceTag.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightAzureInstanceTag + +## SYNOPSIS +Valid filter fields are `system_id`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightAzureInstanceTag -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightAzureInstanceTag +``` + +---- ---------- +CollectionTime String +Key String +SystemId String +Value String +VMId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsAzureInstanceTags + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBattery.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBattery.md new file mode 100644 index 000000000..1c4d1a436 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBattery.md @@ -0,0 +1,133 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBattery.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightBattery + +## SYNOPSIS +Valid filter fields are `system_id` and `health`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightBattery -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `health`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightBattery +``` + +---- ---------- +Amperage Int +Charged Int +Charging Int +CollectionTime String +Condition String +CurrentCapacity Int +CycleCount Int +DesignedCapacity Int +Health String +ManufactureDate Int +Manufacturer String +MaxCapacity Int +MinutesToFullCharge Int +MinutesUntilEmpty Int +Model String +PercentRemaining Int +SerialNumber String +State String +SystemId String +Voltage Int + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsBattery + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBitlockerInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBitlockerInfo.md new file mode 100644 index 000000000..8c38e3a74 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBitlockerInfo.md @@ -0,0 +1,121 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBitlockerInfo.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightBitlockerInfo + +## SYNOPSIS +Valid filter fields are `system_id` and `protection_status`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightBitlockerInfo -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `protection_status`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightBitlockerInfo +``` + +---- ---------- +CollectionTime String +ConversionStatus Int +DeviceId String +DriveLetter String +EncryptionMethod String +PersistentVolumeId String +ProtectionStatus Int +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsBitlockerInfo + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBrowserPlugin.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBrowserPlugin.md new file mode 100644 index 000000000..4ac4d5002 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBrowserPlugin.md @@ -0,0 +1,125 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightBrowserPlugin.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightBrowserPlugin + +## SYNOPSIS +Valid filter fields are `system_id` and `name`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightBrowserPlugin -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `name`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightBrowserPlugin +``` + +---- ---------- +CollectionTime String +Description String +DevelopmentRegion String +Disabled Int +Identifier String +Name String +Native Int +Path String +Sdk String +SystemId String +Uid String +Version String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsBrowserPlugins + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCertificate.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCertificate.md new file mode 100644 index 000000000..0b8b37726 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCertificate.md @@ -0,0 +1,135 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCertificate.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightCertificate + +## SYNOPSIS +Valid filter fields are `system_id` and `common_name`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightCertificate -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `common_name`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightCertificate +``` + +---- ---------- +AuthorityKeyId String +Ca Int +CommonName String +Issuer String +KeyAlgorithm String +KeyStrength String +KeyUsage String +NotValidAfter String +NotValidBefore String +Path String +SelfSigned Int +Serial String +Sha1 String +Sid String +SigningAlgorithm String +Store String +StoreId String +StoreLocation String +Subject String +SubjectKeyId String +SystemId String +Username String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsCertificates + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChassisInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChassisInfo.md new file mode 100644 index 000000000..4a837cf54 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChassisInfo.md @@ -0,0 +1,128 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChassisInfo.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightChassisInfo + +## SYNOPSIS +Valid filter fields are `system_id`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightChassisInfo -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightChassisInfo +``` + +---- ---------- +AudibleAlarm String +BreachDescription String +ChassisTypes String +CollectionTime String +Description String +Lock String +Manufacturer String +Model String +SecurityBreach String +Serial String +Sku String +SmbiosTag String +Status String +SystemId String +VisibleAlarm String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsChassisInfo + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChromeExtension.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChromeExtension.md new file mode 100644 index 000000000..38d05e4dd --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChromeExtension.md @@ -0,0 +1,126 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightChromeExtension.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightChromeExtension + +## SYNOPSIS +Valid filter fields are `system_id` and `name`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightChromeExtension -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `name`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightChromeExtension +``` + +---- ---------- +Author String +CollectionTime String +Description String +Identifier String +Locale String +Name String +Path String +Permissions String +Persistent Int +SystemId String +Uid String +UpdateUrl String +Version String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsChromeExtensions + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightConnectivity.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightConnectivity.md new file mode 100644 index 000000000..48f937d2b --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightConnectivity.md @@ -0,0 +1,124 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightConnectivity.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightConnectivity + +## SYNOPSIS +The only valid filter field is `system_id`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightConnectivity -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +The only valid filter field is `system_id`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightConnectivity +``` + +---- ---------- +CollectionTime String +Disconnected Int +Ipv4Internet Int +Ipv4LocalNetwork Int +Ipv4NoTraffic Int +Ipv4Subnet Int +Ipv6Internet Int +Ipv6LocalNetwork Int +Ipv6NoTraffic Int +Ipv6Subnet Int +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsConnectivity + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCrash.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCrash.md new file mode 100644 index 000000000..207e5da5c --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCrash.md @@ -0,0 +1,131 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCrash.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightCrash + +## SYNOPSIS +Valid filter fields are `system_id` and `identifier`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightCrash -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `identifier`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightCrash +``` + +---- ---------- +CollectionTime String +CrashedThread String +CrashPath String +Datetime String +ExceptionCodes String +ExceptionNotes String +ExceptionType String +Identifier String +Parent String +Path String +Pid String +Registers String +Responsible String +StackTrace String +SystemId String +Type String +Uid Int +Version String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsCrashes + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCupDestination.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCupDestination.md new file mode 100644 index 000000000..ce9ec7607 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCupDestination.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightCupDestination.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightCupDestination + +## SYNOPSIS +Valid filter fields are `system_id` and `name`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightCupDestination -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `name`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightCupDestination +``` + +---- ---------- +Name String +OptionName String +OptionValue String +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsCupsDestinations + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskEncryption.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskEncryption.md new file mode 100644 index 000000000..b1ff85c39 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskEncryption.md @@ -0,0 +1,122 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskEncryption.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightDiskEncryption + +## SYNOPSIS +Valid filter fields are `system_id` and `encryption_status`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightDiskEncryption -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `encryption_status`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightDiskEncryption +``` + +---- ---------- +CollectionTime String +Encrypted Int +EncryptionStatus String +Name String +SystemId String +Type String +Uid String +UserUuid String +Uuid String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsDiskEncryption + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskInfo.md new file mode 100644 index 000000000..aa158cc85 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskInfo.md @@ -0,0 +1,126 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDiskInfo.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightDiskInfo + +## SYNOPSIS +Valid filter fields are `system_id` and `disk_index`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightDiskInfo -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `disk_index`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightDiskInfo +``` + +---- ---------- +CollectionTime String +Description String +DiskIndex Int +DiskSize String +HardwareModel String +Id String +Manufacturer String +Name String +Partitions Int +PnpDeviceId String +Serial String +SystemId String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsDiskInfo + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDnsResolver.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDnsResolver.md new file mode 100644 index 000000000..364294ea5 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDnsResolver.md @@ -0,0 +1,120 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightDnsResolver.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightDnsResolver + +## SYNOPSIS +Valid filter fields are `system_id` and `type`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightDnsResolver -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `type`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightDnsResolver +``` + +---- ---------- +Address String +CollectionTime String +Id System.Nullable[float] Id {get;set;} +Netmask String +Options String +SystemId String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsDnsResolvers + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightEtcHost.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightEtcHost.md new file mode 100644 index 000000000..7c96a43ed --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightEtcHost.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightEtcHost.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightEtcHost + +## SYNOPSIS +Valid filter fields are `system_id` and `address`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightEtcHost -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `address`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightEtcHost +``` + +---- ---------- +Address String +CollectionTime String +Hostnames String +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsEtcHosts + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightFirefoxAddon.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightFirefoxAddon.md new file mode 100644 index 000000000..05f585367 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightFirefoxAddon.md @@ -0,0 +1,129 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightFirefoxAddon.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightFirefoxAddon + +## SYNOPSIS +Valid filter fields are `system_id` and `name`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightFirefoxAddon -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `name`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightFirefoxAddon +``` + +---- ---------- +Active Int +Autoupdate Int +CollectionTime String +Creator String +Description String +Disabled Int +Identifier String +Location String +Name String +Path String +SourceUrl String +SystemId String +Type String +Uid String +Version String +Visible Int + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsFirefoxAddons + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightGroup.md new file mode 100644 index 000000000..f9944c53c --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightGroup.md @@ -0,0 +1,120 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightGroup + +## SYNOPSIS +Valid filter fields are `system_id` and `groupname`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightGroup -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `groupname`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightGroup +``` + +---- ---------- +CollectionTime String +Comment String +Gid String +GidSigned String +Groupname String +GroupSid String +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsGroups + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightIeExtension.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightIeExtension.md new file mode 100644 index 000000000..4312de76e --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightIeExtension.md @@ -0,0 +1,119 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightIeExtension.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightIeExtension + +## SYNOPSIS +Valid filter fields are `system_id` and `name`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightIeExtension -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `name`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightIeExtension +``` + +---- ---------- +CollectionTime String +Name String +Path String +RegistryPath String +SystemId String +Version String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsIeExtensions + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceAddress.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceAddress.md new file mode 100644 index 000000000..d8c6adfa6 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceAddress.md @@ -0,0 +1,122 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceAddress.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightInterfaceAddress + +## SYNOPSIS +Valid filter fields are `system_id` and `address`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightInterfaceAddress -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `address`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightInterfaceAddress +``` + +---- ---------- +Address String +Broadcast String +CollectionTime String +FriendlyName String +Interface String +Mask String +PointToPoint String +SystemId String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsInterfaceAddresses + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceDetail.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceDetail.md new file mode 100644 index 000000000..b1b52e203 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceDetail.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightInterfaceDetail.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightInterfaceDetail + +## SYNOPSIS +Valid filter fields are `system_id` and `interface`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightInterfaceDetail -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `interface`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightInterfaceDetail +``` + +---- ---------- +Collisions String +ConnectionId String +ConnectionStatus String +Description String +DhcpEnabled Int +DhcpLeaseExpires String +DhcpLeaseObtained String +DhcpServer String +DnsDomain String +DnsDomainSuffixSearchOrder String +DnsHostName String +DnsServerSearchOrder String +Enabled Int +Flags Int +FriendlyName String +Ibytes String +Idrops String +Ierrors String +Interface String +Ipackets String +LastChange String +LinkSpeed String +Mac String +Manufacturer String +Metric Int +Mtu Int +Obytes String +Odrops String +Oerrors String +Opackets String +PciSlot String +PhysicalAdapter Int +Service String +Speed Int +SystemId String +Type Int + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsInterfaceDetails + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightKernelInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightKernelInfo.md new file mode 100644 index 000000000..9b8d9c996 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightKernelInfo.md @@ -0,0 +1,119 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightKernelInfo.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightKernelInfo + +## SYNOPSIS +Valid filter fields are `system_id` and `version`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightKernelInfo -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `version`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightKernelInfo +``` + +---- ---------- +Arguments String +CollectionTime String +Device String +Path String +SystemId String +Version String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsKernelInfo + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLaunchd.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLaunchd.md new file mode 100644 index 000000000..f0040508e --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLaunchd.md @@ -0,0 +1,136 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLaunchd.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightLaunchd + +## SYNOPSIS +Valid filter fields are `system_id` and `name`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightLaunchd -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `name`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightLaunchd +``` + +---- ---------- +CollectionTime String +Disabled String +Groupname String +InetdCompatibility String +KeepAlive String +Label String +Name String +OnDemand String +Path String +ProcessType String +Program String +ProgramArguments String +QueueDirectories String +RootDirectory String +RunAtLoad String +StartInterval String +StartOnMount String +StderrPath String +StdoutPath String +SystemId String +Username String +WatchPaths String +WorkingDirectory String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsLaunchd + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLinuxPackage.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLinuxPackage.md new file mode 100644 index 000000000..df280059b --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLinuxPackage.md @@ -0,0 +1,133 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLinuxPackage.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightLinuxPackage + +## SYNOPSIS +Lists all programs for Linux devices. +For macOS devices, use [List System Insights System Apps](#operation/systeminsights_list_apps). +For windows devices, use [List System Insights System Apps](#operation/systeminsights_list_programs). + +Valid filter fields are `name` and `package_format`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightLinuxPackage -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Lists all programs for Linux devices. +For macOS devices, use [List System Insights System Apps](#operation/systeminsights_list_apps). +For windows devices, use [List System Insights System Apps](#operation/systeminsights_list_programs). + +Valid filter fields are `name` and `package_format`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightLinuxPackage +``` + +---- ---------- +Arch String +InstallTime Int +MaintainerOrVendor String +MountNamespaceId String +Name String +PackageFormat String +PackageGroupOrSection String +PidWithNamespace Int +ReleaseOrRevision String +Size String +SystemId String +Version String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsLinuxPackages + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLoggedinUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLoggedinUser.md new file mode 100644 index 000000000..4871476f7 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLoggedinUser.md @@ -0,0 +1,121 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLoggedinUser.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightLoggedinUser + +## SYNOPSIS +Valid filter fields are `system_id` and `user`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightLoggedinUser -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `user`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightLoggedinUser +``` + +---- ---------- +CollectionTime String +Host String +Pid Int +SystemId String +Time Int +Tty String +Type String +User String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsLoggedInUsers + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLogicalDrive.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLogicalDrive.md new file mode 100644 index 000000000..c560cf78c --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLogicalDrive.md @@ -0,0 +1,121 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightLogicalDrive.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightLogicalDrive + +## SYNOPSIS +Valid filter fields are `system_id` and `device_id`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightLogicalDrive -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `device_id`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightLogicalDrive +``` + +---- ---------- +BootPartition Int +CollectionTime String +DeviceId String +FileSystem String +FreeSpace String +Size String +SystemId String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsLogicalDrives + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightManagedPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightManagedPolicy.md new file mode 100644 index 000000000..c540e1e00 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightManagedPolicy.md @@ -0,0 +1,121 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightManagedPolicy.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightManagedPolicy + +## SYNOPSIS +Valid filter fields are `system_id` and `domain`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightManagedPolicy -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `domain`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightManagedPolicy +``` + +---- ---------- +CollectionTime String +Domain String +Manual Int +Name String +SystemId String +Username String +Uuid String +Value String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsManagedPolicies + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightMount.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightMount.md new file mode 100644 index 000000000..c6f70ca70 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightMount.md @@ -0,0 +1,126 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightMount.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightMount + +## SYNOPSIS +Valid filter fields are `system_id` and `path`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightMount -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `path`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightMount +``` + +---- ---------- +Blocks String +BlocksAvailable String +BlocksFree String +BlocksSize String +CollectionTime String +Device String +DeviceAlias String +Flags String +Inodes String +InodesFree String +Path String +SystemId String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsMounts + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightOSVersion.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightOSVersion.md new file mode 100644 index 000000000..65b39c11a --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightOSVersion.md @@ -0,0 +1,125 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightOSVersion.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightOSVersion + +## SYNOPSIS +Valid filter fields are `system_id` and `version`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightOSVersion -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `version`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightOSVersion +``` + +---- ---------- +Build String +Codename String +CollectionTime String +InstallDate String +Major Int +Minor Int +Name String +Patch Int +Platform String +PlatformLike String +SystemId String +Version String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsOSVersion + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPatch.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPatch.md new file mode 100644 index 000000000..3e666296d --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPatch.md @@ -0,0 +1,123 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPatch.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightPatch + +## SYNOPSIS +Valid filter fields are `system_id` and `hotfix_id`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightPatch -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `hotfix_id`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightPatch +``` + +---- ---------- +Caption String +CollectionTime String +Csname String +Description String +FixComments String +HotfixId String +InstallDate String +InstalledBy String +InstalledOn String +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsPatches + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightProgram.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightProgram.md new file mode 100644 index 000000000..504742a21 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightProgram.md @@ -0,0 +1,130 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightProgram.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightProgram + +## SYNOPSIS +Lists all programs for Windows devices. +For macOS devices, use [List System Insights Apps](#operation/systeminsights_list_apps). + +Valid filter fields are `system_id` and `name`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightProgram -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Lists all programs for Windows devices. +For macOS devices, use [List System Insights Apps](#operation/systeminsights_list_apps). + +Valid filter fields are `system_id` and `name`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightProgram +``` + +---- ---------- +CollectionTime String +IdentifyingNumber String +InstallDate String +InstallLocation String +InstallSource String +Language String +Name String +Publisher String +SystemId String +UninstallString +Version String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsPrograms + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPythonPackage.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPythonPackage.md new file mode 100644 index 000000000..b24ee327b --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPythonPackage.md @@ -0,0 +1,121 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightPythonPackage.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightPythonPackage + +## SYNOPSIS +Valid filter fields are `system_id` and `name`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightPythonPackage -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `name`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightPythonPackage +``` + +---- ---------- +Auther String +Directory String +License String +Name String +Path String +Summary String +SystemId String +Version String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsPythonPackages + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSafariExtension.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSafariExtension.md new file mode 100644 index 000000000..d5d42ce85 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSafariExtension.md @@ -0,0 +1,125 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSafariExtension.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightSafariExtension + +## SYNOPSIS +Valid filter fields are `system_id` and `name`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightSafariExtension -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `name`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightSafariExtension +``` + +---- ---------- +Author String +CollectionTime String +Description String +DeveloperId String +Identifier String +Name String +Path String +Sdk String +SystemId String +Uid String +UpdateUrl String +Version String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsSafariExtensions + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightScheduledTask.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightScheduledTask.md new file mode 100644 index 000000000..1527f03fe --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightScheduledTask.md @@ -0,0 +1,124 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightScheduledTask.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightScheduledTask + +## SYNOPSIS +Valid filter fields are `system_id` and `enabled`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightScheduledTask -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `enabled`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightScheduledTask +``` + +---- ---------- +Action String +Enabled Int +Hidden Int +LastRunCode String +LastRunMessage String +LastRunTime String +Name String +NextRunTime String +Path String +State String +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsScheduledTasks + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSecureboot.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSecureboot.md new file mode 100644 index 000000000..fac815825 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSecureboot.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSecureboot.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightSecureboot + +## SYNOPSIS +Valid filter fields are `system_id`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightSecureboot -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightSecureboot +``` + +---- ---------- +CollectionTime String +SecureBoot System.Nullable[float] SecureBoot {get;set;} +SetupMode System.Nullable[float] SetupMode {get;set;} +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsSecureboot + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightService.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightService.md new file mode 100644 index 000000000..0bbdd06cc --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightService.md @@ -0,0 +1,126 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightService.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightService + +## SYNOPSIS +Valid filter fields are `system_id` and `name`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightService -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `name`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightService +``` + +---- ---------- +Description String +DisplayName String +ModulePath String +Name String +Path String +Pid Int +ServiceExitCode Int +ServiceType String +StartType String +Status String +SystemId String +UserAccount String +Win32ExitCode Int + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsServices + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightShadow.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightShadow.md new file mode 100644 index 000000000..d09bacb42 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightShadow.md @@ -0,0 +1,125 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightShadow.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightShadow + +## SYNOPSIS +Valid filter fields are `system_id` and `username`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightShadow -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `username`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightShadow +``` + +---- ---------- +CollectionTime String +Expire String +Flag String +HashAlg String +Inactive String +LastChange String +Max String +Min String +PasswordStatus String +SystemId String +Username String +Warning String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsShadow + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedFolder.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedFolder.md new file mode 100644 index 000000000..e8131e49c --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedFolder.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedFolder.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightSharedFolder + +## SYNOPSIS +Valid filter fields are `system_id` and `name`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightSharedFolder -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `name`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightSharedFolder +``` + +---- ---------- +CollectionTime String +Name String +Path String +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsSharedFolders + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedResource.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedResource.md new file mode 100644 index 000000000..c0a0622fa --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedResource.md @@ -0,0 +1,123 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharedResource.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightSharedResource + +## SYNOPSIS +Valid filter fields are `system_id` and `type`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightSharedResource -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `type`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightSharedResource +``` + +---- ---------- +AllowMaximum Int +CollectionTime String +Description String +InstallDate String +MaximumAllowed String +Name String +Path String +Status String +SystemId String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsSharedResources + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharingPreference.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharingPreference.md new file mode 100644 index 000000000..09dbcba55 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharingPreference.md @@ -0,0 +1,125 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSharingPreference.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightSharingPreference + +## SYNOPSIS +Only valid filed field is `system_id`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightSharingPreference -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Only valid filed field is `system_id`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightSharingPreference +``` + +---- ---------- +BluetoothSharing Int +CollectionTime String +ContentCaching Int +DiscSharing Int +FileSharing Int +InternetSharing Int +PrinterSharing Int +RemoteAppleEvents Int +RemoteLogin Int +RemoteManagement Int +ScreenSharing Int +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsSharingPreferences + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSipConfig.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSipConfig.md new file mode 100644 index 000000000..b2ab9c06c --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSipConfig.md @@ -0,0 +1,118 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSipConfig.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightSipConfig + +## SYNOPSIS +Valid filter fields are `system_id` and `enabled`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightSipConfig -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `enabled`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightSipConfig +``` + +---- ---------- +CollectionTime String +ConfigFlag String +Enabled Int +EnabledNvram Int +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsSipConfig + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightStartupItem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightStartupItem.md new file mode 100644 index 000000000..8fafde997 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightStartupItem.md @@ -0,0 +1,121 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightStartupItem.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightStartupItem + +## SYNOPSIS +Valid filter fields are `system_id` and `name`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightStartupItem -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `name`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightStartupItem +``` + +---- ---------- +Args String +Name String +Path String +Source String +Status String +SystemId String +Type String +Username String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsStartupItems + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemControl.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemControl.md new file mode 100644 index 000000000..d5f1f79d1 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemControl.md @@ -0,0 +1,122 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemControl.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightSystemControl + +## SYNOPSIS +Valid filter fields are `system_id` and `name`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightSystemControl -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `name`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightSystemControl +``` + +---- ---------- +CollectionTime String +ConfigValue String +CurrentValue String +FieldName String +Name String +Oid String +Subsystem String +SystemId String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsSystemControls + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemInfo.md new file mode 100644 index 000000000..704732023 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemInfo.md @@ -0,0 +1,130 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightSystemInfo.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightSystemInfo + +## SYNOPSIS +Valid filter fields are `system_id` and `cpu_subtype`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightSystemInfo -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `cpu_subtype`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightSystemInfo +``` + +---- ---------- +CollectionTime String +ComputerName String +CpuBrand String +CpuLogicalCores Int +CpuMicrocode String +CpuPhysicalCores Int +CpuSubtype String +CpuType String +HardwareModel String +HardwareSerial String +HardwareVendor String +HardwareVersion String +Hostname String +LocalHostname String +PhysicalMemory String +SystemId String +Uuid String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsSystemInfo + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightTpmInfo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightTpmInfo.md new file mode 100644 index 000000000..a2918b924 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightTpmInfo.md @@ -0,0 +1,124 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightTpmInfo.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightTpmInfo + +## SYNOPSIS +Valid filter fields are `system_id`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightTpmInfo -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightTpmInfo +``` + +---- ---------- +Activated System.Nullable[float] Activated {get;set;} +CollectionTime String +Enabled System.Nullable[float] Enabled {get;set;} +ManufacturerId System.Nullable[float] ManufacturerId {get;set;} +ManufacturerName String +ManufacturerVersion String +Owned System.Nullable[float] Owned {get;set;} +PhysicalPresenceVersion String +ProductName String +SpecVersion String +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsTpmInfo + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUptime.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUptime.md new file mode 100644 index 000000000..78b4e3526 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUptime.md @@ -0,0 +1,120 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUptime.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightUptime + +## SYNOPSIS +Valid filter fields are `system_id` and `days`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightUptime -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `days`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightUptime +``` + +---- ---------- +CollectionTime String +Days Int +Hours Int +Minutes Int +Seconds Int +SystemId String +TotalSeconds String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsUptime + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUsbDevice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUsbDevice.md new file mode 100644 index 000000000..3614c179a --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUsbDevice.md @@ -0,0 +1,127 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUsbDevice.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightUsbDevice + +## SYNOPSIS +Valid filter fields are `system_id` and `model`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightUsbDevice -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `model`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightUsbDevice +``` + +---- ---------- +Class String +CollectionTime String +Model String +ModelId String +Protocol String +Removable Int +Serial String +Subclass String +SystemId String +UsbAddress Int +UsbPort Int +Vendor String +VendorId String +Version String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsUsbDevices + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUser.md new file mode 100644 index 000000000..9e4d6482f --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUser.md @@ -0,0 +1,131 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUser.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightUser + +## SYNOPSIS +Valid filter fields are `system_id` and `username`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightUser -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `username`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightUser +``` + +---- ---------- +AdManaged Boolean +Admin Boolean +CollectionTime String +Description String +Directory String +Gid String +GidSigned String +LastLogin String +Managed Boolean +RealUser Boolean +Shell String +Suspended Boolean +SystemId String +Type String +Uid String +UidSigned String +Username String +Uuid String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsUsers + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserAssist.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserAssist.md new file mode 100644 index 000000000..dd4e81212 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserAssist.md @@ -0,0 +1,119 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserAssist.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightUserAssist + +## SYNOPSIS +Valid filter fields are `system_id`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightUserAssist -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightUserAssist +``` + +---- ---------- +CollectionTime String +Count System.Nullable[float] Count {get;set;} +LastExecutionTime System.Nullable[float] LastExecutionTime {get;set;} +Path String +Sid String +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsUserassist + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserGroup.md new file mode 100644 index 000000000..1d37bba6e --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserGroup.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightUserGroup + +## SYNOPSIS +Only valid filter field is `system_id`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightUserGroup -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Only valid filter field is `system_id`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightUserGroup +``` + +---- ---------- +CollectionTime String +Gid String +SystemId String +Uid String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsUserGroups + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserSshKey.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserSshKey.md new file mode 100644 index 000000000..48bd9999d --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserSshKey.md @@ -0,0 +1,118 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightUserSshKey.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightUserSshKey + +## SYNOPSIS +Valid filter fields are `system_id` and `uid`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightUserSshKey -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `uid`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightUserSshKey +``` + +---- ---------- +CollectionTime String +Encrypted Int +Path String +SystemId String +Uid String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsUserSshKeys + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiNetwork.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiNetwork.md new file mode 100644 index 000000000..1239b31b2 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiNetwork.md @@ -0,0 +1,127 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiNetwork.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightWifiNetwork + +## SYNOPSIS +Valid filter fields are `system_id` and `security_type`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightWifiNetwork -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `security_type`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightWifiNetwork +``` + +---- ---------- +AutoLogin System.Nullable[float] AutoLogin {get;set;} +CaptivePortal System.Nullable[float] CaptivePortal {get;set;} +CollectionTime String +Disabled System.Nullable[float] Disabled {get;set;} +LastConnected System.Nullable[float] LastConnected {get;set;} +NetworkName String +Passpoint System.Nullable[float] Passpoint {get;set;} +PossiblyHidden System.Nullable[float] PossiblyHidden {get;set;} +Roaming System.Nullable[float] Roaming {get;set;} +RoamingProfile String +SecurityType String +Ssid String +SystemId String +TemporarilyDisabled System.Nullable[float] TemporarilyDisabled {get;set;} + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsWifiNetworks + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiStatus.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiStatus.md new file mode 100644 index 000000000..4e81200d3 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiStatus.md @@ -0,0 +1,128 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWifiStatus.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightWifiStatus + +## SYNOPSIS +Valid filter fields are `system_id` and `security_type`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightWifiStatus -ConsoleHost [-Filter >] [-Sort >] + [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `security_type`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightWifiStatus +``` + +---- ---------- +Bssid String +Channel System.Nullable[float] Channel {get;set;} +ChannelBand System.Nullable[float] ChannelBand {get;set;} +ChannelWidth System.Nullable[float] ChannelWidth {get;set;} +CollectionTime String +CountryCode String +Interface String +Mode String +NetworkName String +Noise System.Nullable[float] Noise {get;set;} +Rssi System.Nullable[float] Rssi {get;set;} +SecurityType String +Ssid String +SystemId String +TransmitRate String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsWifiStatus + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityCenter.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityCenter.md new file mode 100644 index 000000000..448fe036e --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityCenter.md @@ -0,0 +1,122 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityCenter.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightWindowsSecurityCenter + +## SYNOPSIS +Valid filter fields are `system_id`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightWindowsSecurityCenter -ConsoleHost [-Filter >] + [-Sort >] [] +``` + +## DESCRIPTION +Valid filter fields are `system_id`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightWindowsSecurityCenter +``` + +---- ---------- +Antispyware String +Antivirus String +Autoupdate String +CollectionTime String +Firewall String +InternetSettings String +SystemId String +UserAccountControl String +WindowsSecurityCenterService String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsWindowsSecurityCenter + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityProduct.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityProduct.md new file mode 100644 index 000000000..c50238fcc --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityProduct.md @@ -0,0 +1,121 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemInsightWindowsSecurityProduct.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemInsightWindowsSecurityProduct + +## SYNOPSIS +Valid filter fields are `system_id` and `state`. + +## SYNTAX + +``` +Get-JcSdkSystemInsightWindowsSecurityProduct -ConsoleHost [-Filter >] + [-Sort >] [] +``` + +## DESCRIPTION +Valid filter fields are `system_id` and `state`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemInsightWindowsSecurityProduct +``` + +---- ---------- +CollectionTime String +Name String +RemediationPath String +SignaturesUpToDate System.Nullable[float] SignaturesUpToDate {get;set;} +State String +StateTimestamp String +SystemId String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemInsightsWindowsSecurityProducts + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemMember.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemMember.md new file mode 100644 index 000000000..fb74c1742 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemMember.md @@ -0,0 +1,235 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemMember.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemMember + +## SYNOPSIS +This endpoint returns all the System Groups a System is a member of. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/memberof \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSystemMember -ConsoleHost -SystemId [-Filter >] [-Sort >] + [-Authorization ] [-Date ] [] +``` + +### GetViaIdentity +``` +Get-JcSdkSystemMember -ConsoleHost -InputObject [-Filter >] + [-Sort >] [-Authorization ] [-Date ] [] +``` + +## DESCRIPTION +This endpoint returns all the System Groups a System is a member of. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/memberof \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemMember -SystemId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -Authorization +Authorization header for the System Context API + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Date +Current date header for the System Context API + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SystemId +ObjectID of the System. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemPolicyStatus.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemPolicyStatus.md new file mode 100644 index 000000000..26666933f --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemPolicyStatus.md @@ -0,0 +1,175 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemPolicyStatus.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemPolicyStatus + +## SYNOPSIS +This endpoint returns the policy results for a particular system. + +##### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +``` +Get-JcSdkSystemPolicyStatus -ConsoleHost -SystemId [-Fields >] + [-Filter >] [-Sort >] [] +``` + +## DESCRIPTION +This endpoint returns the policy results for a particular system. + +##### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemPolicyStatus +``` + +---- ---------- +Detail String +EndedAt Datetime +ExitStatus System.Nullable[long] ExitStatus {get;set;} +Id String +PolicyId String +StartedAt Datetime +State String +StdErr String +StdOut String +Success Boolean +SystemId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SystemId +ObjectID of the System. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPolicyResult + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseCommand.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseCommand.md new file mode 100644 index 000000000..bb6ce7928 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseCommand.md @@ -0,0 +1,229 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseCommand.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemTraverseCommand + +## SYNOPSIS +This endpoint will return all Commands bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/commands \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSystemTraverseCommand -ConsoleHost -SystemId [-Details ] + [-Filter >] [] +``` + +### GetViaIdentity +``` +Get-JcSdkSystemTraverseCommand -ConsoleHost -InputObject [-Details ] + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Commands bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/commands \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemTraverseCommand -SystemId:() +``` + +---- ---------- +Command String +CommandType String +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +LaunchType String +Name String +Organization String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Schedule String +ScheduleRepeatType String +Timeout String +TimeToLiveSeconds Int +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Details +This will provide detail descriptive response for the request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SystemId +ObjectID of the System. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ICommandsGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicy.md new file mode 100644 index 000000000..3e7ebc5ac --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicy.md @@ -0,0 +1,211 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicy.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemTraversePolicy + +## SYNOPSIS +This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +This endpoint is not yet public as we have finish the code. + +##### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSystemTraversePolicy -ConsoleHost -SystemId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkSystemTraversePolicy -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +This endpoint is not yet public as we have finish the code. + +##### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemTraversePolicy -SystemId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SystemId +ObjectID of the System. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicyGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicyGroup.md new file mode 100644 index 000000000..c3e2f3529 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicyGroup.md @@ -0,0 +1,235 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraversePolicyGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemTraversePolicyGroup + +## SYNOPSIS +This endpoint will return all Policy Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policygroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSystemTraversePolicyGroup -ConsoleHost -SystemId [-Filter >] + [-Authorization ] [-Date ] [] +``` + +### GetViaIdentity +``` +Get-JcSdkSystemTraversePolicyGroup -ConsoleHost -InputObject + [-Filter >] [-Authorization ] [-Date ] [] +``` + +## DESCRIPTION +This endpoint will return all Policy Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policygroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemTraversePolicyGroup -SystemId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -Authorization +Authorization header for the System Context API + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Date +Current date header for the System Context API + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SystemId +ObjectID of the System. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUser.md new file mode 100644 index 000000000..8370c29f4 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUser.md @@ -0,0 +1,235 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUser.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemTraverseUser + +## SYNOPSIS +This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSystemTraverseUser -ConsoleHost -SystemId [-Filter >] + [-Authorization ] [-Date ] [] +``` + +### GetViaIdentity +``` +Get-JcSdkSystemTraverseUser -ConsoleHost -InputObject + [-Filter >] [-Authorization ] [-Date ] [] +``` + +## DESCRIPTION +This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemTraverseUser -SystemId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -Authorization +Authorization header for the System Context API + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Date +Current date header for the System Context API + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SystemId +ObjectID of the System. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUserGroup.md new file mode 100644 index 000000000..4e259db93 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUserGroup.md @@ -0,0 +1,235 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkSystemTraverseUserGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkSystemTraverseUserGroup + +## SYNOPSIS +This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkSystemTraverseUserGroup -ConsoleHost -SystemId [-Filter >] + [-Authorization ] [-Date ] [] +``` + +### GetViaIdentity +``` +Get-JcSdkSystemTraverseUserGroup -ConsoleHost -InputObject + [-Filter >] [-Authorization ] [-Date ] [] +``` + +## DESCRIPTION +This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkSystemTraverseUserGroup -SystemId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -Authorization +Authorization header for the System Context API + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Date +Current date header for the System Context API + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SystemId +ObjectID of the System. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserAssociation.md new file mode 100644 index 000000000..eb22356dc --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserAssociation.md @@ -0,0 +1,184 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserAssociation.md +schema: 2.0.0 +--- + +# Get-JcSdkUserAssociation + +## SYNOPSIS +This endpoint returns the _direct_ associations of a User. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/associations?targets=system_group \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserAssociation -ConsoleHost -UserId -Targets [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserAssociation -ConsoleHost -InputObject -Targets + [] +``` + +## DESCRIPTION +This endpoint returns the _direct_ associations of a User. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/associations?targets=system_group \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserAssociation -UserId:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Targets +Targets which a "active_directory" can be associated to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +ObjectID of the User. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphConnection + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroup.md new file mode 100644 index 000000000..b16cb430b --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroup.md @@ -0,0 +1,247 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkUserGroup + +## SYNOPSIS +This endpoint returns the details of a User Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkUserGroup -ConsoleHost [-Fields >] [-Filter >] + [-Sort >] [] +``` + +### Get +``` +Get-JcSdkUserGroup -ConsoleHost -Id [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserGroup -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint returns the details of a User Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserGroup -Fields:() -Filter:() -Sort:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +SuggestionCountAdd Int +SuggestionCountRemove Int +SuggestionCountTotal Int +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkUserGroup -Id:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +SuggestionCountAdd Int +SuggestionCountRemove Int +SuggestionCountTotal Int +Type String + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of the User Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IUserGroup + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupAssociation.md new file mode 100644 index 000000000..456c2bdf9 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupAssociation.md @@ -0,0 +1,182 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupAssociation.md +schema: 2.0.0 +--- + +# Get-JcSdkUserGroupAssociation + +## SYNOPSIS +This endpoint returns the _direct_ associations of this User Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations?targets=system \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserGroupAssociation -ConsoleHost -GroupId -Targets [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserGroupAssociation -ConsoleHost -InputObject -Targets + [] +``` + +## DESCRIPTION +This endpoint returns the _direct_ associations of this User Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations?targets=system \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserGroupAssociation -GroupId:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the User Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Targets +Targets which a "active_directory" can be associated to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphConnection + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMember.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMember.md new file mode 100644 index 000000000..a53f769aa --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMember.md @@ -0,0 +1,160 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMember.md +schema: 2.0.0 +--- + +# Get-JcSdkUserGroupMember + +## SYNOPSIS +This endpoint returns the user members of a User Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserGroupMember -ConsoleHost -GroupId [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserGroupMember -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint returns the user members of a User Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserGroupMember -GroupId:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +FromAttributes JumpCloud.SDK.V2.Models.GraphAttributes +FromId String +FromType String +ToAttributes JumpCloud.SDK.V2.Models.GraphAttributes +ToId String +ToType String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the User Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphConnection + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMembership.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMembership.md new file mode 100644 index 000000000..1cd2a9291 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMembership.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupMembership.md +schema: 2.0.0 +--- + +# Get-JcSdkUserGroupMembership + +## SYNOPSIS +This endpoint returns all users members that are a member of this User Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/membership \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserGroupMembership -ConsoleHost -GroupId [-Filter >] + [-Sort >] [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserGroupMembership -ConsoleHost -InputObject + [-Filter >] [-Sort >] [] +``` + +## DESCRIPTION +This endpoint returns all users members that are a member of this User Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/membership \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserGroupMembership -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the User Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseActiveDirectory.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseActiveDirectory.md new file mode 100644 index 000000000..922ebbff0 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseActiveDirectory.md @@ -0,0 +1,199 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseActiveDirectory.md +schema: 2.0.0 +--- + +# Get-JcSdkUserGroupTraverseActiveDirectory + +## SYNOPSIS +This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserGroupTraverseActiveDirectory -ConsoleHost -GroupId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserGroupTraverseActiveDirectory -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserGroupTraverseActiveDirectory -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the User Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseApplication.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseApplication.md new file mode 100644 index 000000000..ff6980569 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseApplication.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseApplication.md +schema: 2.0.0 +--- + +# Get-JcSdkUserGroupTraverseApplication + +## SYNOPSIS +This endpoint will return all Applications bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/applications \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserGroupTraverseApplication -ConsoleHost -GroupId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserGroupTraverseApplication -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Applications bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/applications \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserGroupTraverseApplication -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the User Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseDirectory.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseDirectory.md new file mode 100644 index 000000000..d0d56623b --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseDirectory.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseDirectory.md +schema: 2.0.0 +--- + +# Get-JcSdkUserGroupTraverseDirectory + +## SYNOPSIS +This endpoint will return all Directories bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directories from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/directories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserGroupTraverseDirectory -ConsoleHost -GroupId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserGroupTraverseDirectory -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Directories bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directories from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/directories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserGroupTraverseDirectory -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the User Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseGSuite.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseGSuite.md new file mode 100644 index 000000000..57935590c --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseGSuite.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseGSuite.md +schema: 2.0.0 +--- + +# Get-JcSdkUserGroupTraverseGSuite + +## SYNOPSIS +This endpoint will return all G Suite Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID/gsuites \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserGroupTraverseGSuite -ConsoleHost -GroupId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserGroupTraverseGSuite -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all G Suite Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID/gsuites \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserGroupTraverseGSuite -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the User Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseLdapServer.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseLdapServer.md new file mode 100644 index 000000000..809302113 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseLdapServer.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseLdapServer.md +schema: 2.0.0 +--- + +# Get-JcSdkUserGroupTraverseLdapServer + +## SYNOPSIS +This endpoint will return all LDAP Servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/ldapservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserGroupTraverseLdapServer -ConsoleHost -GroupId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserGroupTraverseLdapServer -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all LDAP Servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/ldapservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserGroupTraverseLdapServer -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the User Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseOffice365.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseOffice365.md new file mode 100644 index 000000000..651a6f2b6 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseOffice365.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseOffice365.md +schema: 2.0.0 +--- + +# Get-JcSdkUserGroupTraverseOffice365 + +## SYNOPSIS +This endpoint will return all Office 365 instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/office365s \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserGroupTraverseOffice365 -ConsoleHost -GroupId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserGroupTraverseOffice365 -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Office 365 instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/office365s \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserGroupTraverseOffice365 -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the User Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseRadiusServer.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseRadiusServer.md new file mode 100644 index 000000000..67db62d2d --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseRadiusServer.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseRadiusServer.md +schema: 2.0.0 +--- + +# Get-JcSdkUserGroupTraverseRadiusServer + +## SYNOPSIS +This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserGroupTraverseRadiusServer -ConsoleHost -GroupId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserGroupTraverseRadiusServer -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserGroupTraverseRadiusServer -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the User Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystem.md new file mode 100644 index 000000000..b6d3b970b --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystem.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystem.md +schema: 2.0.0 +--- + +# Get-JcSdkUserGroupTraverseSystem + +## SYNOPSIS +This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserGroupTraverseSystem -ConsoleHost -GroupId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserGroupTraverseSystem -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserGroupTraverseSystem -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the User Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystemGroup.md new file mode 100644 index 000000000..9d341279b --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystemGroup.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserGroupTraverseSystemGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkUserGroupTraverseSystemGroup + +## SYNOPSIS +This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserGroupTraverseSystemGroup -ConsoleHost -GroupId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserGroupTraverseSystemGroup -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserGroupTraverseSystemGroup -GroupId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the User Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserMember.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserMember.md new file mode 100644 index 000000000..b51ea0a6e --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserMember.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserMember.md +schema: 2.0.0 +--- + +# Get-JcSdkUserMember + +## SYNOPSIS +This endpoint returns all the User Groups a User is a member of. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/memberof \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserMember -ConsoleHost -UserId [-Filter >] [-Sort >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserMember -ConsoleHost -InputObject [-Filter >] + [-Sort >] [] +``` + +## DESCRIPTION +This endpoint returns all the User Groups a User is a member of. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/memberof \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserMember -UserId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +ObjectID of the User. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserPushEndpoint.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserPushEndpoint.md new file mode 100644 index 000000000..664fe02b7 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserPushEndpoint.md @@ -0,0 +1,179 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserPushEndpoint.md +schema: 2.0.0 +--- + +# Get-JcSdkUserPushEndpoint + +## SYNOPSIS +This endpoint will retrieve a push endpoint associated with a user. + +## SYNTAX + +### List (Default) +``` +Get-JcSdkUserPushEndpoint -ConsoleHost -UserId [] +``` + +### Get +``` +Get-JcSdkUserPushEndpoint -ConsoleHost -PushEndpointId -UserId [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserPushEndpoint -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint will retrieve a push endpoint associated with a user. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserPushEndpoint -UserId:() +``` + +---- ---------- +DeviceAppVersion String +DeviceMake String +DeviceModel String +DeviceOS String +DeviceOSVersion String +DeviceUvEnabled Boolean +EnrollmentDate Datetime +Id String +LastUsedDate Datetime +Name String +State String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkUserPushEndpoint -UserId:() -PushEndpointId:() +``` + +---- ---------- +DeviceAppVersion String +DeviceMake String +DeviceModel String +DeviceOS String +DeviceOSVersion String +DeviceUvEnabled Boolean +EnrollmentDate Datetime +Id String +LastUsedDate Datetime +Name String +State String + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PushEndpointId +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPushEndpointResponse + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseActiveDirectory.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseActiveDirectory.md new file mode 100644 index 000000000..d213f45a9 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseActiveDirectory.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseActiveDirectory.md +schema: 2.0.0 +--- + +# Get-JcSdkUserTraverseActiveDirectory + +## SYNOPSIS +This endpoint will return all Active Directory Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Active Directory instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory instance from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/activedirectories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserTraverseActiveDirectory -ConsoleHost -UserId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserTraverseActiveDirectory -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Active Directory Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Active Directory instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory instance from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/activedirectories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserTraverseActiveDirectory -UserId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -UserId +ObjectID of the User. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseApplication.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseApplication.md new file mode 100644 index 000000000..131374497 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseApplication.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseApplication.md +schema: 2.0.0 +--- + +# Get-JcSdkUserTraverseApplication + +## SYNOPSIS +This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserTraverseApplication -ConsoleHost -UserId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserTraverseApplication -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserTraverseApplication -UserId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -UserId +ObjectID of the User. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseDirectory.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseDirectory.md new file mode 100644 index 000000000..7994b66dc --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseDirectory.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseDirectory.md +schema: 2.0.0 +--- + +# Get-JcSdkUserTraverseDirectory + +## SYNOPSIS +This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserTraverseDirectory -ConsoleHost -UserId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserTraverseDirectory -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserTraverseDirectory -UserId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -UserId +ObjectID of the User. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseGSuite.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseGSuite.md new file mode 100644 index 000000000..4273c7e46 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseGSuite.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseGSuite.md +schema: 2.0.0 +--- + +# Get-JcSdkUserTraverseGSuite + +## SYNOPSIS +This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserTraverseGSuite -ConsoleHost -UserId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserTraverseGSuite -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserTraverseGSuite -UserId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -UserId +ObjectID of the User. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseLdapServer.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseLdapServer.md new file mode 100644 index 000000000..c67d58845 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseLdapServer.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseLdapServer.md +schema: 2.0.0 +--- + +# Get-JcSdkUserTraverseLdapServer + +## SYNOPSIS +This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserTraverseLdapServer -ConsoleHost -UserId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserTraverseLdapServer -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserTraverseLdapServer -UserId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -UserId +ObjectID of the User. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseOffice365.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseOffice365.md new file mode 100644 index 000000000..b10282e00 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseOffice365.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseOffice365.md +schema: 2.0.0 +--- + +# Get-JcSdkUserTraverseOffice365 + +## SYNOPSIS +This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserTraverseOffice365 -ConsoleHost -UserId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserTraverseOffice365 -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserTraverseOffice365 -UserId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -UserId +ObjectID of the User. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseRadiusServer.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseRadiusServer.md new file mode 100644 index 000000000..65783fae0 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseRadiusServer.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseRadiusServer.md +schema: 2.0.0 +--- + +# Get-JcSdkUserTraverseRadiusServer + +## SYNOPSIS +This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserTraverseRadiusServer -ConsoleHost -UserId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserTraverseRadiusServer -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserTraverseRadiusServer -UserId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -UserId +ObjectID of the User. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystem.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystem.md new file mode 100644 index 000000000..73d8b54fe --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystem.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystem.md +schema: 2.0.0 +--- + +# Get-JcSdkUserTraverseSystem + +## SYNOPSIS +This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserTraverseSystem -ConsoleHost -UserId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserTraverseSystem -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserTraverseSystem -UserId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -UserId +ObjectID of the User. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystemGroup.md new file mode 100644 index 000000000..42fd8b191 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystemGroup.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkUserTraverseSystemGroup.md +schema: 2.0.0 +--- + +# Get-JcSdkUserTraverseSystemGroup + +## SYNOPSIS +This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkUserTraverseSystemGroup -ConsoleHost -UserId [-Filter >] + [] +``` + +### GetViaIdentity +``` +Get-JcSdkUserTraverseSystemGroup -ConsoleHost -InputObject + [-Filter >] [] +``` + +## DESCRIPTION +This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkUserTraverseSystemGroup -UserId:() +``` + +---- ---------- +CompiledAttributes JumpCloud.SDK.V2.Models.GraphAttributes +Id String +Paths JumpCloud.SDK.V2.Models.GraphConnection[][] +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -UserId +ObjectID of the User. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGraphObjectWithPaths + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkday.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkday.md new file mode 100644 index 000000000..ffdcf75bc --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkday.md @@ -0,0 +1,241 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkday.md +schema: 2.0.0 +--- + +# Get-JcSdkWorkday + +## SYNOPSIS +This endpoint will return all the available information about an instance of Workday. + +#### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/workdays/ \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## SYNTAX + +### List (Default) +``` +Get-JcSdkWorkday -ConsoleHost [-Fields >] [-Filter >] + [-Sort >] [] +``` + +### Get +``` +Get-JcSdkWorkday -ConsoleHost -Id [] +``` + +### GetViaIdentity +``` +Get-JcSdkWorkday -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint will return all the available information about an instance of Workday. + +#### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/workdays/ \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkWorkday -Fields:() -Filter:() -Sort:() +``` + +---- ---------- +BasicExpiry String +BasicIsValid Boolean +BasicMessage String +Id String +LastImport String +Name String +OauthExpiry String +OauthIsValid Boolean +OauthMessage String +ReportUrl String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-JcSdkWorkday -Id:() +``` + +---- ---------- +BasicExpiry String +BasicIsValid Boolean +BasicMessage String +Id String +LastImport String +Name String +OauthExpiry String +OauthIsValid Boolean +OauthMessage String +ReportUrl String + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields +The comma separated fields included in the returned records. +If omitted, the default list of fields will be returned. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +A filter to apply to the query. + +**Filter structure**: `\:\:\`. + +**field** = Populate with a valid field from an endpoint response. + +**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. +_Note: v1 operators differ from v2 operators._ + +**value** = Populate with the value you want to search for. +Is case sensitive. +Supports wild cards. + +**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group` + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IWorkdayOutput + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkdayWorker.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkdayWorker.md new file mode 100644 index 000000000..186181069 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkdayWorker.md @@ -0,0 +1,181 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkWorkdayWorker.md +schema: 2.0.0 +--- + +# Get-JcSdkWorkdayWorker + +## SYNOPSIS +This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. + +##### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + + +``` + +## SYNTAX + +### Get (Default) +``` +Get-JcSdkWorkdayWorker -ConsoleHost -WorkdayId [-Sort >] [] +``` + +### GetViaIdentity +``` +Get-JcSdkWorkdayWorker -ConsoleHost -InputObject [-Sort >] + [] +``` + +## DESCRIPTION +This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. + +##### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Get-JcSdkWorkdayWorker -WorkdayId:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.WorkdayWorkerAttributes +Email String +FirstName String +LastName String +Username String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sort +The comma separated fields used to sort the collection. +Default sort is ascending, prefix with `-` to sort descending. + +```yaml +Type: System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkdayId +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IWorkdayWorker + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Grant-JcSdkWorkday.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Grant-JcSdkWorkday.md new file mode 100644 index 000000000..f87d1b413 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Grant-JcSdkWorkday.md @@ -0,0 +1,312 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Grant-JcSdkWorkday.md +schema: 2.0.0 +--- + +# Grant-JcSdkWorkday + +## SYNOPSIS +This endpoint adds an authorization method to a workday instance. + +You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. +Failure to provide these credentials will result in the request being rejected. + +Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ +\t\"auth\":{ +\t \"basic\": { +\t\t\"username\": \"someDeveloper\",\t +\t\t\"password\": \"notTheRealPassword\" + +\t } +\t} +}' + +``` + +## SYNTAX + +### AuthorizeExpanded (Default) +``` +Grant-JcSdkWorkday -ConsoleHost -WorkdayId [-BasicPassword ] + [-BasicUsername ] [-OauthCode ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Authorize +``` +Grant-JcSdkWorkday -ConsoleHost -WorkdayId -Body [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### AuthorizeViaIdentity +``` +Grant-JcSdkWorkday -ConsoleHost -InputObject -Body + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### AuthorizeViaIdentityExpanded +``` +Grant-JcSdkWorkday -ConsoleHost -InputObject [-BasicPassword ] + [-BasicUsername ] [-OauthCode ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint adds an authorization method to a workday instance. + +You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. +Failure to provide these credentials will result in the request being rejected. + +Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ +\t\"auth\":{ +\t \"basic\": { +\t\t\"username\": \"someDeveloper\",\t +\t\t\"password\": \"notTheRealPassword\" + +\t } +\t} +}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Grant-JcSdkWorkday -WorkdayId:() -BasicPassword:() -BasicUsername:() -OauthCode:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Grant-JcSdkWorkday -WorkdayId:() -Body:() +``` + + + +## PARAMETERS + +### -BasicPassword +. + +```yaml +Type: System.String +Parameter Sets: AuthorizeExpanded, AuthorizeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BasicUsername +. + +```yaml +Type: System.String +Parameter Sets: AuthorizeExpanded, AuthorizeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +Auth Input Object + +```yaml +Type: JumpCloud.SDK.V2.Models.IAuthInputObject +Parameter Sets: Authorize, AuthorizeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: AuthorizeViaIdentity, AuthorizeViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OauthCode +. + +```yaml +Type: System.String +Parameter Sets: AuthorizeExpanded, AuthorizeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkdayId +. + +```yaml +Type: System.String +Parameter Sets: Authorize, AuthorizeExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IAuthInputObject + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: Auth Input Object + - `[BasicPassword ]`: + - `[BasicUsername ]`: + - `[OauthCode ]`: + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkScim.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkScim.md new file mode 100644 index 000000000..6ec6350eb --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkScim.md @@ -0,0 +1,263 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkScim.md +schema: 2.0.0 +--- + +# Import-JcSdkScim + +## SYNOPSIS +Get a list of users to import from an Application IdM service provider. + +## SYNTAX + +### Import (Default) +``` +Import-JcSdkScim -ConsoleHost -ApplicationId [-Cursor ] [-Filter ] + [-IsCount] [-IsCursor] [-Query ] [-SessionId ] [-Sort ] [-SortOrder ] + [] +``` + +### ImportViaIdentity +``` +Import-JcSdkScim -ConsoleHost -InputObject [-Cursor ] + [-Filter ] [-IsCount] [-IsCursor] [-Query ] [-SessionId ] [-Sort ] + [-SortOrder ] [] +``` + +## DESCRIPTION +Get a list of users to import from an Application IdM service provider. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Import-JcSdkScim -ApplicationId:() +``` + +---- ---------- +TotalCount System.Nullable[float] TotalCount {get;set;} +Users JumpCloud.SDK.V2.Models.ImportUser[] + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ApplicationId +ObjectID of the Application. + +```yaml +Type: System.String +Parameter Sets: Import +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cursor +Cursor token for pagination + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filter users by a search term + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: ImportViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsCount +IsCount indicates if the request is only for getting the total count of users. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsCursor +Enable cursor-based pagination + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +URL query to merge with the service provider request + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionId +Import sessionId for manual select and view user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort +Sort users by supported fields + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortOrder +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IImportUsersResponse + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkday.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkday.md new file mode 100644 index 000000000..16a9f7dd9 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkday.md @@ -0,0 +1,297 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkday.md +schema: 2.0.0 +--- + +# Import-JcSdkWorkday + +## SYNOPSIS +The endpoint allows you to import a Workday Import request. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '[ +\t{ +\t\t\"email\":\"{email}\", +\t\t\"firstname\":\"{firstname}\", +\t\t\"lastname\":\"{firstname}\", +\t\t\"username\":\"{username}\", +\t\t\"attributes\":[ +\t\t\t{\"name\":\"EmployeeID\",\"value\":\"0000\"}, +\t\t\t{\"name\":\"WorkdayID\",\"value\":\"name.name\"} +\t\t\t] +\t\t +\t} +] +``` + +## SYNTAX + +### Import (Default) +``` +Import-JcSdkWorkday -ConsoleHost -WorkdayId -Body > [-Confirm] + [-WhatIf] [] +``` + +### ImportViaIdentity +``` +Import-JcSdkWorkday -ConsoleHost -InputObject -Body > + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +The endpoint allows you to import a Workday Import request. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '[ +\t{ +\t\t\"email\":\"{email}\", +\t\t\"firstname\":\"{firstname}\", +\t\t\"lastname\":\"{firstname}\", +\t\t\"username\":\"{username}\", +\t\t\"attributes\":[ +\t\t\t{\"name\":\"EmployeeID\",\"value\":\"0000\"}, +\t\t\t{\"name\":\"WorkdayID\",\"value\":\"name.name\"} +\t\t\t] +\t\t +\t} +] +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Import-JcSdkWorkday -WorkdayId:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -Body +Array of bulk-user-create + +```yaml +Type: System.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserCreate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: ImportViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkdayId +. + +```yaml +Type: System.String +Parameter Sets: Import +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### System.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserCreate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IJobIdResult + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY >`: Array of bulk-user-create + - `[AccountLocked ]`: + - `[Activated ]`: + - `[Addresses >]`: + - `[Country ]`: + - `[ExtendedAddress ]`: + - `[Locality ]`: + - `[PoBox ]`: + - `[PostalCode ]`: + - `[Region ]`: + - `[StreetAddress ]`: + - `[Type ]`: + - `[AllowPublicKey ]`: + - `[AlternateEmail ]`: + - `[Attributes >]`: + - `[Name ]`: + - `[Value ]`: + - `[Company ]`: + - `[CostCenter ]`: + - `[DelegatedAuthorityId ]`: ObjectId of the target Active Directory connection + - `[DelegatedAuthorityName ]`: Authority name + - `[Department ]`: + - `[Description ]`: + - `[DisableDeviceMaxLoginAttempts ]`: + - `[Displayname ]`: + - `[Email ]`: + - `[EmployeeIdentifier ]`: Must be unique per user. + - `[EmployeeType ]`: + - `[EnableManagedUid ]`: + - `[EnableUserPortalMultifactor ]`: + - `[ExternalDn ]`: + - `[ExternalPasswordExpirationDate ]`: + - `[ExternalSourceType ]`: + - `[ExternallyManaged ]`: + - `[Firstname ]`: + - `[JobTitle ]`: + - `[Lastname ]`: + - `[LdapBindingUser ]`: + - `[Location ]`: + - `[ManagedAppleId ]`: + - `[Manager ]`: Relation with another systemuser to identify the last as a manager. + - `[MfaConfigured ]`: + - `[MfaExclusion ]`: + - `[MfaExclusionDays ]`: + - `[MfaExclusionUntil ]`: + - `[Middlename ]`: + - `[Password ]`: + - `[PasswordNeverExpires ]`: + - `[PasswordlessSudo ]`: + - `[PhoneNumbers >]`: + - `[Number ]`: + - `[Type ]`: + - `[PublicKey ]`: + - `[RecoveryEmailAddress ]`: + - `[Relationships >]`: + - `[Type ]`: + - `[Value ]`: + - `[RestrictedField ]`: + - `[RestrictedFieldId ]`: + - `[RestrictedFieldType ]`: + - `[SambaServiceUser ]`: + - `[State ]`: + - `[Sudo ]`: + - `[Suspended ]`: + - `[UnixGuid ]`: + - `[UnixUid ]`: + - `[Username ]`: + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkdayResult.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkdayResult.md new file mode 100644 index 000000000..50ec8465f --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkdayResult.md @@ -0,0 +1,175 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Import-JcSdkWorkdayResult.md +schema: 2.0.0 +--- + +# Import-JcSdkWorkdayResult + +## SYNOPSIS +This endpoint provides a list of job results from the workday import and will contain all imported data from Workday. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import/{ImportJobID}/results \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Import (Default) +``` +Import-JcSdkWorkdayResult -ConsoleHost -Id -JobId [] +``` + +### ImportViaIdentity +``` +Import-JcSdkWorkdayResult -ConsoleHost -InputObject [] +``` + +## DESCRIPTION +This endpoint provides a list of job results from the workday import and will contain all imported data from Workday. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import/{ImportJobID}/results \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Import-JcSdkWorkdayResult -Id:() -JobId:() +``` + +---- ---------- +CreatedAt String +Id String +Meta JumpCloud.SDK.V2.Models.JobWorkresultMeta +PersistedFields JumpCloud.SDK.V2.Models.JobWorkresultPersistedFields +Status String +StatusMsg String +UpdatedAt String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Import +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: ImportViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobId +. + +```yaml +Type: System.String +Parameter Sets: Import +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IJobWorkresult + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Invoke-JcSdkReclaimSoftwareAppLicense.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Invoke-JcSdkReclaimSoftwareAppLicense.md new file mode 100644 index 000000000..7bc65b8f8 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Invoke-JcSdkReclaimSoftwareAppLicense.md @@ -0,0 +1,190 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Invoke-JcSdkReclaimSoftwareAppLicense.md +schema: 2.0.0 +--- + +# Invoke-JcSdkReclaimSoftwareAppLicense + +## SYNOPSIS +This endpoint allows you to reclaim the licenses from a software app associated with devices that are deleted. +#### Sample Request +``` +$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/reclaim-licenses \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '{}' +``` + +## SYNTAX + +### Reclaim (Default) +``` +Invoke-JcSdkReclaimSoftwareAppLicense -ConsoleHost -SoftwareAppId [-Confirm] [-WhatIf] + [] +``` + +### ReclaimViaIdentity +``` +Invoke-JcSdkReclaimSoftwareAppLicense -ConsoleHost -InputObject [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to reclaim the licenses from a software app associated with devices that are deleted. +#### Sample Request +``` +$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/reclaim-licenses \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '{}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Invoke-JcSdkReclaimSoftwareAppLicense -SoftwareAppId:() +``` + +---- ---------- +AssignedLicenses Int +AvailableLicenses Int +ReclaimedLicenses Int +TotalLicenses Int + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: ReclaimViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SoftwareAppId +. + +```yaml +Type: System.String +Parameter Sets: Reclaim +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISoftwareAppReclaimLicenses + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/JumpCloud.SDK.V2.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/JumpCloud.SDK.V2.md new file mode 100644 index 000000000..bffb87f68 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/JumpCloud.SDK.V2.md @@ -0,0 +1,3316 @@ +--- +Module Name: JumpCloud.SDK.V2 +Module Guid: ff397964-2121-4c89-a916-34b5c30d7187 +Download Help Link: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/jumpcloud.sdk.v2 +Help Version: 1.0.0.0 +Locale: en-US +--- + +# JumpCloud.SDK.V2 Module +## Description +The JumpCloud V2 PowerShell SDK + +## JumpCloud.SDK.V2 Cmdlets +### [Clear-JcSdkAppleMdmDevice](Clear-JcSdkAppleMdmDevice.md) +Erases a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/erase \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +### [Clear-JcSdkAppleMdmDeviceActivationLock](Clear-JcSdkAppleMdmDeviceActivationLock.md) +Clears the activation lock on the specified device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/clearActivationLock \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +### [Get-JcSdkAccessRequest](Get-JcSdkAccessRequest.md) +Endpoint that returns the workflow access request by id + +### [Get-JcSdkAccessRequestProgress](Get-JcSdkAccessRequestProgress.md) +Endpoint for getting the approval progress of a access request + +### [Get-JcSdkActiveDirectory](Get-JcSdkActiveDirectory.md) +This endpoint returns a specific Active Directory. + +#### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +### [Get-JcSdkActiveDirectoryAgent](Get-JcSdkActiveDirectoryAgent.md) +This endpoint returns an Active Directory agent. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkActiveDirectoryAssociation](Get-JcSdkActiveDirectoryAssociation.md) +This endpoint returns the direct associations of this Active Directory instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. + + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/associations?targets=user \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkActiveDirectoryTraverseUser](Get-JcSdkActiveDirectoryTraverseUser.md) +This endpoint will return all Users bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Active Directory instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Active Directory instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/users \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkActiveDirectoryTraverseUserGroup](Get-JcSdkActiveDirectoryTraverseUserGroup.md) +This endpoint will return all Users Groups bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Active Directory instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Active Directory instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/usergroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkAdministratorOrganization](Get-JcSdkAdministratorOrganization.md) +This endpoint returns the association links between an Administrator and Organizations. + +### [Get-JcSdkAdministratorOrganizationLink](Get-JcSdkAdministratorOrganizationLink.md) +This endpoint returns the association links between an Organization and Administrators. + +### [Get-JcSdkAppleMdm](Get-JcSdkAppleMdm.md) +Get a list of all Apple MDM configurations. +An empty topic indicates that a signed certificate from Apple has not been provided to the PUT endpoint yet. + +Note: currently only one MDM configuration per organization is supported. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/applemdms \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkAppleMdmDevice](Get-JcSdkAppleMdmDevice.md) +Gets a single Apple MDM device. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ + -H 'accept: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkAppleMdmEnrollmentProfile](Get-JcSdkAppleMdmEnrollmentProfile.md) +Get a list of enrollment profiles for an apple mdm. + +Note: currently only one enrollment profile is supported. + +#### Sample Request +``` + curl https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/enrollmentprofiles \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkApplicationAssociation](Get-JcSdkApplicationAssociation.md) +This endpoint will return the _direct_ associations of an Application. +A direct association can be a non-homogeneous relationship between 2 different objects, for example Applications and User Groups. + + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations?targets=user_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkApplicationTraverseUser](Get-JcSdkApplicationTraverseUser.md) +This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkApplicationTraverseUserGroup](Get-JcSdkApplicationTraverseUserGroup.md) +This endpoint will return all Users Groups bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Application to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Application. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/usergroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkApprovalFlow](Get-JcSdkApprovalFlow.md) +Endpoint for getting workflow by id + +### [Get-JcSdkApprovalFlowSetting](Get-JcSdkApprovalFlowSetting.md) +Endpoint for getting workflow settings for an organisation + +### [Get-JcSdkAuthenticationPolicy](Get-JcSdkAuthenticationPolicy.md) +Return a specific authentication policy. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkBulkUsersResult](Get-JcSdkBulkUsersResult.md) +This endpoint will return the results of particular user import or get job request. + +#### Sample Request +``` +curl -X GET \\ + https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +### [Get-JcSdkBulkUserState](Get-JcSdkBulkUserState.md) +The endpoint allows you to list scheduled statechange jobs. +#### Sample Request +``` +curl -X GET \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ + -H 'x-api-key: {API_KEY}' \\ + -H 'Content-Type: application/json' \\ + -H 'Accept: application/json' +``` + +### [Get-JcSdkCommandAssociation](Get-JcSdkCommandAssociation.md) +This endpoint will return the _direct_ associations of this Command. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations?targets=system_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkCommandTraverseSystem](Get-JcSdkCommandTraverseSystem.md) +This endpoint will return all Systems bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Command to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Command. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systems \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkCommandTraverseSystemGroup](Get-JcSdkCommandTraverseSystemGroup.md) +This endpoint will return all System Groups bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Command to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Command. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systemgroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkCustomEmailConfiguration](Get-JcSdkCustomEmailConfiguration.md) +Get the custom email configuration for the specified custom email type + +### [Get-JcSdkCustomEmailTemplate](Get-JcSdkCustomEmailTemplate.md) +Get the list of custom email templates + +### [Get-JcSdkDirectory](Get-JcSdkDirectory.md) +This endpoint returns all active directories (LDAP, O365 Suite, G-Suite). + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/directories \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkDuoAccount](Get-JcSdkDuoAccount.md) +This endpoint returns a specific Duo account. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkDuoApplication](Get-JcSdkDuoApplication.md) +This endpoint returns a specific Duo application that is associated with the specified Duo account. + +#### Sample Request +``` + curl https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkGroup](Get-JcSdkGroup.md) +This endpoint returns all Groups that exist in your organization. + +#### Available filter fields: + - `name` + - `disabled` + - `type` + - `memberQueryErrorFlags` + +#### Sample Request + +``` + curl -X GET \\ + https://console.jumpcloud.com/api/v2/groups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkGSuite](Get-JcSdkGSuite.md) +This endpoint returns a specific G Suite. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkGSuiteAssociation](Get-JcSdkGSuiteAssociation.md) +This endpoint returns the _direct_ associations of this G Suite instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. + + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations?targets=user_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkGSuiteTranslationRule](Get-JcSdkGSuiteTranslationRule.md) +This endpoint returns a specific translation rule for a specific G Suite instance. +These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. + +###### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +### [Get-JcSdkGSuiteTraverseUser](Get-JcSdkGSuiteTraverseUser.md) +This endpoint will return all Users bound to a G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this G Suite instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this G Suite instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/users \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkGSuiteTraverseUserGroup](Get-JcSdkGSuiteTraverseUserGroup.md) +This endpoint will return all User Groups bound to an G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this G Suite instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this G Suite instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSuite_ID}/usergroups \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkGSuiteUsersToImport](Get-JcSdkGSuiteUsersToImport.md) +Lists G Suite users available for import. + +### [Get-JcSdkGsuiteUsersToImportFormatted](Get-JcSdkGsuiteUsersToImportFormatted.md) +Lists available G Suite users for import, translated to the Jumpcloud user schema. + +### [Get-JcSdkIPList](Get-JcSdkIPList.md) +Return a specific IP list. + +#### Sample Request +``` +curl https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkLdapServer](Get-JcSdkLdapServer.md) +This endpoint returns a specific LDAP server. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkLdapServerAssociation](Get-JcSdkLdapServerAssociation.md) +This endpoint returns the _direct_ associations of this LDAP Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. + +#### Sample Request + +``` + curl -X GET 'https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations?targets=user_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkLdapServerSambaDomain](Get-JcSdkLdapServerSambaDomain.md) +This endpoint returns a specific samba domain for an LDAP server. + +##### Sample Request +``` +curl -X GET \\ + https://console.jumpcloud.com/api/v2/ldapservers/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +### [Get-JcSdkLdapServerTraverseUser](Get-JcSdkLdapServerTraverseUser.md) +This endpoint will return all Users bound to an LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this LDAP server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this LDAP server instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkLdapServerTraverseUserGroup](Get-JcSdkLdapServerTraverseUserGroup.md) +This endpoint will return all Users Groups bound to a LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this LDAP server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this LDAP server instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkNextScheduledBulkUserState](Get-JcSdkNextScheduledBulkUserState.md) +This endpoint is used to lookup the next upcoming scheduled state change for each user in the +given list. +The users parameter is limited to 100 items per request. +The results are also limited +to 100 items. +This endpoint returns a max of 1 event per state per user. +For example, if a user +has 3 ACTIVATED events scheduled it will return the next upcoming activation event. +However, if a +user also has a SUSPENDED event scheduled along with the ACTIVATED events it will return the next +upcoming activation event _and_ the next upcoming suspension event. + +### [Get-JcSdkOffice365](Get-JcSdkOffice365.md) +This endpoint returns a specific Office 365 instance. + +##### + +Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkOffice365Association](Get-JcSdkOffice365Association.md) +This endpoint returns _direct_ associations of an Office 365 instance. + + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations?targets=user_group' \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkOffice365TranslationRule](Get-JcSdkOffice365TranslationRule.md) +This endpoint returns a specific translation rule for a specific Office 365 instance. +These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. + +###### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +### [Get-JcSdkOffice365TraverseUser](Get-JcSdkOffice365TraverseUser.md) +This endpoint will return all Users bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Office 365 instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Office 365 instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkOffice365TraverseUserGroup](Get-JcSdkOffice365TraverseUserGroup.md) +This endpoint will return all Users Groups bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Office 365 instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Office 365 instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkOffice365UsersToImport](Get-JcSdkOffice365UsersToImport.md) +Lists Office 365 users available for import. + +### [Get-JcSdkOrganizationPolicyResult](Get-JcSdkOrganizationPolicyResult.md) +This endpoint returns all policy results for an organization. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +### [Get-JcSdkPolicy](Get-JcSdkPolicy.md) +This endpoint returns a specific policy. + +###### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/policies/{PolicyID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +### [Get-JcSdkPolicyAssociation](Get-JcSdkPolicyAssociation.md) +This endpoint returns the _direct_ associations of a Policy. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. + +#### Sample Request +``` +curl -X GET 'https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations?targets=system_group \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkPolicyGroup](Get-JcSdkPolicyGroup.md) +This endpoint returns the details of a Policy Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkPolicyGroupAssociation](Get-JcSdkPolicyGroupAssociation.md) +This endpoint returns the _direct_ associations of this Policy Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations?targets=system \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkPolicyGroupMember](Get-JcSdkPolicyGroupMember.md) +This endpoint returns all the Policy Groups a Policy is a member of. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/memberof \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkPolicyGroupMembership](Get-JcSdkPolicyGroupMembership.md) +This endpoint returns all Policy members that are a member of this Policy Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/membership \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkPolicyGroupTraverseSystem](Get-JcSdkPolicyGroupTraverseSystem.md) +This endpoint will return all Systems bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkPolicyGroupTraverseSystemGroup](Get-JcSdkPolicyGroupTraverseSystemGroup.md) +This endpoint will return all System Groups bound to a Policy Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkPolicyResult](Get-JcSdkPolicyResult.md) +This endpoint will return the policy results for a specific policy. + +##### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policyresults/{Policy_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +### [Get-JcSdkPolicyStatus](Get-JcSdkPolicyStatus.md) +This endpoint returns the latest policy results for a specific policy. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +### [Get-JcSdkPolicyTemplate](Get-JcSdkPolicyTemplate.md) +This endpoint returns a specific policy template. + +#### Sample Request +``` + curl -X GET https://console.jumpcloud.com/api/v2/policytemplates/{Policy_Template_ID}\\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkPolicyTraverseSystem](Get-JcSdkPolicyTraverseSystem.md) +This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkPolicyTraverseSystemGroup](Get-JcSdkPolicyTraverseSystemGroup.md) +This endpoint will return all Systems Groups bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Policy to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkProviderAdministrator](Get-JcSdkProviderAdministrator.md) +This endpoint returns a list of the Administrators associated with the Provider. +You must be associated with the provider to use this route. + +### [Get-JcSdkProviderOrganization](Get-JcSdkProviderOrganization.md) +This endpoint returns a list of the Organizations associated with the Provider. +You must be associated with the provider to use this route. + +### [Get-JcSdkProvidersInvoice](Get-JcSdkProvidersInvoice.md) +Retrieves a list of invoices for this provider. +You must be associated to the provider to use this endpoint. + +### [Get-JcSdkRadiusServerAssociation](Get-JcSdkRadiusServerAssociation.md) +This endpoint returns the _direct_ associations of a Radius Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations?targets=user_group \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkRadiusServerTraverseUser](Get-JcSdkRadiusServerTraverseUser.md) +This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. + +See `/members` and `/associations` endpoints to manage those collections. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +### [Get-JcSdkRadiusServerTraverseUserGroup](Get-JcSdkRadiusServerTraverseUserGroup.md) +This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkSoftwareApp](Get-JcSdkSoftwareApp.md) +Retrieves a Software Application. +The optional isConfigEnabled and appConfiguration apple_vpp attributes are populated in this response. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkSoftwareAppAssociation](Get-JcSdkSoftwareAppAssociation.md) +This endpoint will return the _direct_ associations of a Software Application. +A direct association can be a non-homogeneous relationship between 2 different objects, for example Software Application and System Groups. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations?targets=system_group \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkSoftwareAppStatus](Get-JcSdkSoftwareAppStatus.md) +This endpoint allows you to get the status of the provided Software Application on associated JumpCloud systems. + +#### Sample Request +``` +$ curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/statuses \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +``` + +### [Get-JcSdkSoftwareAppTraverseSystem](Get-JcSdkSoftwareAppTraverseSystem.md) +This endpoint will return all Systems bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Software App to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Software App. + +See `/associations` endpoint to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkSoftwareAppTraverseSystemGroup](Get-JcSdkSoftwareAppTraverseSystemGroup.md) +This endpoint will return all Systems Groups bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this Software App to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Software App. + +See `/associations` endpoint to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkSubscription](Get-JcSdkSubscription.md) +This endpoint returns all pricing & packaging subscriptions. + +##### Sample Request + +``` + curl -X GET https://console.jumpcloud.com/api/v2/subscriptions \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +### [Get-JcSdkSystemAssociation](Get-JcSdkSystemAssociation.md) +This endpoint returns the _direct_ associations of a System. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations?targets=user \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkSystemFdeKey](Get-JcSdkSystemFdeKey.md) +This endpoint will return the current (latest) fde key saved for a system. + +### [Get-JcSdkSystemGroup](Get-JcSdkSystemGroup.md) +This endpoint returns the details of a System Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkSystemGroupAssociation](Get-JcSdkSystemGroupAssociation.md) +This endpoint returns the _direct_ associations of a System Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations?targets=user \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkSystemGroupMember](Get-JcSdkSystemGroupMember.md) +This endpoint returns the system members of a System Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkSystemGroupMembership](Get-JcSdkSystemGroupMembership.md) +This endpoint returns all Systems that are a member of this System Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID/membership \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkSystemGroupTraverseCommand](Get-JcSdkSystemGroupTraverseCommand.md) +This endpoint will return all Commands bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the group's type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/commands \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkSystemGroupTraversePolicy](Get-JcSdkSystemGroupTraversePolicy.md) +This endpoint will return all Policies bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +This endpoint is not public yet as we haven't finished the code. + +##### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policies \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkSystemGroupTraversePolicyGroup](Get-JcSdkSystemGroupTraversePolicyGroup.md) +This endpoint will return all Policy Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policygroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkSystemGroupTraverseUser](Get-JcSdkSystemGroupTraverseUser.md) +This endpoint will return all Users bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkSystemGroupTraverseUserGroup](Get-JcSdkSystemGroupTraverseUserGroup.md) +This endpoint will return all User Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System Group to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkSystemInsightAlf](Get-JcSdkSystemInsightAlf.md) +Valid filter fields are `system_id` and `global_state`. + +### [Get-JcSdkSystemInsightAlfException](Get-JcSdkSystemInsightAlfException.md) +Valid filter fields are `system_id` and `state`. + +### [Get-JcSdkSystemInsightAlfExplicitAuth](Get-JcSdkSystemInsightAlfExplicitAuth.md) +Valid filter fields are `system_id` and `process`. + +### [Get-JcSdkSystemInsightApp](Get-JcSdkSystemInsightApp.md) +Lists all apps for macOS devices. +For Windows devices, use [List System Insights Programs](#operation/systeminsights_list_programs). + +Valid filter fields are `system_id` and `bundle_name`. + +### [Get-JcSdkSystemInsightAppCompatShim](Get-JcSdkSystemInsightAppCompatShim.md) +Valid filter fields are `system_id` and `enabled`. + +### [Get-JcSdkSystemInsightAuthorizedKey](Get-JcSdkSystemInsightAuthorizedKey.md) +Valid filter fields are `system_id` and `uid`. + +### [Get-JcSdkSystemInsightAzureInstanceMetadata](Get-JcSdkSystemInsightAzureInstanceMetadata.md) +Valid filter fields are `system_id`. + +### [Get-JcSdkSystemInsightAzureInstanceTag](Get-JcSdkSystemInsightAzureInstanceTag.md) +Valid filter fields are `system_id`. + +### [Get-JcSdkSystemInsightBattery](Get-JcSdkSystemInsightBattery.md) +Valid filter fields are `system_id` and `health`. + +### [Get-JcSdkSystemInsightBitlockerInfo](Get-JcSdkSystemInsightBitlockerInfo.md) +Valid filter fields are `system_id` and `protection_status`. + +### [Get-JcSdkSystemInsightBrowserPlugin](Get-JcSdkSystemInsightBrowserPlugin.md) +Valid filter fields are `system_id` and `name`. + +### [Get-JcSdkSystemInsightCertificate](Get-JcSdkSystemInsightCertificate.md) +Valid filter fields are `system_id` and `common_name`. + +### [Get-JcSdkSystemInsightChassisInfo](Get-JcSdkSystemInsightChassisInfo.md) +Valid filter fields are `system_id`. + +### [Get-JcSdkSystemInsightChromeExtension](Get-JcSdkSystemInsightChromeExtension.md) +Valid filter fields are `system_id` and `name`. + +### [Get-JcSdkSystemInsightConnectivity](Get-JcSdkSystemInsightConnectivity.md) +The only valid filter field is `system_id`. + +### [Get-JcSdkSystemInsightCrash](Get-JcSdkSystemInsightCrash.md) +Valid filter fields are `system_id` and `identifier`. + +### [Get-JcSdkSystemInsightCupDestination](Get-JcSdkSystemInsightCupDestination.md) +Valid filter fields are `system_id` and `name`. + +### [Get-JcSdkSystemInsightDiskEncryption](Get-JcSdkSystemInsightDiskEncryption.md) +Valid filter fields are `system_id` and `encryption_status`. + +### [Get-JcSdkSystemInsightDiskInfo](Get-JcSdkSystemInsightDiskInfo.md) +Valid filter fields are `system_id` and `disk_index`. + +### [Get-JcSdkSystemInsightDnsResolver](Get-JcSdkSystemInsightDnsResolver.md) +Valid filter fields are `system_id` and `type`. + +### [Get-JcSdkSystemInsightEtcHost](Get-JcSdkSystemInsightEtcHost.md) +Valid filter fields are `system_id` and `address`. + +### [Get-JcSdkSystemInsightFirefoxAddon](Get-JcSdkSystemInsightFirefoxAddon.md) +Valid filter fields are `system_id` and `name`. + +### [Get-JcSdkSystemInsightGroup](Get-JcSdkSystemInsightGroup.md) +Valid filter fields are `system_id` and `groupname`. + +### [Get-JcSdkSystemInsightIeExtension](Get-JcSdkSystemInsightIeExtension.md) +Valid filter fields are `system_id` and `name`. + +### [Get-JcSdkSystemInsightInterfaceAddress](Get-JcSdkSystemInsightInterfaceAddress.md) +Valid filter fields are `system_id` and `address`. + +### [Get-JcSdkSystemInsightInterfaceDetail](Get-JcSdkSystemInsightInterfaceDetail.md) +Valid filter fields are `system_id` and `interface`. + +### [Get-JcSdkSystemInsightKernelInfo](Get-JcSdkSystemInsightKernelInfo.md) +Valid filter fields are `system_id` and `version`. + +### [Get-JcSdkSystemInsightLaunchd](Get-JcSdkSystemInsightLaunchd.md) +Valid filter fields are `system_id` and `name`. + +### [Get-JcSdkSystemInsightLinuxPackage](Get-JcSdkSystemInsightLinuxPackage.md) +Lists all programs for Linux devices. +For macOS devices, use [List System Insights System Apps](#operation/systeminsights_list_apps). +For windows devices, use [List System Insights System Apps](#operation/systeminsights_list_programs). + +Valid filter fields are `name` and `package_format`. + +### [Get-JcSdkSystemInsightLoggedinUser](Get-JcSdkSystemInsightLoggedinUser.md) +Valid filter fields are `system_id` and `user`. + +### [Get-JcSdkSystemInsightLogicalDrive](Get-JcSdkSystemInsightLogicalDrive.md) +Valid filter fields are `system_id` and `device_id`. + +### [Get-JcSdkSystemInsightManagedPolicy](Get-JcSdkSystemInsightManagedPolicy.md) +Valid filter fields are `system_id` and `domain`. + +### [Get-JcSdkSystemInsightMount](Get-JcSdkSystemInsightMount.md) +Valid filter fields are `system_id` and `path`. + +### [Get-JcSdkSystemInsightOSVersion](Get-JcSdkSystemInsightOSVersion.md) +Valid filter fields are `system_id` and `version`. + +### [Get-JcSdkSystemInsightPatch](Get-JcSdkSystemInsightPatch.md) +Valid filter fields are `system_id` and `hotfix_id`. + +### [Get-JcSdkSystemInsightProgram](Get-JcSdkSystemInsightProgram.md) +Lists all programs for Windows devices. +For macOS devices, use [List System Insights Apps](#operation/systeminsights_list_apps). + +Valid filter fields are `system_id` and `name`. + +### [Get-JcSdkSystemInsightPythonPackage](Get-JcSdkSystemInsightPythonPackage.md) +Valid filter fields are `system_id` and `name`. + +### [Get-JcSdkSystemInsightSafariExtension](Get-JcSdkSystemInsightSafariExtension.md) +Valid filter fields are `system_id` and `name`. + +### [Get-JcSdkSystemInsightScheduledTask](Get-JcSdkSystemInsightScheduledTask.md) +Valid filter fields are `system_id` and `enabled`. + +### [Get-JcSdkSystemInsightSecureboot](Get-JcSdkSystemInsightSecureboot.md) +Valid filter fields are `system_id`. + +### [Get-JcSdkSystemInsightService](Get-JcSdkSystemInsightService.md) +Valid filter fields are `system_id` and `name`. + +### [Get-JcSdkSystemInsightShadow](Get-JcSdkSystemInsightShadow.md) +Valid filter fields are `system_id` and `username`. + +### [Get-JcSdkSystemInsightSharedFolder](Get-JcSdkSystemInsightSharedFolder.md) +Valid filter fields are `system_id` and `name`. + +### [Get-JcSdkSystemInsightSharedResource](Get-JcSdkSystemInsightSharedResource.md) +Valid filter fields are `system_id` and `type`. + +### [Get-JcSdkSystemInsightSharingPreference](Get-JcSdkSystemInsightSharingPreference.md) +Only valid filed field is `system_id`. + +### [Get-JcSdkSystemInsightSipConfig](Get-JcSdkSystemInsightSipConfig.md) +Valid filter fields are `system_id` and `enabled`. + +### [Get-JcSdkSystemInsightStartupItem](Get-JcSdkSystemInsightStartupItem.md) +Valid filter fields are `system_id` and `name`. + +### [Get-JcSdkSystemInsightSystemControl](Get-JcSdkSystemInsightSystemControl.md) +Valid filter fields are `system_id` and `name`. + +### [Get-JcSdkSystemInsightSystemInfo](Get-JcSdkSystemInsightSystemInfo.md) +Valid filter fields are `system_id` and `cpu_subtype`. + +### [Get-JcSdkSystemInsightTpmInfo](Get-JcSdkSystemInsightTpmInfo.md) +Valid filter fields are `system_id`. + +### [Get-JcSdkSystemInsightUptime](Get-JcSdkSystemInsightUptime.md) +Valid filter fields are `system_id` and `days`. + +### [Get-JcSdkSystemInsightUsbDevice](Get-JcSdkSystemInsightUsbDevice.md) +Valid filter fields are `system_id` and `model`. + +### [Get-JcSdkSystemInsightUser](Get-JcSdkSystemInsightUser.md) +Valid filter fields are `system_id` and `username`. + +### [Get-JcSdkSystemInsightUserAssist](Get-JcSdkSystemInsightUserAssist.md) +Valid filter fields are `system_id`. + +### [Get-JcSdkSystemInsightUserGroup](Get-JcSdkSystemInsightUserGroup.md) +Only valid filter field is `system_id`. + +### [Get-JcSdkSystemInsightUserSshKey](Get-JcSdkSystemInsightUserSshKey.md) +Valid filter fields are `system_id` and `uid`. + +### [Get-JcSdkSystemInsightWifiNetwork](Get-JcSdkSystemInsightWifiNetwork.md) +Valid filter fields are `system_id` and `security_type`. + +### [Get-JcSdkSystemInsightWifiStatus](Get-JcSdkSystemInsightWifiStatus.md) +Valid filter fields are `system_id` and `security_type`. + +### [Get-JcSdkSystemInsightWindowsSecurityCenter](Get-JcSdkSystemInsightWindowsSecurityCenter.md) +Valid filter fields are `system_id`. + +### [Get-JcSdkSystemInsightWindowsSecurityProduct](Get-JcSdkSystemInsightWindowsSecurityProduct.md) +Valid filter fields are `system_id` and `state`. + +### [Get-JcSdkSystemMember](Get-JcSdkSystemMember.md) +This endpoint returns all the System Groups a System is a member of. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/memberof \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkSystemPolicyStatus](Get-JcSdkSystemPolicyStatus.md) +This endpoint returns the policy results for a particular system. + +##### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkSystemTraverseCommand](Get-JcSdkSystemTraverseCommand.md) +This endpoint will return all Commands bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/commands \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkSystemTraversePolicy](Get-JcSdkSystemTraversePolicy.md) +This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +This endpoint is not yet public as we have finish the code. + +##### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkSystemTraversePolicyGroup](Get-JcSdkSystemTraversePolicyGroup.md) +This endpoint will return all Policy Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding Policy Group; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy Group from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policygroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkSystemTraverseUser](Get-JcSdkSystemTraverseUser.md) +This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkSystemTraverseUserGroup](Get-JcSdkSystemTraverseUserGroup.md) +This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkUserAssociation](Get-JcSdkUserAssociation.md) +This endpoint returns the _direct_ associations of a User. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/associations?targets=system_group \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkUserGroup](Get-JcSdkUserGroup.md) +This endpoint returns the details of a User Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserGroupAssociation](Get-JcSdkUserGroupAssociation.md) +This endpoint returns the _direct_ associations of this User Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. + + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations?targets=system \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserGroupMember](Get-JcSdkUserGroupMember.md) +This endpoint returns the user members of a User Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserGroupMembership](Get-JcSdkUserGroupMembership.md) +This endpoint returns all users members that are a member of this User Group. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/membership \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserGroupTraverseActiveDirectory](Get-JcSdkUserGroupTraverseActiveDirectory.md) +This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserGroupTraverseApplication](Get-JcSdkUserGroupTraverseApplication.md) +This endpoint will return all Applications bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/applications \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserGroupTraverseDirectory](Get-JcSdkUserGroupTraverseDirectory.md) +This endpoint will return all Directories bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directories from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/directories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkUserGroupTraverseGSuite](Get-JcSdkUserGroupTraverseGSuite.md) +This endpoint will return all G Suite Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID/gsuites \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkUserGroupTraverseLdapServer](Get-JcSdkUserGroupTraverseLdapServer.md) +This endpoint will return all LDAP Servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/ldapservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserGroupTraverseOffice365](Get-JcSdkUserGroupTraverseOffice365.md) +This endpoint will return all Office 365 instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/office365s \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserGroupTraverseRadiusServer](Get-JcSdkUserGroupTraverseRadiusServer.md) +This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Get-JcSdkUserGroupTraverseSystem](Get-JcSdkUserGroupTraverseSystem.md) +This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserGroupTraverseSystemGroup](Get-JcSdkUserGroupTraverseSystemGroup.md) +This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserMember](Get-JcSdkUserMember.md) +This endpoint returns all the User Groups a User is a member of. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/memberof \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserPushEndpoint](Get-JcSdkUserPushEndpoint.md) +This endpoint will retrieve a push endpoint associated with a user. + +### [Get-JcSdkUserTraverseActiveDirectory](Get-JcSdkUserTraverseActiveDirectory.md) +This endpoint will return all Active Directory Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Active Directory instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory instance from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/activedirectories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserTraverseApplication](Get-JcSdkUserTraverseApplication.md) +This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserTraverseDirectory](Get-JcSdkUserTraverseDirectory.md) +This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserTraverseGSuite](Get-JcSdkUserTraverseGSuite.md) +This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserTraverseLdapServer](Get-JcSdkUserTraverseLdapServer.md) +This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserTraverseOffice365](Get-JcSdkUserTraverseOffice365.md) +This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserTraverseRadiusServer](Get-JcSdkUserTraverseRadiusServer.md) +This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserTraverseSystem](Get-JcSdkUserTraverseSystem.md) +This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkUserTraverseSystemGroup](Get-JcSdkUserTraverseSystemGroup.md) +This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. + +Each element will contain the type, id, attributes and paths. + +The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. + +The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. + +See `/members` and `/associations` endpoints to manage those collections. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Get-JcSdkWorkday](Get-JcSdkWorkday.md) +This endpoint will return all the available information about an instance of Workday. + +#### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/workdays/ \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +### [Get-JcSdkWorkdayWorker](Get-JcSdkWorkdayWorker.md) +This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. + +##### Sample Request + +``` +curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + + +``` + +### [Grant-JcSdkWorkday](Grant-JcSdkWorkday.md) +This endpoint adds an authorization method to a workday instance. + +You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. +Failure to provide these credentials will result in the request being rejected. + +Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ +\t\"auth\":{ +\t \"basic\": { +\t\t\"username\": \"someDeveloper\",\t +\t\t\"password\": \"notTheRealPassword\" + +\t } +\t} +}' + +``` + +### [Import-JcSdkScim](Import-JcSdkScim.md) +Get a list of users to import from an Application IdM service provider. + +### [Import-JcSdkWorkday](Import-JcSdkWorkday.md) +The endpoint allows you to import a Workday Import request. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '[ +\t{ +\t\t\"email\":\"{email}\", +\t\t\"firstname\":\"{firstname}\", +\t\t\"lastname\":\"{firstname}\", +\t\t\"username\":\"{username}\", +\t\t\"attributes\":[ +\t\t\t{\"name\":\"EmployeeID\",\"value\":\"0000\"}, +\t\t\t{\"name\":\"WorkdayID\",\"value\":\"name.name\"} +\t\t\t] +\t\t +\t} +] +``` + +### [Import-JcSdkWorkdayResult](Import-JcSdkWorkdayResult.md) +This endpoint provides a list of job results from the workday import and will contain all imported data from Workday. + +#### Sample Request +``` +curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import/{ImportJobID}/results \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Invoke-JcSdkReclaimSoftwareAppLicense](Invoke-JcSdkReclaimSoftwareAppLicense.md) +This endpoint allows you to reclaim the licenses from a software app associated with devices that are deleted. +#### Sample Request +``` +$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/reclaim-licenses \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '{}' +``` + +### [Lock-JcSdkAppleMdmDevice](Lock-JcSdkAppleMdmDevice.md) +Locks a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/lock \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +### [New-JcSdkActiveDirectory](New-JcSdkActiveDirectory.md) +This endpoint allows you to create a new Active Directory. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/ \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"domain\": \"{DC=AD_domain_name;DC=com}\" + }' +``` + +### [New-JcSdkActiveDirectoryAgent](New-JcSdkActiveDirectoryAgent.md) +This endpoint allows you to create a new Active Directory Agent. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ \"agent_type\":\"{SYNC}\" }' +``` + +### [New-JcSdkAdministratorOrganization](New-JcSdkAdministratorOrganization.md) +This endpoint allows you to grant Administrator access to an Organization. + +### [New-JcSdkApprovalFlow](New-JcSdkApprovalFlow.md) +Endpoint for adding a new access workflow + +### [New-JcSdkAuthenticationPolicy](New-JcSdkAuthenticationPolicy.md) +Create an authentication policy. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/authn/policies \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Sample Policy\", + \"disabled\": false, + \"effect\": { + \"action\": \"allow\" + }, + \"targets\": { + \"users\": { + \"inclusions\": [\"ALL\"] + }, + \"userGroups\": { + \"exclusions\": [{USER_GROUP_ID}] + }, + \"resources\": [ {\"type\": \"user_portal\" } ] + }, + \"conditions\":{ + \"ipAddressIn\": [{IP_LIST_ID}] + } + }' +``` + +### [New-JcSdkBulkUser](New-JcSdkBulkUser.md) +The endpoint allows you to create a bulk job to asynchronously create users. +See [create a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_post) +for the full list of attributes. + +#### Default User State +The `state` of each user in the request can be explicitly passed in or +omitted. +If `state` is omitted, then the user will get created +using the value returned from the +[Get an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organizations_get) +endpoint. +The default user state for bulk created users depends on the +`creation-source` header. +For `creation-source:jumpcloud:bulk` the +default state is stored in `settings.newSystemUserStateDefaults.csvImport`. +For other `creation-source` header values, the default state is stored in +`settings.newSystemUserStateDefaults.applicationImport` + +These default state values can be changed in the admin portal settings +or by using the +[create an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organization_put) +endpoint. + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '[ + { + \"email\":\"{email}\", + \"firstname\":\"{firstname}\", + \"lastname\":\"{firstname}\", + \"username\":\"{username}\", + \"attributes\":[ + { + \"name\":\"EmployeeID\", + \"value\":\"0000\" + }, + { + \"name\":\"Custom\", + \"value\":\"attribute\" + } + ] + } +]' +``` + +### [New-JcSdkBulkUserState](New-JcSdkBulkUserState.md) +This endpoint allows you to create scheduled statechange jobs. +#### Sample Request +``` +curl -X POST \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ + -H 'x-api-key: {API_KEY}' \\ + -H 'Content-Type: application/json' \\ + -H 'Accept: application/json' \\ + -d '{ + \"user_ids\": [\"{User_ID_1}\", \"{User_ID_2}\", \"{User_ID_3}\"], + \"state\": \"SUSPENDED\", + \"start_date\": \"2000-01-01T00:00:00.000Z\" + }' +``` + +### [New-JcSdkCustomEmailConfiguration](New-JcSdkCustomEmailConfiguration.md) +Create the custom email configuration for the specified custom email type. + +This action is only available to paying customers. + +### [New-JcSdkDuoAccount](New-JcSdkDuoAccount.md) +Registers a Duo account for an organization. +Only one Duo account will be allowed, +in case an organization has a Duo account already a 409 (Conflict) code will be returned. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +### [New-JcSdkDuoApplication](New-JcSdkDuoApplication.md) +Create a Duo application for your organization and the specified account. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Application Name\", + \"apiHost\": \"api-1234.duosecurity.com\", + \"integrationKey\": \"1234\", + \"secretKey\": \"5678\" + }' +``` + +### [New-JcSdkGSuiteTranslationRule](New-JcSdkGSuiteTranslationRule.md) +This endpoint allows you to create a translation rule for a specific G Suite instance. +These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Translation Rule Parameters} + }' +``` + +### [New-JcSdkIPList](New-JcSdkIPList.md) +Create an IP list. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/iplists \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Sample IP List\", + \"ips\": [ + \"192.168.10.12\", + \"192.168.10.20 - 192.168.10.30\", + \"123.225.10.0/32\" + ] + }' +``` + +### [New-JcSdkLdapServerSambaDomain](New-JcSdkLdapServerSambaDomain.md) +This endpoint allows you to create a samba domain for an LDAP server. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"sid\":\"{SID_ID}\", + \"name\":\"{WORKGROUP_NAME}\" + }' +``` + +### [New-JcSdkOffice365TranslationRule](New-JcSdkOffice365TranslationRule.md) +This endpoint allows you to create a translation rule for a specific Office 365 instance. +These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Translation Rule Parameters} + }' +``` + +### [New-JcSdkPolicy](New-JcSdkPolicy.md) +This endpoint allows you to create a policy. +Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policies \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Policy_Parameters} + }' +``` + +### [New-JcSdkPolicyGroup](New-JcSdkPolicyGroup.md) +This endpoint allows you to create a new Policy Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policygroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"{Group_Name}\" + }' +``` + +### [New-JcSdkProviderAdministrator](New-JcSdkProviderAdministrator.md) +This endpoint allows you to create a provider administrator. +You must be associated with the provider to use this route. +You must provide either `role` or `roleName`. + +### [New-JcSdkSoftwareApp](New-JcSdkSoftwareApp.md) +This endpoint allows you to create a Software Application that will be managed by JumpCloud on associated JumpCloud systems. +The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. + +#### Sample Request +``` +$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '{ + \"displayName\": \"Adobe Reader\", + \"settings\": [{\"packageId\": \"adobereader\"}] +}' +``` + +### [New-JcSdkSystemGroup](New-JcSdkSystemGroup.md) +This endpoint allows you to create a new System Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"{Group_Name}\" + }' +``` + +### [New-JcSdkUserGroup](New-JcSdkUserGroup.md) +This endpoint allows you to create a new User Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"{Group_Name}\" + }' +``` + +### [New-JcSdkWorkday](New-JcSdkWorkday.md) +This endpoint allows you to create a new workday instance. + +You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. +Failure to provide these credentials will result in the request being rejected. + +Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. + +Currently, only one instance is allowed and it must be `Workday Import`. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Workday2\", + \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", + \"auth\": { + \"basic\": { + \"username\": \"someDeveloper\", + \"password\": \"notTheRealPassword\" + } + } + }' +``` + +### [Remove-JcSdkActiveDirectory](Remove-JcSdkActiveDirectory.md) +This endpoint allows you to delete an Active Directory Instance. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +### [Remove-JcSdkActiveDirectoryAgent](Remove-JcSdkActiveDirectoryAgent.md) +This endpoint deletes an Active Directory agent. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Remove-JcSdkAdministratorOrganization](Remove-JcSdkAdministratorOrganization.md) +This endpoint removes the association link between an Administrator and an Organization. + +### [Remove-JcSdkAppleMdm](Remove-JcSdkAppleMdm.md) +Removes an Apple MDM configuration. + +Warning: This is a destructive operation and will remove your Apple Push Certificates. +We will no longer be able to manage your devices and the only recovery option is to re-register all devices into MDM. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Remove-JcSdkAppleMdmDevice](Remove-JcSdkAppleMdmDevice.md) +Remove a single Apple MDM device from MDM enrollment. + +#### Sample Request +``` + curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ + -H 'accept: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Remove-JcSdkApplicationLogo](Remove-JcSdkApplicationLogo.md) +Deletes the specified image from an application + +### [Remove-JcSdkApprovalFlow](Remove-JcSdkApprovalFlow.md) +Endpoint for deleting accessworkflow by id + +### [Remove-JcSdkAuthenticationPolicy](Remove-JcSdkAuthenticationPolicy.md) +Delete the specified authentication policy. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Remove-JcSdkBulkUserState](Remove-JcSdkBulkUserState.md) +This endpoint deletes a scheduled statechange job. +#### Sample Request +``` +curl -X DELETE \"https://console.jumpcloud.com/api/v2/bulk/userstates/{ScheduledJob_ID}\" \\ + -H 'x-api-key: {API_KEY}' \\ + -H 'Content-Type: application/json' \\ + -H 'Accept: application/json' +``` + +### [Remove-JcSdkCustomEmailConfiguration](Remove-JcSdkCustomEmailConfiguration.md) +Delete the custom email configuration for the specified custom email type + +### [Remove-JcSdkDuoAccount](Remove-JcSdkDuoAccount.md) +Removes the specified Duo account, an error will be returned if the account has some Duo application used in a protected resource. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Remove-JcSdkDuoApplication](Remove-JcSdkDuoApplication.md) +Deletes the specified Duo application, an error will be returned if the application is used in a protected resource. + +#### Sample Request +``` + curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}'' +``` + +### [Remove-JcSdkGSuiteTranslationRule](Remove-JcSdkGSuiteTranslationRule.md) +This endpoint allows you to delete a translation rule for a specific G Suite instance. +These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. + +#### Sample Request + +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +### [Remove-JcSdkIPList](Remove-JcSdkIPList.md) +Delete a specific IP list. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Remove-JcSdkLdapServerSambaDomain](Remove-JcSdkLdapServerSambaDomain.md) +This endpoint allows you to delete a samba domain from an LDAP server. + +##### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Remove-JcSdkOffice365TranslationRule](Remove-JcSdkOffice365TranslationRule.md) +This endpoint allows you to delete a translation rule for a specific Office 365 instance. +These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. + +#### Sample Request + +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +### [Remove-JcSdkPolicy](Remove-JcSdkPolicy.md) +This endpoint allows you to delete a policy. + +#### Sample Request + +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/policies/5a837ecd232e110d4291e6b9 \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +### [Remove-JcSdkPolicyGroup](Remove-JcSdkPolicyGroup.md) +This endpoint allows you to delete a Policy Group. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Remove-JcSdkProviderAdministrator](Remove-JcSdkProviderAdministrator.md) +This endpoint removes an Administrator associated with the Provider. +You must be associated with the provider to use this route. + +### [Remove-JcSdkSoftwareApp](Remove-JcSdkSoftwareApp.md) +Removes a Software Application configuration. + +Warning: This is a destructive operation and will unmanage the application on all affected systems. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Remove-JcSdkSystemGroup](Remove-JcSdkSystemGroup.md) +This endpoint allows you to delete a System Group. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Remove-JcSdkUserGroup](Remove-JcSdkUserGroup.md) +This endpoint allows you to delete a User Group. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +### [Remove-JcSdkUserPushEndpoint](Remove-JcSdkUserPushEndpoint.md) +This endpoint will delete a push endpoint associated with a user. + +### [Remove-JcSdkWorkdayAuthorization](Remove-JcSdkWorkdayAuthorization.md) +Removes any and all authorization methods from the workday instance + +##### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +### [Restart-JcSdkAppleMdmDevice](Restart-JcSdkAppleMdmDevice.md) +Restarts a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/restart \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{\"kextPaths\": [\"Path1\", \"Path2\"]}' +``` + +### [Set-JcSdkAccessRequest](Set-JcSdkAccessRequest.md) +Endpoint that set the workflow access request by id + +### [Set-JcSdkAccessRequestApproval](Set-JcSdkAccessRequestApproval.md) +Endpoint for user approval + +### [Set-JcSdkActiveDirectoryAssociation](Set-JcSdkActiveDirectoryAssociation.md) +This endpoint allows you to manage the _direct_ associations of an Active Directory instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{AD_Instance_ID}/associations \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{User_ID}\" + }' +``` + +### [Set-JcSdkAppleMdm](Set-JcSdkAppleMdm.md) +Set an Apple MDM configuration. +This endpoint is used to supply JumpCloud with a signed certificate from Apple in order to finalize the setup and allow JumpCloud to manage your devices. +It may also be used to set the DEP Settings. + +#### Sample Request +``` + curl -X PUT https://console.jumpcloud.com/api/v2/applemdms/{ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"MDM name\", + \"appleSignedCert\": \"{CERTIFICATE}\", + \"encryptedDepServerToken\": \"{SERVER_TOKEN}\", + \"dep\": { + \"welcomeScreen\": { + \"title\": \"Welcome\", + \"paragraph\": \"In just a few steps, you will be working securely from your Mac.\", + \"button\": \"continue\", + }, + }, + }' +``` + +### [Set-JcSdkApplicationAssociation](Set-JcSdkApplicationAssociation.md) +This endpoint allows you to manage the _direct_ associations of an Application. +A direct association can be a non-homogeneous relationship between 2 different objects, for example Application and User Groups. + +#### Sample Request +``` +curl -X POST 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations' \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user_group\", + \"id\": \"{Group_ID}\" + }' +``` + +### [Set-JcSdkApprovalFlow](Set-JcSdkApprovalFlow.md) +Endpoint for updating a new access workflow + +### [Set-JcSdkApprovalFlowSetting](Set-JcSdkApprovalFlowSetting.md) +Endpoint for updating a access workflow settings for an organization + +### [Set-JcSdkCommandAssociation](Set-JcSdkCommandAssociation.md) +This endpoint will allow you to manage the _direct_ associations of this Command. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. + + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system_group\", + \"id\": \"Group_ID\" + }' +``` + +### [Set-JcSdkCustomEmailConfiguration](Set-JcSdkCustomEmailConfiguration.md) +Set the custom email configuration for the specified custom email type. + +This action is only available to paying customers. + +### [Set-JcSdkDuoApplication](Set-JcSdkDuoApplication.md) +Set the specified Duo application. + +#### Sample Request +``` + curl -X PUT https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Application Name\", + \"apiHost\": \"api-1234.duosecurity.com\", + \"integrationKey\": \"1234\", + \"secretKey\": \"5678\" + }' +``` + +### [Set-JcSdkGSuiteAssociation](Set-JcSdkGSuiteAssociation.md) +This endpoint returns the _direct_ associations of this G Suite instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user_group\", + \"id\": \"{Group_ID}\" + }' +``` + +### [Set-JcSdkIPList](Set-JcSdkIPList.md) +Replace a specific IP list. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Sample IP List\", + \"ips\": [ + \"192.168.10.10\" + ] + }' +``` + +### [Set-JcSdkLdapServerAssociation](Set-JcSdkLdapServerAssociation.md) +This endpoint allows you to manage the _direct_ associations of a LDAP Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{User_ID}\" + }' +``` + +### [Set-JcSdkLdapServerSambaDomain](Set-JcSdkLdapServerSambaDomain.md) +This endpoint allows you to set the samba domain information for an LDAP server. + +##### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"sid\":\"{SID_ID}\", + \"name\":\"{WORKGROUP_NAME}\" + }' +``` + +### [Set-JcSdkOffice365Association](Set-JcSdkOffice365Association.md) +This endpoint allows you to manage the _direct_ associations of a Office 365 instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user_group\", + \"id\": \"{Group_ID}\" + }' +``` + +### [Set-JcSdkPolicy](Set-JcSdkPolicy.md) +This endpoint allows you to set a policy. +Given the amount of configurable parameters required to set a Policy, we suggest you use the JumpCloud Admin Console to set new policies. + + +##### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/policies/59fced45c9118022172547ff \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Policy_Parameters} + }' +``` + +### [Set-JcSdkPolicyAssociation](Set-JcSdkPolicyAssociation.md) +This endpoint allows you to manage the _direct_ associations of a Policy. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations/ \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system_group\", + \"id\": \"{Group_ID}\" + }' +``` + +### [Set-JcSdkPolicyGroup](Set-JcSdkPolicyGroup.md) +This endpoint allows you to do a full set of the Policy Group. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/policygroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"group_set + }' +``` + +### [Set-JcSdkPolicyGroupAssociation](Set-JcSdkPolicyGroupAssociation.md) +This endpoint manages the _direct_ associations of this Policy Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system\", + \"id\": \"{SystemID}\" + }' +``` + +### [Set-JcSdkPolicyGroupMember](Set-JcSdkPolicyGroupMember.md) +This endpoint allows you to manage the Policy members of a Policy Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"policy\", + \"id\": \"{Policy_ID}\" + }' +``` + +### [Set-JcSdkRadiusServerAssociation](Set-JcSdkRadiusServerAssociation.md) +This endpoint allows you to manage the _direct_ associations of a Radius Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ +\t +\"type\":\"user\", +\"id\":\"{USER_ID}\", +\"op\":\"add\" +\t +}' +``` + +### [Set-JcSdkSoftwareApp](Set-JcSdkSoftwareApp.md) +This endpoint set a specific Software Application configuration for the organization. +displayName can be changed alone if no settings are provided. +If a setting is provided, it should include all its information since this endpoint will set all the settings' fields. +The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. + +#### Sample Request - displayName only +``` + curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"displayName\": \"My Software App\" + }' +``` + +#### Sample Request - all attributes +``` + curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"displayName\": \"My Software App\", + \"settings\": [ + { + \"packageId\": \"123456\", + \"autoset : false, + \"allowUpdateDelay\": false, + \"packageManager\": \"APPLE_VPP\", + \"locationObjectId\": \"123456789012123456789012\", + \"location\": \"123456\", + \"desiredState\": \"Install\", + \"appleVpp\": { + \"appConfiguration\": \"\\\\\MyKey\\My String\\\\", + \"assignedLicenses\": 20, + \"availableLicenses\": 10, + \"details\": {}, + \"isConfigEnabled\": true, + \"supportedDeviceFamilies\": [ + \"IPAD\", + \"MAC\" + ], + \"totalLicenses\": 30 + }, + \"packageSubtitle\": \"My package subtitle\", + \"packageVersion\": \"1.2.3\", + \"packageKind\": \"software-package\", + \"assetKind\": \"software\", + \"assetSha256Size\": 256, + \"assetSha256Strings\": [ + \"a123b123c123d123\" + ], + \"description\": \"My app description\" + } + ] + }' +``` + +### [Set-JcSdkSoftwareAppAssociation](Set-JcSdkSoftwareAppAssociation.md) +This endpoint allows you to associate or disassociate a software application to a system or system group. + +#### Sample Request +``` +$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '{ + \"id\": \"\\", + \"op\": \"add\", + \"type\": \"system\" + }' +``` + +### [Set-JcSdkSystemAssociation](Set-JcSdkSystemAssociation.md) +This endpoint allows you to manage the _direct_ associations of a System. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"attributes\": { + \"sudo\": { + \"enabled\": true, + \"withoutPassword\": false + } + }, + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"UserID\" + }' +``` + +### [Set-JcSdkSystemGroup](Set-JcSdkSystemGroup.md) +This endpoint allows you to do a full set of the System Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Name_set + }' +``` + +### [Set-JcSdkSystemGroupAssociation](Set-JcSdkSystemGroupAssociation.md) +This endpoint allows you to manage the _direct_ associations of a System Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{UserID}\" + }' +``` + +### [Set-JcSdkSystemGroupMember](Set-JcSdkSystemGroupMember.md) +This endpoint allows you to manage the system members of a System Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system\", + \"id\": \"{System_ID}\" + }' +``` + +### [Set-JcSdkUserAssociation](Set-JcSdkUserAssociation.md) +This endpoint allows you to manage the _direct_ associations of a User. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"attributes\": { + \"sudo\": { + \"enabled\": true, + \"withoutPassword\": false + } + }, + \"op\": \"add\", + \"type\": \"system_group\", + \"id\": \"{GroupID}\" + }' +``` + +### [Set-JcSdkUserGroup](Set-JcSdkUserGroup.md) +This endpoint allows you to do a full set of the User Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"group_set + }' +``` + +### [Set-JcSdkUserGroupAssociation](Set-JcSdkUserGroupAssociation.md) +This endpoint manages the _direct_ associations of this User Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system\", + \"id\": \"{SystemID}\" + }' +``` + +### [Set-JcSdkUserGroupMember](Set-JcSdkUserGroupMember.md) +This endpoint allows you to manage the user members of a User Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{User_ID}\" + }' +``` + +### [Set-JcSdkWorkday](Set-JcSdkWorkday.md) +This endpoint allows you to set the name and Custom Report URL for a Workday Instance. + +Currently, the name can not be changed from the default of `Workday Import`. + +##### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/workdays/{WorkdayID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ +\t\"reportUrl\":\"{Report_URL}\", +\t\"name\":\"{Name}\" +}\t' +``` + +### [Stop-JcSdkAppleMdmDevice](Stop-JcSdkAppleMdmDevice.md) +Shuts down a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/shutdown \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +### [Sync-JcSdkAppleMdmDevice](Sync-JcSdkAppleMdmDevice.md) +Refreshes the list of devices that a JumpCloud admin has added to their virtual MDM in Apple Business Manager - ABM so that they can be DEP enrolled with JumpCloud. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/refreshdepdevices \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +### [Update-JcSdkAppleMdmDeviceLockInformation](Update-JcSdkAppleMdmDeviceLockInformation.md) +Refreshes the activation lock information for a device + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/refreshActivationLockInformation \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +### [Update-JcSdkAuthenticationPolicy](Update-JcSdkAuthenticationPolicy.md) +Patch the specified authentication policy. + +#### Sample Request +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ \"disabled\": false }' +``` + +### [Update-JcSdkBulkUser](Update-JcSdkBulkUser.md) +The endpoint allows you to update a bulk job to asynchronously update users. +See [update a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_put) for full list of attributes. + +#### Sample Request +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '[ +\t{ +\t \"id\":\"5be9fb4ddb01290001e85109\", +\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", +\t\t\"department\":\"{UPDATED_DEPARTMENT}\", +\t\t\"attributes\":[ +\t\t\t{\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} +\t\t] +\t}, +\t{ +\t \"id\":\"5be9fb4ddb01290001e85109\", +\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", +\t\t\"costCenter\":\"{UPDATED_COST_CENTER}\", +\t\t\"phoneNumbers\":[ +\t\t\t{\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, +\t\t\t{\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} +\t\t] +\t} +] +``` + +### [Update-JcSdkGSuite](Update-JcSdkGSuite.md) +This endpoint allows updating some attributes of a G Suite. + +##### Sample Request + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"userLockoutAction\": \"suspend\", + \"userPasswordExpirationAction\": \"maintain\" + }' +``` +Sample Request, set a default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": { + \"id\": \"{domainObjectID}\" + } + }' +``` + +Sample Request, unset the default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": {} + }' +``` + +### [Update-JcSdkIPList](Update-JcSdkIPList.md) +Update a specific IP list. + +#### Sample Request +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{\"name\": \"New IP List Name\"}' +``` + +### [Update-JcSdkLdapServer](Update-JcSdkLdapServer.md) +This endpoint allows updating some attributes of an LDAP server. + +Sample Request + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"userLockoutAction\": \"remove\", + \"userPasswordExpirationAction\": \"disable\" + }' +``` + +### [Update-JcSdkOffice365](Update-JcSdkOffice365.md) +This endpoint allows updating some attributes of an Office 365 instance. + +##### + +Sample Request + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"userLockoutAction\": \"maintain\", + \"userPasswordExpirationAction\": \"suspend\", + }' +``` + +Sample Request, set a default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": { + \"id\": \"{domainObjectID}\" + } + }' +``` + +Sample Request, unset the default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": {} + }' +``` + +### [Update-JcSdkUserPushEndpoint](Update-JcSdkUserPushEndpoint.md) +This endpoint will update a push endpoint associated with a user. + + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Lock-JcSdkAppleMdmDevice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Lock-JcSdkAppleMdmDevice.md new file mode 100644 index 000000000..8d48f43b8 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Lock-JcSdkAppleMdmDevice.md @@ -0,0 +1,267 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Lock-JcSdkAppleMdmDevice.md +schema: 2.0.0 +--- + +# Lock-JcSdkAppleMdmDevice + +## SYNOPSIS +Locks a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/lock \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +## SYNTAX + +### LockExpanded (Default) +``` +Lock-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId [-Pin ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Lock +``` +Lock-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId + -Body + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### LockViaIdentity +``` +Lock-JcSdkAppleMdmDevice -ConsoleHost -InputObject + -Body + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### LockViaIdentityExpanded +``` +Lock-JcSdkAppleMdmDevice -ConsoleHost -InputObject [-Pin ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Locks a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/lock \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Lock-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Pin:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Lock-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Body:() +``` + + + +## PARAMETERS + +### -AppleMdmId +. + +```yaml +Type: System.String +Parameter Sets: Lock, LockExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IPathsLf7IzoApplemdmsAppleMdmIdDevicesDeviceIdLockPostRequestbodyContentApplicationJsonSchema +Parameter Sets: Lock, LockViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +. + +```yaml +Type: System.String +Parameter Sets: Lock, LockExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: LockViaIdentity, LockViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pin +6-digit PIN, required for MacOS, to lock the device + +```yaml +Type: System.String +Parameter Sets: LockExpanded, LockViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.IPathsLf7IzoApplemdmsAppleMdmIdDevicesDeviceIdLockPostRequestbodyContentApplicationJsonSchema + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: . + - `[Pin ]`: 6-digit PIN, required for MacOS, to lock the device + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectory.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectory.md new file mode 100644 index 000000000..d66f45306 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectory.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectory.md +schema: 2.0.0 +--- + +# New-JcSdkActiveDirectory + +## SYNOPSIS +This endpoint allows you to create a new Active Directory. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/ \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"domain\": \"{DC=AD_domain_name;DC=com}\" + }' +``` + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkActiveDirectory -ConsoleHost [-DelegationState ] [-Domain ] [-GroupsEnabled] + [-UpdatedAt ] [-UseCase ] [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-JcSdkActiveDirectory -ConsoleHost -Body [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint allows you to create a new Active Directory. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/ \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"domain\": \"{DC=AD_domain_name;DC=com}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkActiveDirectory -Domain:() -UseCase:() +``` + +---- ---------- +Domain String +Id String +PrimaryAgent String +UseCase String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkActiveDirectory -Body:() +``` + +---- ---------- +Domain String +Id String +PrimaryAgent String +UseCase String + +## PARAMETERS + +### -Body +Active Directory + +```yaml +Type: JumpCloud.SDK.V2.Models.IActiveDirectory +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DelegationState +Delegation state of the Active Directory instance + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +Domain name for this Active Directory instance. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupsEnabled +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdatedAt +. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCase +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IActiveDirectory + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IActiveDirectory + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: Active Directory + - `[DelegationState ]`: Delegation state of the Active Directory instance + - `[Domain ]`: Domain name for this Active Directory instance. + - `[GroupsEnabled ]`: + - `[UpdatedAt ]`: + - `[UseCase ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectoryAgent.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectoryAgent.md new file mode 100644 index 000000000..8a1424152 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectoryAgent.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkActiveDirectoryAgent.md +schema: 2.0.0 +--- + +# New-JcSdkActiveDirectoryAgent + +## SYNOPSIS +This endpoint allows you to create a new Active Directory Agent. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ \"agent_type\":\"{SYNC}\" }' +``` + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkActiveDirectoryAgent -ConsoleHost -ActivedirectoryId [-AgentType ] + [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-JcSdkActiveDirectoryAgent -ConsoleHost -ActivedirectoryId -Body + [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentity +``` +New-JcSdkActiveDirectoryAgent -ConsoleHost -InputObject + -Body [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityExpanded +``` +New-JcSdkActiveDirectoryAgent -ConsoleHost -InputObject [-AgentType ] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to create a new Active Directory Agent. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ \"agent_type\":\"{SYNC}\" }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -AgentType:() +``` + +---- ---------- +ConnectKey String +ContactAt String +Hostname String +Id String +SourceIP String +State String +Version String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -Body:() +``` + +---- ---------- +ConnectKey String +ContactAt String +Hostname String +Id String +SourceIP String +State String +Version String + +## PARAMETERS + +### -ActivedirectoryId +. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentType +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +Active Directory Agent + +```yaml +Type: JumpCloud.SDK.V2.Models.IActiveDirectoryAgent +Parameter Sets: Create, CreateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IActiveDirectoryAgent + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IActiveDirectoryAgentGet + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: Active Directory Agent + - `[AgentType ]`: + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAdministratorOrganization.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAdministratorOrganization.md new file mode 100644 index 000000000..1387753c8 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAdministratorOrganization.md @@ -0,0 +1,221 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAdministratorOrganization.md +schema: 2.0.0 +--- + +# New-JcSdkAdministratorOrganization + +## SYNOPSIS +This endpoint allows you to grant Administrator access to an Organization. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkAdministratorOrganization -ConsoleHost -Id [-Organization ] [-Confirm] + [-WhatIf] [] +``` + +### Create +``` +New-JcSdkAdministratorOrganization -ConsoleHost -Id + -Body [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentity +``` +New-JcSdkAdministratorOrganization -ConsoleHost -InputObject + -Body [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityExpanded +``` +New-JcSdkAdministratorOrganization -ConsoleHost -InputObject + [-Organization ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to grant Administrator access to an Organization. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkAdministratorOrganization -Id:() -Organization:() +``` + +---- ---------- +Administrator String +Organization String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkAdministratorOrganization -Id:() -Body:() +``` + +---- ---------- +Administrator String +Organization String + +## PARAMETERS + +### -Body +AdministratorOrganizationLinkReq + +```yaml +Type: JumpCloud.SDK.V2.Models.IAdministratorOrganizationLinkReq +Parameter Sets: Create, CreateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Organization +The identifier for an organization to link this administrator to. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IAdministratorOrganizationLinkReq + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IAdministratorOrganizationLink + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: AdministratorOrganizationLinkReq + - `[Organization ]`: The identifier for an organization to link this administrator to. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkApprovalFlow.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkApprovalFlow.md new file mode 100644 index 000000000..abe34e98a --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkApprovalFlow.md @@ -0,0 +1,464 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkApprovalFlow.md +schema: 2.0.0 +--- + +# New-JcSdkApprovalFlow + +## SYNOPSIS +Endpoint for adding a new access workflow + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkApprovalFlow -ConsoleHost [-ApprovalType ] [-ApproverRequirement ] + [-ApproverResources ] [-Category ] [-Description ] + [-FixedDuration ] [-IconColor ] [-IconUrl ] [-MultiSelectDuration ] + [-Name ] [-NonAdminApproval] [-OrganizationObjectIdInputFile ] [-ResourceId ] + [-ResourceType ] [-SlackConfig ] [-SlackEnabled] [-Status ] + [-TimeBasedAccess] [-TtlConfig ] [-VisibleTo ] [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-JcSdkApprovalFlow -ConsoleHost -Body [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Endpoint for adding a new access workflow + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkApprovalFlow -ApprovalType 'manual' -Category "Application" -Description "A new workflow" -MultiSelectDuration @("P5D") -Name "New Workflow" -ResourceId 5d67fd481da3c52aa1faa883 -ResourceType "user_group" -Status "active" -TimeBasedAccess -TtlConfig "TTL_CONFIG_MULTI_SELECT_DURATIONS" -VisibleTo @('6148cd739d38866f0814e874') +``` + + + +## PARAMETERS + +### -ApprovalType +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApproverRequirement +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApproverResources +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpcloudIngressoApproverResource[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpcloudIngressoCreateAccessWorkflowRequest +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Category +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FixedDuration +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IconColor +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IconUrl +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiSelectDuration +. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NonAdminApproval +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationObjectIdInputFile +Input File for OrganizationObjectId (.) + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlackConfig +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpcloudIngressoSlackConfig[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlackEnabled +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeBasedAccess +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TtlConfig +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VisibleTo +. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpcloudIngressoCreateAccessWorkflowRequest + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IJumpcloudIngressoCreateAccessWorkflowResponse + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`APPROVERRESOURCES `: . + - `[RequireAll ]`: + - `[ResourceId ]`: + - `[ResourceName ]`: + - `[ResourceOrder ]`: + - `[ResourceType ]`: + +`BODY `: . + - `[ApprovalType ]`: + - `[ApproverRequirement ]`: + - `[ApproverResources >]`: + - `[RequireAll ]`: + - `[ResourceId ]`: + - `[ResourceName ]`: + - `[ResourceOrder ]`: + - `[ResourceType ]`: + - `[Category ]`: + - `[Description ]`: + - `[FixedDuration ]`: + - `[IconColor ]`: + - `[IconUrl ]`: + - `[MultiSelectDuration >]`: + - `[Name ]`: + - `[NonAdminApproval ]`: + - `[OrganizationObjectId ]`: + - `[ResourceId ]`: + - `[ResourceType ]`: + - `[SlackConfig >]`: + - `[SlackResourceId ]`: + - `[SlackEnabled ]`: + - `[Status ]`: + - `[TimeBasedAccess ]`: + - `[TtlConfig ]`: + - `[VisibleTo >]`: + +`SLACKCONFIG `: . + - `[SlackResourceId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAuthenticationPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAuthenticationPolicy.md new file mode 100644 index 000000000..5aaf6e71b --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAuthenticationPolicy.md @@ -0,0 +1,583 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkAuthenticationPolicy.md +schema: 2.0.0 +--- + +# New-JcSdkAuthenticationPolicy + +## SYNOPSIS +Create an authentication policy. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/authn/policies \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Sample Policy\", + \"disabled\": false, + \"effect\": { + \"action\": \"allow\" + }, + \"targets\": { + \"users\": { + \"inclusions\": [\"ALL\"] + }, + \"userGroups\": { + \"exclusions\": [{USER_GROUP_ID}] + }, + \"resources\": [ {\"type\": \"user_portal\" } ] + }, + \"conditions\":{ + \"ipAddressIn\": [{IP_LIST_ID}] + } + }' +``` + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkAuthenticationPolicy -ConsoleHost [-Conditions ] [-CustomErrorMessage ] + [-CustomErrorMessageEnabled] [-Description ] [-Disabled] [-EffectAction ] [-MfaRequired] + [-Name ] [-ObligationMfaFactors ] + [-PrimaryHelpText ] [-PrimaryHelpUrl ] [-SecondaryHelpText ] + [-SecondaryHelpUrl ] [-TargetResources ] [-Type ] + [-UserAttributeExclusions ] + [-UserAttributeInclusions ] [-UserGroupExclusions ] + [-UserGroupInclusions ] [-UserInclusions ] [-UserVerificationRequirement ] + [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-JcSdkAuthenticationPolicy -ConsoleHost -Body [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Create an authentication policy. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/authn/policies \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Sample Policy\", + \"disabled\": false, + \"effect\": { + \"action\": \"allow\" + }, + \"targets\": { + \"users\": { + \"inclusions\": [\"ALL\"] + }, + \"userGroups\": { + \"exclusions\": [{USER_GROUP_ID}] + }, + \"resources\": [ {\"type\": \"user_portal\" } ] + }, + \"conditions\":{ + \"ipAddressIn\": [{IP_LIST_ID}] + } + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkAuthenticationPolicy -Conditions:() -Description:() -Disabled:() -EffectAction:() -MfaRequired:() -Name:() -TargetResources:() -Type:() -UserAttributeExclusions:() -UserAttributeInclusions:() -UserGroupExclusions:() -UserGroupInclusions:() -UserInclusions:() -UserVerificationRequirement:() +``` + +---- ---------- +Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions +Description String +Disabled Boolean +EffectAction String +Id String +MfaRequired Boolean +Name String +TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] +Type String +UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserGroupExclusions String +UserGroupInclusions String +UserInclusions String +UserVerificationRequirement String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkAuthenticationPolicy -Body:() +``` + +---- ---------- +Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions +Description String +Disabled Boolean +EffectAction String +Id String +MfaRequired Boolean +Name String +TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] +Type String +UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserGroupExclusions String +UserGroupInclusions String +UserInclusions String +UserVerificationRequirement String + +## PARAMETERS + +### -Body +This represents an authentication policy. +See the details of each field for valid values and restrictions. + +```yaml +Type: JumpCloud.SDK.V2.Models.IAuthnPolicy +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Conditions +Dictionary of \ + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomErrorMessage +The custom error message to be displayed when the policy is applied. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomErrorMessageEnabled +Indicates whether the custom error message is enabled or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EffectAction +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MfaRequired +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObligationMfaFactors +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IAuthnPolicyObligationsMfaFactorsItem[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryHelpText +The text to be displayed for the help link. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryHelpUrl +The URL to be opened when the help link is clicked. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryHelpText +The text to be displayed for the help link. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryHelpUrl +The URL to be opened when the help link is clicked. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResources +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IAuthnPolicyResourceTarget[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +AuthnPolicyType + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAttributeExclusions +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IAuthnPolicyUserAttributeFilter[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAttributeInclusions +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IAuthnPolicyUserAttributeFilter[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserGroupExclusions +. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserGroupInclusions +. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInclusions +. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserVerificationRequirement +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IAuthnPolicy + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IAuthnPolicy + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: This represents an authentication policy. See the details of each field for valid values and restrictions. + - `[Conditions ]`: Dictionary of + - `[(Any) ]`: This indicates any property can be added to this object. + - `[CustomErrorMessage ]`: The custom error message to be displayed when the policy is applied. + - `[CustomErrorMessageEnabled ]`: Indicates whether the custom error message is enabled or not. + - `[Description ]`: + - `[Disabled ]`: + - `[EffectAction ]`: + - `[MfaRequired ]`: + - `[Name ]`: + - `[ObligationMfaFactors >]`: + - `[Type ]`: + - `[PrimaryHelpText ]`: The text to be displayed for the help link. + - `[PrimaryHelpUrl ]`: The URL to be opened when the help link is clicked. + - `[SecondaryHelpText ]`: The text to be displayed for the help link. + - `[SecondaryHelpUrl ]`: The URL to be opened when the help link is clicked. + - `[TargetResources >]`: + - `Type `: + - `[Id ]`: Object ID of the resource target. If undefined, then all resources of the given type are targeted. + - `[Type ]`: AuthnPolicyType + - `[UserAttributeExclusions >]`: + - `[Field ]`: The only field that is currently supported is ldap_binding_user + - `[Operator ]`: + - `[Value ]`: Can be any value - string, number, boolean, array or object. + - `[UserAttributeInclusions >]`: + - `[UserGroupExclusions >]`: + - `[UserGroupInclusions >]`: + - `[UserInclusions >]`: + - `[UserVerificationRequirement ]`: + +`OBLIGATIONMFAFACTORS `: . + - `[Type ]`: + +`TARGETRESOURCES `: . + - `Type `: + - `[Id ]`: Object ID of the resource target. If undefined, then all resources of the given type are targeted. + +`USERATTRIBUTEEXCLUSIONS `: . + - `[Field ]`: The only field that is currently supported is ldap_binding_user + - `[Operator ]`: + - `[Value ]`: Can be any value - string, number, boolean, array or object. + +`USERATTRIBUTEINCLUSIONS `: . + - `[Field ]`: The only field that is currently supported is ldap_binding_user + - `[Operator ]`: + - `[Value ]`: Can be any value - string, number, boolean, array or object. + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUser.md new file mode 100644 index 000000000..7cc3efd46 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUser.md @@ -0,0 +1,321 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUser.md +schema: 2.0.0 +--- + +# New-JcSdkBulkUser + +## SYNOPSIS +The endpoint allows you to create a bulk job to asynchronously create users. +See [create a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_post) +for the full list of attributes. + +#### Default User State +The `state` of each user in the request can be explicitly passed in or +omitted. +If `state` is omitted, then the user will get created +using the value returned from the +[Get an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organizations_get) +endpoint. +The default user state for bulk created users depends on the +`creation-source` header. +For `creation-source:jumpcloud:bulk` the +default state is stored in `settings.newSystemUserStateDefaults.csvImport`. +For other `creation-source` header values, the default state is stored in +`settings.newSystemUserStateDefaults.applicationImport` + +These default state values can be changed in the admin portal settings +or by using the +[create an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organization_put) +endpoint. + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '[ + { + \"email\":\"{email}\", + \"firstname\":\"{firstname}\", + \"lastname\":\"{firstname}\", + \"username\":\"{username}\", + \"attributes\":[ + { + \"name\":\"EmployeeID\", + \"value\":\"0000\" + }, + { + \"name\":\"Custom\", + \"value\":\"attribute\" + } + ] + } +]' +``` + +## SYNTAX + +``` +New-JcSdkBulkUser -ConsoleHost -Body > [-SuppressEmail] + [-CreationSource ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +The endpoint allows you to create a bulk job to asynchronously create users. +See [create a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_post) +for the full list of attributes. + +#### Default User State +The `state` of each user in the request can be explicitly passed in or +omitted. +If `state` is omitted, then the user will get created +using the value returned from the +[Get an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organizations_get) +endpoint. +The default user state for bulk created users depends on the +`creation-source` header. +For `creation-source:jumpcloud:bulk` the +default state is stored in `settings.newSystemUserStateDefaults.csvImport`. +For other `creation-source` header values, the default state is stored in +`settings.newSystemUserStateDefaults.applicationImport` + +These default state values can be changed in the admin portal settings +or by using the +[create an Organization](https://docs.jumpcloud.com/api/1.0/index.html#operation/organization_put) +endpoint. + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '[ + { + \"email\":\"{email}\", + \"firstname\":\"{firstname}\", + \"lastname\":\"{firstname}\", + \"username\":\"{username}\", + \"attributes\":[ + { + \"name\":\"EmployeeID\", + \"value\":\"0000\" + }, + { + \"name\":\"Custom\", + \"value\":\"attribute\" + } + ] + } +]' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkBulkUser +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -Body +Array of bulk-user-create + +```yaml +Type: System.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserCreate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreationSource +Defines the creation-source header for gapps, o365 and workdays requests. +If the header isn't sent, the default value is `jumpcloud:bulk`, if you send the header with a malformed value you receive a 400 error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuppressEmail +An option indicating whether to suppress the job results email that will +otherwise be sent to the Administrator who created the job. +If true, the +email won't be sent. +If omitted or false, the email will be sent. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserCreate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IJobIdResult + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY >`: Array of bulk-user-create + - `[AccountLocked ]`: + - `[Activated ]`: + - `[Addresses >]`: + - `[Country ]`: + - `[ExtendedAddress ]`: + - `[Locality ]`: + - `[PoBox ]`: + - `[PostalCode ]`: + - `[Region ]`: + - `[StreetAddress ]`: + - `[Type ]`: + - `[AllowPublicKey ]`: + - `[AlternateEmail ]`: + - `[Attributes >]`: + - `[Name ]`: + - `[Value ]`: + - `[Company ]`: + - `[CostCenter ]`: + - `[DelegatedAuthorityId ]`: ObjectId of the target Active Directory connection + - `[DelegatedAuthorityName ]`: Authority name + - `[Department ]`: + - `[Description ]`: + - `[DisableDeviceMaxLoginAttempts ]`: + - `[Displayname ]`: + - `[Email ]`: + - `[EmployeeIdentifier ]`: Must be unique per user. + - `[EmployeeType ]`: + - `[EnableManagedUid ]`: + - `[EnableUserPortalMultifactor ]`: + - `[ExternalDn ]`: + - `[ExternalPasswordExpirationDate ]`: + - `[ExternalSourceType ]`: + - `[ExternallyManaged ]`: + - `[Firstname ]`: + - `[JobTitle ]`: + - `[Lastname ]`: + - `[LdapBindingUser ]`: + - `[Location ]`: + - `[ManagedAppleId ]`: + - `[Manager ]`: Relation with another systemuser to identify the last as a manager. + - `[MfaConfigured ]`: + - `[MfaExclusion ]`: + - `[MfaExclusionDays ]`: + - `[MfaExclusionUntil ]`: + - `[Middlename ]`: + - `[Password ]`: + - `[PasswordNeverExpires ]`: + - `[PasswordlessSudo ]`: + - `[PhoneNumbers >]`: + - `[Number ]`: + - `[Type ]`: + - `[PublicKey ]`: + - `[RecoveryEmailAddress ]`: + - `[Relationships >]`: + - `[Type ]`: + - `[Value ]`: + - `[RestrictedField ]`: + - `[RestrictedFieldId ]`: + - `[RestrictedFieldType ]`: + - `[SambaServiceUser ]`: + - `[State ]`: + - `[Sudo ]`: + - `[Suspended ]`: + - `[UnixGuid ]`: + - `[UnixUid ]`: + - `[Username ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUserState.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUserState.md new file mode 100644 index 000000000..992089c5c --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUserState.md @@ -0,0 +1,247 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkBulkUserState.md +schema: 2.0.0 +--- + +# New-JcSdkBulkUserState + +## SYNOPSIS +This endpoint allows you to create scheduled statechange jobs. +#### Sample Request +``` +curl -X POST \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ + -H 'x-api-key: {API_KEY}' \\ + -H 'Content-Type: application/json' \\ + -H 'Accept: application/json' \\ + -d '{ + \"user_ids\": [\"{User_ID_1}\", \"{User_ID_2}\", \"{User_ID_3}\"], + \"state\": \"SUSPENDED\", + \"start_date\": \"2000-01-01T00:00:00.000Z\" + }' +``` + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkBulkUserState -ConsoleHost [-ActivationEmailOverride ] [-SendActivationEmails] + [-StartDate ] [-State ] [-UserIds ] [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-JcSdkBulkUserState -ConsoleHost -Body [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint allows you to create scheduled statechange jobs. +#### Sample Request +``` +curl -X POST \"https://console.jumpcloud.com/api/v2/bulk/userstates\" \\ + -H 'x-api-key: {API_KEY}' \\ + -H 'Content-Type: application/json' \\ + -H 'Accept: application/json' \\ + -d '{ + \"user_ids\": [\"{User_ID_1}\", \"{User_ID_2}\", \"{User_ID_3}\"], + \"state\": \"SUSPENDED\", + \"start_date\": \"2000-01-01T00:00:00.000Z\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkBulkUserState -StartDate:() -State:() -UserIds:() -ActivationEmailOverride:() -SendActivationEmails:() +``` + +---- ---------- +ScheduledDate String +ScheduledJobId String +State String +SystemUserId String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkBulkUserState -Body:() +``` + +---- ---------- +ScheduledDate String +ScheduledJobId String +State String +SystemUserId String + +## PARAMETERS + +### -ActivationEmailOverride +Send the activation or welcome email to the specified email address upon activation. +Can only be used with a single user_id and scheduled activation. +This field will be ignored if `send_activation_emails` is explicitly set to false. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +Model to support bulk scheduling of a state change for one or more users + +```yaml +Type: JumpCloud.SDK.V2.Models.IBulkScheduledStatechangeCreate +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendActivationEmails +Set to true to send activation or welcome email(s) to each user_id upon activation. +Set to false to suppress emails. +Can only be used with scheduled activation(s). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +Date and time that scheduled action should occur + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The state to move the user(s) to + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserIds +Array of system user ids to schedule for a state change + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IBulkScheduledStatechangeCreate + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IScheduledUserstateResult + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: Model to support bulk scheduling of a state change for one or more users + - `StartDate `: Date and time that scheduled action should occur + - `State `: The state to move the user(s) to + - `UserIds >`: Array of system user ids to schedule for a state change + - `[ActivationEmailOverride ]`: Send the activation or welcome email to the specified email address upon activation. Can only be used with a single user_id and scheduled activation. This field will be ignored if `send_activation_emails` is explicitly set to false. + - `[SendActivationEmails ]`: Set to true to send activation or welcome email(s) to each user_id upon activation. Set to false to suppress emails. Can only be used with scheduled activation(s). + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkCustomEmailConfiguration.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkCustomEmailConfiguration.md new file mode 100644 index 000000000..6b3a082c6 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkCustomEmailConfiguration.md @@ -0,0 +1,264 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkCustomEmailConfiguration.md +schema: 2.0.0 +--- + +# New-JcSdkCustomEmailConfiguration + +## SYNOPSIS +Create the custom email configuration for the specified custom email type. + +This action is only available to paying customers. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkCustomEmailConfiguration -ConsoleHost [-Body ] [-Button ] [-Header ] + [-NextStepContactInfo ] [-Subject ] [-Title ] [-Type ] [-Confirm] [-WhatIf] + [] +``` + +### Create +``` +New-JcSdkCustomEmailConfiguration -ConsoleHost -CustomEmail [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Create the custom email configuration for the specified custom email type. + +This action is only available to paying customers. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkCustomEmailConfiguration -Subject:() -Type:() -Body:() -Button:() -Header:() -NextStepContactInfo:() -Title:() +``` + +---- ---------- +Body String +Button String +Header String +Id String +NextStepContactInfo String +Subject String +Title String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkCustomEmailConfiguration -CustomEmail:() +``` + +---- ---------- +Body String +Button String +Header String +Id String +NextStepContactInfo String +Subject String +Title String +Type String + +## PARAMETERS + +### -Body +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Button +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomEmail +Custom email content created by the admin user to personalize emails sent to their system users. + +```yaml +Type: JumpCloud.SDK.V2.Models.ICustomEmail +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Header +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NextStepContactInfo +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subject +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Title +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.ICustomEmail + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ICustomEmail + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`CUSTOMEMAIL `: Custom email content created by the admin user to personalize emails sent to their system users. + - `Subject `: + - `Type `: + - `[Body ]`: + - `[Button ]`: + - `[Header ]`: + - `[NextStepContactInfo ]`: + - `[Title ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoAccount.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoAccount.md new file mode 100644 index 000000000..09a078107 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoAccount.md @@ -0,0 +1,123 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoAccount.md +schema: 2.0.0 +--- + +# New-JcSdkDuoAccount + +## SYNOPSIS +Registers a Duo account for an organization. +Only one Duo account will be allowed, +in case an organization has a Duo account already a 409 (Conflict) code will be returned. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +## SYNTAX + +``` +New-JcSdkDuoAccount -ConsoleHost [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Registers a Duo account for an organization. +Only one Duo account will be allowed, +in case an organization has a Duo account already a 409 (Conflict) code will be returned. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkDuoAccount +``` + +---- ---------- +Id String +Name String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IDuoAccount + +## NOTES + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoApplication.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoApplication.md new file mode 100644 index 000000000..d9a0cc3e9 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoApplication.md @@ -0,0 +1,301 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkDuoApplication.md +schema: 2.0.0 +--- + +# New-JcSdkDuoApplication + +## SYNOPSIS +Create a Duo application for your organization and the specified account. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Application Name\", + \"apiHost\": \"api-1234.duosecurity.com\", + \"integrationKey\": \"1234\", + \"secretKey\": \"5678\" + }' +``` + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkDuoApplication -ConsoleHost -AccountId [-ApiHost ] + [-IntegrationKey ] [-Name ] [-SecretKey ] [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-JcSdkDuoApplication -ConsoleHost -AccountId -Body [-Confirm] + [-WhatIf] [] +``` + +### CreateViaIdentity +``` +New-JcSdkDuoApplication -ConsoleHost -InputObject -Body + [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityExpanded +``` +New-JcSdkDuoApplication -ConsoleHost -InputObject [-ApiHost ] + [-IntegrationKey ] [-Name ] [-SecretKey ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a Duo application for your organization and the specified account. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Application Name\", + \"apiHost\": \"api-1234.duosecurity.com\", + \"integrationKey\": \"1234\", + \"secretKey\": \"5678\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkDuoApplication -AccountId:() -ApiHost:() -IntegrationKey:() -Name:() -SecretKey:() +``` + +---- ---------- +ApiHost String +Id String +IntegrationKey String +Name String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkDuoApplication -AccountId:() -Body:() +``` + +---- ---------- +ApiHost String +Id String +IntegrationKey String +Name String + +## PARAMETERS + +### -AccountId +. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiHost +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +DuoApplicationReq + +```yaml +Type: JumpCloud.SDK.V2.Models.IDuoApplicationReq +Parameter Sets: Create, CreateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IntegrationKey +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretKey +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IDuoApplicationReq + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IDuoApplication + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: DuoApplicationReq + - `ApiHost `: + - `IntegrationKey `: + - `Name `: + - `SecretKey `: + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkGSuiteTranslationRule.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkGSuiteTranslationRule.md new file mode 100644 index 000000000..e96f69a40 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkGSuiteTranslationRule.md @@ -0,0 +1,263 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkGSuiteTranslationRule.md +schema: 2.0.0 +--- + +# New-JcSdkGSuiteTranslationRule + +## SYNOPSIS +This endpoint allows you to create a translation rule for a specific G Suite instance. +These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Translation Rule Parameters} + }' +``` + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkGSuiteTranslationRule -ConsoleHost -GsuiteId [-BuiltIn ] + [-Direction ] [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-JcSdkGSuiteTranslationRule -ConsoleHost -GsuiteId -Body + [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentity +``` +New-JcSdkGSuiteTranslationRule -ConsoleHost -InputObject + -Body [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityExpanded +``` +New-JcSdkGSuiteTranslationRule -ConsoleHost -InputObject [-BuiltIn ] + [-Direction ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to create a translation rule for a specific G Suite instance. +These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Translation Rule Parameters} + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkGSuiteTranslationRule -GsuiteId:() -BuiltIn:() -Direction:() +``` + +---- ---------- +BuiltIn String +Direction String +Id String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkGSuiteTranslationRule -GsuiteId:() -Body:() +``` + +---- ---------- +BuiltIn String +Direction String +Id String + +## PARAMETERS + +### -Body +G Suite Translation Rule Request + +```yaml +Type: JumpCloud.SDK.V2.Models.IGSuiteTranslationRuleRequest +Parameter Sets: Create, CreateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -BuiltIn +Built-in translations for G Suite export:* `user_home_addresses` - Translate all JumpCloud user addresses of type `home` to G Suite Directory user addresses of type `home`* `user_work_addresses` - Translate all JumpCloud user addresses of type `work` to G Suite Directory user addresses of type `work`* `user_other_addresses` - Translate all JumpCloud user addresses of type `other` to G Suite Directory user addresses of type `other`* `user_home_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `home` to G Suite Directory user phones of type `home`* `user_mobile_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `mobile` to G Suite Directory user phones of type `mobile`* `user_other_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `other` to G Suite Directory user phones of type `other`* `user_work_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work` to G Suite Directory user phones of type `work`* `user_work_fax_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work_fax` to G Suite Directory user phones of type `work_fax`* `user_work_mobile_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work_mobile` to G Suite Directory user phones of type `work_mobile`* `user_manager` - Translate JumpCloud user `manager` to G Suite Directory user `relations-manager`* `user_primary_organization_cost_center` - Translate JumpCloud user `costCenter` to G Suite Directory user `costCenter` for `primary` organization* `user_primary_organization_department` - Translate JumpCloud user `department` to G Suite Directory user `department` for `primary` organization* `user_primary_organization_description` - Translate JumpCloud user `employeeType` to G Suite Directory user `description` for `primary` organization* `user_primary_organization_employee_id` - Translate JumpCloud user `employeeIdentifier` to G Suite Directory user `externalIds` element of type `organization`* `user_primary_organization_title` - Translate JumpCloud user `jobTitle` to G Suite Directory user `title` for `primary` organization* `user_alternate_email` - Translate JumpCloud user `alternateEmail` to G Suite Directory user `emails`* `user_status` - Translate JumpCloud user `status` to G Suite Directory user `status`* `user_password` - Translate JumpCloud user `password` to G Suite Directory user `password` + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Direction identify if an attribute is going to be exported or imported from GSuite* `Import`- The data will be imported from GSuite into the user modal* `Export`- The data will be exported from the user modal to GSuite + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GsuiteId +. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGSuiteTranslationRuleRequest + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGSuiteTranslationRule + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: G Suite Translation Rule Request + - `[BuiltIn ]`: Built-in translations for G Suite export: * `user_home_addresses` - Translate all JumpCloud user addresses of type `home` to G Suite Directory user addresses of type `home` * `user_work_addresses` - Translate all JumpCloud user addresses of type `work` to G Suite Directory user addresses of type `work` * `user_other_addresses` - Translate all JumpCloud user addresses of type `other` to G Suite Directory user addresses of type `other` * `user_home_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `home` to G Suite Directory user phones of type `home` * `user_mobile_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `mobile` to G Suite Directory user phones of type `mobile` * `user_other_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `other` to G Suite Directory user phones of type `other` * `user_work_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work` to G Suite Directory user phones of type `work` * `user_work_fax_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work_fax` to G Suite Directory user phones of type `work_fax` * `user_work_mobile_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work_mobile` to G Suite Directory user phones of type `work_mobile` * `user_manager` - Translate JumpCloud user `manager` to G Suite Directory user `relations-manager` * `user_primary_organization_cost_center` - Translate JumpCloud user `costCenter` to G Suite Directory user `costCenter` for `primary` organization * `user_primary_organization_department` - Translate JumpCloud user `department` to G Suite Directory user `department` for `primary` organization * `user_primary_organization_description` - Translate JumpCloud user `employeeType` to G Suite Directory user `description` for `primary` organization * `user_primary_organization_employee_id` - Translate JumpCloud user `employeeIdentifier` to G Suite Directory user `externalIds` element of type `organization` * `user_primary_organization_title` - Translate JumpCloud user `jobTitle` to G Suite Directory user `title` for `primary` organization * `user_alternate_email` - Translate JumpCloud user `alternateEmail` to G Suite Directory user `emails` * `user_status` - Translate JumpCloud user `status` to G Suite Directory user `status` * `user_password` - Translate JumpCloud user `password` to G Suite Directory user `password` + - `[Direction ]`: Direction identify if an attribute is going to be exported or imported from GSuite * `Import`- The data will be imported from GSuite into the user modal * `Export`- The data will be exported from the user modal to GSuite + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkIPList.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkIPList.md new file mode 100644 index 000000000..7a99c5b18 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkIPList.md @@ -0,0 +1,218 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkIPList.md +schema: 2.0.0 +--- + +# New-JcSdkIPList + +## SYNOPSIS +Create an IP list. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/iplists \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Sample IP List\", + \"ips\": [ + \"192.168.10.12\", + \"192.168.10.20 - 192.168.10.30\", + \"123.225.10.0/32\" + ] + }' +``` + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkIPList -ConsoleHost [-Description ] [-Ips ] [-Name ] [-Confirm] + [-WhatIf] [] +``` + +### Create +``` +New-JcSdkIPList -ConsoleHost -Body [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create an IP list. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/iplists \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Sample IP List\", + \"ips\": [ + \"192.168.10.12\", + \"192.168.10.20 - 192.168.10.30\", + \"123.225.10.0/32\" + ] + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkIPList -Description:() -Ips:() -Name:() +``` + +---- ---------- +Description String +Id String +Ips String +Name String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkIPList -Body:() +``` + +---- ---------- +Description String +Id String +Ips String +Name String + +## PARAMETERS + +### -Body +IPListRequest + +```yaml +Type: JumpCloud.SDK.V2.Models.IIPListRequest +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ips +. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IIPListRequest + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IIPList + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: IPListRequest + - `[Description ]`: + - `[Ips >]`: + - `[Name ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkLdapServerSambaDomain.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkLdapServerSambaDomain.md new file mode 100644 index 000000000..60132303d --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkLdapServerSambaDomain.md @@ -0,0 +1,263 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkLdapServerSambaDomain.md +schema: 2.0.0 +--- + +# New-JcSdkLdapServerSambaDomain + +## SYNOPSIS +This endpoint allows you to create a samba domain for an LDAP server. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"sid\":\"{SID_ID}\", + \"name\":\"{WORKGROUP_NAME}\" + }' +``` + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkLdapServerSambaDomain -ConsoleHost -LdapserverId [-Name ] [-Sid ] + [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-JcSdkLdapServerSambaDomain -ConsoleHost -LdapserverId -Body [-Confirm] + [-WhatIf] [] +``` + +### CreateViaIdentity +``` +New-JcSdkLdapServerSambaDomain -ConsoleHost -InputObject -Body + [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityExpanded +``` +New-JcSdkLdapServerSambaDomain -ConsoleHost -InputObject [-Name ] + [-Sid ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to create a samba domain for an LDAP server. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"sid\":\"{SID_ID}\", + \"name\":\"{WORKGROUP_NAME}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkLdapServerSambaDomain -LdapserverId:() -Name:() -Sid:() +``` + +---- ---------- +Id String +Name String +Sid String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkLdapServerSambaDomain -LdapserverId:() -Body:() +``` + +---- ---------- +Id String +Name String +Sid String + +## PARAMETERS + +### -Body +Samba Domain + +```yaml +Type: JumpCloud.SDK.V2.Models.ISambaDomain +Parameter Sets: Create, CreateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LdapserverId +Unique identifier of the LDAP server. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of this domain's WorkGroup + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sid +Security identifier of this domain + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.ISambaDomain + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISambaDomain + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: Samba Domain + - `Name `: Name of this domain's WorkGroup + - `Sid `: Security identifier of this domain + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkOffice365TranslationRule.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkOffice365TranslationRule.md new file mode 100644 index 000000000..d08db22b0 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkOffice365TranslationRule.md @@ -0,0 +1,263 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkOffice365TranslationRule.md +schema: 2.0.0 +--- + +# New-JcSdkOffice365TranslationRule + +## SYNOPSIS +This endpoint allows you to create a translation rule for a specific Office 365 instance. +These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Translation Rule Parameters} + }' +``` + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkOffice365TranslationRule -ConsoleHost -Office365Id [-BuiltIn ] + [-Direction ] [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-JcSdkOffice365TranslationRule -ConsoleHost -Office365Id + -Body [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentity +``` +New-JcSdkOffice365TranslationRule -ConsoleHost -InputObject + -Body [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityExpanded +``` +New-JcSdkOffice365TranslationRule -ConsoleHost -InputObject + [-BuiltIn ] [-Direction ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to create a translation rule for a specific Office 365 instance. +These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Translation Rule Parameters} + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkOffice365TranslationRule -Office365Id:() -BuiltIn:() -Direction:() +``` + +---- ---------- +BuiltIn String +Direction String +Id String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkOffice365TranslationRule -Office365Id:() -Body:() +``` + +---- ---------- +BuiltIn String +Direction String +Id String + +## PARAMETERS + +### -Body +Office 365 Translation Rule Request + +```yaml +Type: JumpCloud.SDK.V2.Models.IOffice365TranslationRuleRequest +Parameter Sets: Create, CreateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -BuiltIn +Built-in translations for Office 365 (Microsoft Graph) export:* `user_alternate_email` - Translate `alternateEmail` field of JumpCloud user to `otherMails` field of Microsoft Graph `user`* `user_business_phones` - Translate `number` field of first JumpCloud user `phoneNumber` of type `work` to `businessPhones` field of Microsoft Graph `user`* `user_city` - Translate `locality` field of JumpCloud user address of type `work` to `city` field of Microsoft Graph user* `user_country` - Translate `country` field of JumpCloud user address of type `work` to `country` field of Microsoft Graph `user`* `user_department` - Translate `department` field of JumpCloud user to `department` field of Microsoft Graph `user`* `user_job_title` - Translate `jobTitle` field of JumpCloud user to `jobTitle` field of Microsoft Graph `user`* `user_manager` - Translate `manager` field of JumpCloud user to `manager` field of Microsoft Graph `user`* `user_mobile_phone` - Translate `number` field of first JumpCloud user `phoneNumber` of type `mobile` to `mobilePhone` field of Microsoft Graph `user`* `user_office_location` - Translate `location` field of JumpCloud user to `officeLocation` field of Microsoft Graph `user`* `user_postal_code` - Translate `postalCode` field of JumpCloud user address of type `work` to `postalCode` field of Microsoft Graph `user`* `user_principal_name_from_alternate_email` - Translate user `alternateEmail` field of Jumpcloud user to `userPrincipalName` field of Microsoft Graph `user`* `user_state` - Translate `region` field of JumpCloud user address of type `work` to `state` field of Microsoft Graph `user`* `user_street_address` - Translate `streetAddress` field of JumpCloud user address of type `work` to `streetAddress` field of Microsoft Graph user + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Direction identify if a attribute is going to be exported or imported from Office365* `Export`- The data will exported from the user modal to Office365 + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Office365Id +. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.IOffice365TranslationRuleRequest + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IOffice365TranslationRule + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: Office 365 Translation Rule Request + - `[BuiltIn ]`: Built-in translations for Office 365 (Microsoft Graph) export: * `user_alternate_email` - Translate `alternateEmail` field of JumpCloud user to `otherMails` field of Microsoft Graph `user` * `user_business_phones` - Translate `number` field of first JumpCloud user `phoneNumber` of type `work` to `businessPhones` field of Microsoft Graph `user` * `user_city` - Translate `locality` field of JumpCloud user address of type `work` to `city` field of Microsoft Graph user * `user_country` - Translate `country` field of JumpCloud user address of type `work` to `country` field of Microsoft Graph `user` * `user_department` - Translate `department` field of JumpCloud user to `department` field of Microsoft Graph `user` * `user_job_title` - Translate `jobTitle` field of JumpCloud user to `jobTitle` field of Microsoft Graph `user` * `user_manager` - Translate `manager` field of JumpCloud user to `manager` field of Microsoft Graph `user` * `user_mobile_phone` - Translate `number` field of first JumpCloud user `phoneNumber` of type `mobile` to `mobilePhone` field of Microsoft Graph `user` * `user_office_location` - Translate `location` field of JumpCloud user to `officeLocation` field of Microsoft Graph `user` * `user_postal_code` - Translate `postalCode` field of JumpCloud user address of type `work` to `postalCode` field of Microsoft Graph `user` * `user_principal_name_from_alternate_email` - Translate user `alternateEmail` field of Jumpcloud user to `userPrincipalName` field of Microsoft Graph `user` * `user_state` - Translate `region` field of JumpCloud user address of type `work` to `state` field of Microsoft Graph `user` * `user_street_address` - Translate `streetAddress` field of JumpCloud user address of type `work` to `streetAddress` field of Microsoft Graph user + - `[Direction ]`: Direction identify if a attribute is going to be exported or imported from Office365 * `Export`- The data will exported from the user modal to Office365 + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicy.md new file mode 100644 index 000000000..a3aea9af8 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicy.md @@ -0,0 +1,260 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicy.md +schema: 2.0.0 +--- + +# New-JcSdkPolicy + +## SYNOPSIS +This endpoint allows you to create a policy. +Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policies \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Policy_Parameters} + }' +``` + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkPolicy -ConsoleHost [-Name ] [-Notes ] [-TemplateId ] + [-Values ] [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-JcSdkPolicy -ConsoleHost -Body [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to create a policy. +Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. + +##### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policies \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Policy_Parameters} + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkPolicy -Name:() -TemplateId:() -Notes:() -Values:() +``` + +---- ---------- +ConfigFields JumpCloud.SDK.V2.Models.PolicyTemplateConfigField[] +Id String +Name String +Notes String +TemplateActivation String +TemplateAlert String +TemplateBehavior String +TemplateDeliveryTypes String +TemplateDescription String +TemplateDisplayName String +TemplateId String +TemplateName String +TemplateOSMetaFamily String +TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] +TemplateReference String +TemplateState String +Values JumpCloud.SDK.V2.Models.PolicyValue[] + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkPolicy -Body:() +``` + +---- ---------- +ConfigFields JumpCloud.SDK.V2.Models.PolicyTemplateConfigField[] +Id String +Name String +Notes String +TemplateActivation String +TemplateAlert String +TemplateBehavior String +TemplateDeliveryTypes String +TemplateDescription String +TemplateDisplayName String +TemplateId String +TemplateName String +TemplateOSMetaFamily String +TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] +TemplateReference String +TemplateState String +Values JumpCloud.SDK.V2.Models.PolicyValue[] + +## PARAMETERS + +### -Body +A request to create an instance of a policy template. + +```yaml +Type: JumpCloud.SDK.V2.Models.IPolicyCreateRequest +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The description for this specific Policy. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notes +The notes for this specific Policy. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateId +ObjectId uniquely identifying a Policy instance. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Values +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IPolicyValue[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IPolicyCreateRequest + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPolicyWithDetails + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: A request to create an instance of a policy template. + - `Name `: The description for this specific Policy. + - `TemplateId `: ObjectId uniquely identifying a Policy instance. + - `[Notes ]`: The notes for this specific Policy. + - `[Values >]`: + - `[ConfigFieldId ]`: The ObjectId of the corresponding Policy Template configuration field. + - `[Sensitive ]`: Defines if the value is sensitive or not. + - `[Value ]`: The value for the configuration field for this Policy instance. + +`VALUES `: . + - `[ConfigFieldId ]`: The ObjectId of the corresponding Policy Template configuration field. + - `[Sensitive ]`: Defines if the value is sensitive or not. + - `[Value ]`: The value for the configuration field for this Policy instance. + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicyGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicyGroup.md new file mode 100644 index 000000000..200771a84 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicyGroup.md @@ -0,0 +1,179 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkPolicyGroup.md +schema: 2.0.0 +--- + +# New-JcSdkPolicyGroup + +## SYNOPSIS +This endpoint allows you to create a new Policy Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policygroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"{Group_Name}\" + }' +``` + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkPolicyGroup -ConsoleHost [-Name ] [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-JcSdkPolicyGroup -ConsoleHost -Body [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to create a new Policy Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policygroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"{Group_Name}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkPolicyGroup -Name:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +Name String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkPolicyGroup -Body:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +Name String +Type String + +## PARAMETERS + +### -Body +PolicyGroupData + +```yaml +Type: JumpCloud.SDK.V2.Models.IPolicyGroupData +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Display name of a Policy Group. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IPolicyGroupData + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPolicyGroup + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: PolicyGroupData + - `Name `: Display name of a Policy Group. + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkProviderAdministrator.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkProviderAdministrator.md new file mode 100644 index 000000000..87a524c8a --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkProviderAdministrator.md @@ -0,0 +1,409 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkProviderAdministrator.md +schema: 2.0.0 +--- + +# New-JcSdkProviderAdministrator + +## SYNOPSIS +This endpoint allows you to create a provider administrator. +You must be associated with the provider to use this route. +You must provide either `role` or `roleName`. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkProviderAdministrator -ConsoleHost -ProviderId [-ApiKeyAllowed] + [-ApiKeyHashCreatedAt ] [-ApiKeyHashExpireAt ] [-ApiKeyHashPrefix ] [-BindNoOrgs] + [-Email ] [-EnableMultiFactor] [-Firstname ] [-Lastname ] [-Role ] + [-RoleName ] [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-JcSdkProviderAdministrator -ConsoleHost -ProviderId -Body [-Confirm] + [-WhatIf] [] +``` + +### CreateViaIdentity +``` +New-JcSdkProviderAdministrator -ConsoleHost -InputObject + -Body [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityExpanded +``` +New-JcSdkProviderAdministrator -ConsoleHost -InputObject [-ApiKeyAllowed] + [-ApiKeyHashCreatedAt ] [-ApiKeyHashExpireAt ] [-ApiKeyHashPrefix ] [-BindNoOrgs] + [-Email ] [-EnableMultiFactor] [-Firstname ] [-Lastname ] [-Role ] + [-RoleName ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to create a provider administrator. +You must be associated with the provider to use this route. +You must provide either `role` or `roleName`. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkProviderAdministrator -ProviderId:() -Email:() -ApiKeyAllowed:() -BindNoOrgs:() -EnableMultiFactor:() -Firstname:() -Lastname:() -Role:() -RoleName:() +``` + +---- ---------- +ApiKeyAllowed Boolean +ApiKeySet Boolean +Email String +EnableMultiFactor Boolean +Firstname String +Id String +Lastname String +OrganizationAccessTotal System.Nullable[float] OrganizationAccessTotal {get;set;} +Registered Boolean +Role String +RoleName String +Suspended Boolean + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkProviderAdministrator -ProviderId:() -Body:() +``` + +---- ---------- +ApiKeyAllowed Boolean +ApiKeySet Boolean +Email String +EnableMultiFactor Boolean +Firstname String +Id String +Lastname String +OrganizationAccessTotal System.Nullable[float] OrganizationAccessTotal {get;set;} +Registered Boolean +Role String +RoleName String +Suspended Boolean + +## PARAMETERS + +### -ApiKeyAllowed +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiKeyHashCreatedAt +. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiKeyHashExpireAt +. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiKeyHashPrefix +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BindNoOrgs +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +ProviderAdminReq + +```yaml +Type: JumpCloud.SDK.V2.Models.IProviderAdminReq +Parameter Sets: Create, CreateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Email +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMultiFactor +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Firstname +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Lastname +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderId +. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleName +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.IProviderAdminReq + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IAdministrator + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: ProviderAdminReq + - `Email `: + - `[ApiKeyAllowed ]`: + - `[ApiKeyHashCreatedAt ]`: + - `[ApiKeyHashExpireAt ]`: + - `[ApiKeyHashPrefix ]`: + - `[BindNoOrgs ]`: + - `[EnableMultiFactor ]`: + - `[Firstname ]`: + - `[Lastname ]`: + - `[Role ]`: + - `[RoleName ]`: + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSoftwareApp.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSoftwareApp.md new file mode 100644 index 000000000..899af73dd --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSoftwareApp.md @@ -0,0 +1,402 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSoftwareApp.md +schema: 2.0.0 +--- + +# New-JcSdkSoftwareApp + +## SYNOPSIS +This endpoint allows you to create a Software Application that will be managed by JumpCloud on associated JumpCloud systems. +The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. + +#### Sample Request +``` +$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '{ + \"displayName\": \"Adobe Reader\", + \"settings\": [{\"packageId\": \"adobereader\"}] +}' +``` + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkSoftwareApp -ConsoleHost [-CreatedAt ] [-DisplayName ] [-Id ] + [-Settings ] [-UpdatedAt ] [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-JcSdkSoftwareApp -ConsoleHost -Body [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to create a Software Application that will be managed by JumpCloud on associated JumpCloud systems. +The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. + +#### Sample Request +``` +$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '{ + \"displayName\": \"Adobe Reader\", + \"settings\": [{\"packageId\": \"adobereader\"}] +}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkSoftwareApp -DisplayName:() -Id:() -Settings:() +``` + +---- ---------- +DisplayName String +Id String +Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] +UploadUrl String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkSoftwareApp -Body:() +``` + +---- ---------- +DisplayName String +Id String +Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] +UploadUrl String + +## PARAMETERS + +### -Body +Software Application Package + +```yaml +Type: JumpCloud.SDK.V2.Models.ISoftwareApp +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreatedAt +. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Settings +. + +```yaml +Type: JumpCloud.SDK.V2.Models.ISoftwareAppSettings[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdatedAt +. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.ISoftwareApp + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISoftwareAppCreate + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: Software Application Package + - `[CreatedAt ]`: + - `[DisplayName ]`: + - `[Id ]`: + - `[Settings >]`: + - `[AllowUpdateDelay ]`: + - `[AppCatalogInstallableObjectId ]`: ID of the app catalog installable that created this app. + - `[AppFileName ]`: + - `[AppleVppAppConfiguration ]`: Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'. + - `[AppleVppAssignedLicenses ]`: + - `[AppleVppAvailableLicenses ]`: + - `[AppleVppDetails ]`: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[AppleVppIsConfigEnabled ]`: Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''. + - `[AppleVppSupportedDeviceFamilies >]`: The supported device families for this VPP Application. + - `[AppleVppTotalLicenses ]`: + - `[Architectures >]`: + - `[AssetKind ]`: The manifest asset kind (ex: software). + - `[AssetSha256Size ]`: The incremental size to use for summing the package as it is downloaded. + - `[AssetSha256Strings >]`: The array of checksums, one each for the hash size up to the total size of the package. + - `[AutoUpdate ]`: + - `[BundleId ]`: + - `[CommandLineArguments ]`: Command line arguments to use with the application. + - `[CreatedAt ]`: + - `[Description ]`: The software app description. + - `[DesiredState ]`: State of Install or Uninstall + - `[DownloadUrl ]`: + - `[EnterpriseObjectId ]`: ID of the Enterprise with which this app is associated + - `[Format ]`: + - `[GoogleAndroidAppPricing ]`: Whether this app is free, free with in-app purchases, or paid. + - `[GoogleAndroidAppVersion ]`: Latest version currently available for this app. + - `[GoogleAndroidAuthor ]`: The name of the author of this app. + - `[GoogleAndroidAutoUpdateMode ]`: Controls the auto-update mode for the app. + - `[GoogleAndroidCategory ]`: The app category (e.g. COMMUNICATION, SOCIAL, etc.). + - `[GoogleAndroidContentRating ]`: The content rating for this app. + - `[GoogleAndroidDisplayMode ]`: The display mode of the web app. + - `[GoogleAndroidDistributionChannel ]`: How and to whom the package is made available. + - `[GoogleAndroidFeatures >]`: The array of android features for the app. + - `[GoogleAndroidFullDescription ]`: Full app description, if available. + - `[GoogleAndroidIconUrl ]`: A link to an image that can be used as an icon for the app. + - `[GoogleAndroidInstallType ]`: The type of installation to perform for an app. + - `[GoogleAndroidManagedConfigurationTemplateId ]`: The managed configurations template for the app. + - `[GoogleAndroidManagedProperties ]`: Indicates whether this app has managed properties or not. + - `[GoogleAndroidMinSdkVersion ]`: The minimum Android SDK necessary to run the app. + - `[GoogleAndroidName ]`: The name of the app in the form enterprises/{enterprise}/applications/{packageName}. + - `[GoogleAndroidPermissionGrants >]`: + - `[Id ]`: An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR. + - `[Policy ]`: The policy for granting the permission. + - `[GoogleAndroidRuntimePermission ]`: The policy for granting permission requests to apps. + - `[GoogleAndroidStartUrl ]`: The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps. + - `[GoogleAndroidType ]`: Type of this android application. + - `[GoogleAndroidUpdateTime ]`: The approximate time (within 7 days) the app was last published. + - `[GoogleAndroidVersionCode ]`: The current version of the web app. + - `[IconUrl ]`: URL to the icon for the app. + - `[Location ]`: Repository where the app is located within the package manager + - `[LocationObjectId ]`: ID of the repository where the app is located within the package manager + - `[MicrosoftStoreDoNotUpdate ]`: Indicates whether the app can be updated or not. + - `[MicrosoftStoreNonRemovable ]`: Indicates whether the app is removable by the users or not. + - `[MicrosoftStorePackageFamilyName ]`: Package Family Name for the app from Microsoft App Store. + - `[ObjectId ]`: + - `[PackageId ]`: + - `[PackageKind ]`: The package manifest kind (ex: software-package). + - `[PackageManager ]`: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. + - `[PackageSubtitle ]`: The package manifest subtitle. + - `[PackageVersion ]`: The package manifest version. + - `[PackageVersionUpdatedAt ]`: + - `[Scope ]`: The installation scope of the software app. + - `[ShortVersion ]`: + - `[StoredPackageObjectId ]`: ID of the stored package this app uses to reference the stored install media. + - `[StoredPackageVersions >]`: + - `[Metadata ]`: Dictionary of + - `[(Any) ]`: This indicates any property can be added to this object. + - `[Name ]`: + - `[RejectedReason ]`: + - `[Sha256Sum ]`: + - `[Size ]`: + - `[Status ]`: + - `[Version ]`: + - `[TeamId ]`: + - `[UpdateTool ]`: + - `[UpdateToolArguments ]`: + - `[UpdatedAt ]`: + - `[VersionlessDownloadUrl ]`: + - `[UpdatedAt ]`: + +`SETTINGS `: . + - `[AllowUpdateDelay ]`: + - `[AppCatalogInstallableObjectId ]`: ID of the app catalog installable that created this app. + - `[AppFileName ]`: + - `[AppleVppAppConfiguration ]`: Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'. + - `[AppleVppAssignedLicenses ]`: + - `[AppleVppAvailableLicenses ]`: + - `[AppleVppDetails ]`: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[AppleVppIsConfigEnabled ]`: Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''. + - `[AppleVppSupportedDeviceFamilies >]`: The supported device families for this VPP Application. + - `[AppleVppTotalLicenses ]`: + - `[Architectures >]`: + - `[AssetKind ]`: The manifest asset kind (ex: software). + - `[AssetSha256Size ]`: The incremental size to use for summing the package as it is downloaded. + - `[AssetSha256Strings >]`: The array of checksums, one each for the hash size up to the total size of the package. + - `[AutoUpdate ]`: + - `[BundleId ]`: + - `[CommandLineArguments ]`: Command line arguments to use with the application. + - `[CreatedAt ]`: + - `[Description ]`: The software app description. + - `[DesiredState ]`: State of Install or Uninstall + - `[DownloadUrl ]`: + - `[EnterpriseObjectId ]`: ID of the Enterprise with which this app is associated + - `[Format ]`: + - `[GoogleAndroidAppPricing ]`: Whether this app is free, free with in-app purchases, or paid. + - `[GoogleAndroidAppVersion ]`: Latest version currently available for this app. + - `[GoogleAndroidAuthor ]`: The name of the author of this app. + - `[GoogleAndroidAutoUpdateMode ]`: Controls the auto-update mode for the app. + - `[GoogleAndroidCategory ]`: The app category (e.g. COMMUNICATION, SOCIAL, etc.). + - `[GoogleAndroidContentRating ]`: The content rating for this app. + - `[GoogleAndroidDisplayMode ]`: The display mode of the web app. + - `[GoogleAndroidDistributionChannel ]`: How and to whom the package is made available. + - `[GoogleAndroidFeatures >]`: The array of android features for the app. + - `[GoogleAndroidFullDescription ]`: Full app description, if available. + - `[GoogleAndroidIconUrl ]`: A link to an image that can be used as an icon for the app. + - `[GoogleAndroidInstallType ]`: The type of installation to perform for an app. + - `[GoogleAndroidManagedConfigurationTemplateId ]`: The managed configurations template for the app. + - `[GoogleAndroidManagedProperties ]`: Indicates whether this app has managed properties or not. + - `[GoogleAndroidMinSdkVersion ]`: The minimum Android SDK necessary to run the app. + - `[GoogleAndroidName ]`: The name of the app in the form enterprises/{enterprise}/applications/{packageName}. + - `[GoogleAndroidPermissionGrants >]`: + - `[Id ]`: An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR. + - `[Policy ]`: The policy for granting the permission. + - `[GoogleAndroidRuntimePermission ]`: The policy for granting permission requests to apps. + - `[GoogleAndroidStartUrl ]`: The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps. + - `[GoogleAndroidType ]`: Type of this android application. + - `[GoogleAndroidUpdateTime ]`: The approximate time (within 7 days) the app was last published. + - `[GoogleAndroidVersionCode ]`: The current version of the web app. + - `[IconUrl ]`: URL to the icon for the app. + - `[Location ]`: Repository where the app is located within the package manager + - `[LocationObjectId ]`: ID of the repository where the app is located within the package manager + - `[MicrosoftStoreDoNotUpdate ]`: Indicates whether the app can be updated or not. + - `[MicrosoftStoreNonRemovable ]`: Indicates whether the app is removable by the users or not. + - `[MicrosoftStorePackageFamilyName ]`: Package Family Name for the app from Microsoft App Store. + - `[ObjectId ]`: + - `[PackageId ]`: + - `[PackageKind ]`: The package manifest kind (ex: software-package). + - `[PackageManager ]`: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. + - `[PackageSubtitle ]`: The package manifest subtitle. + - `[PackageVersion ]`: The package manifest version. + - `[PackageVersionUpdatedAt ]`: + - `[Scope ]`: The installation scope of the software app. + - `[ShortVersion ]`: + - `[StoredPackageObjectId ]`: ID of the stored package this app uses to reference the stored install media. + - `[StoredPackageVersions >]`: + - `[Metadata ]`: Dictionary of + - `[(Any) ]`: This indicates any property can be added to this object. + - `[Name ]`: + - `[RejectedReason ]`: + - `[Sha256Sum ]`: + - `[Size ]`: + - `[Status ]`: + - `[Version ]`: + - `[TeamId ]`: + - `[UpdateTool ]`: + - `[UpdateToolArguments ]`: + - `[UpdatedAt ]`: + - `[VersionlessDownloadUrl ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSystemGroup.md new file mode 100644 index 000000000..4d3c55924 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSystemGroup.md @@ -0,0 +1,353 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkSystemGroup.md +schema: 2.0.0 +--- + +# New-JcSdkSystemGroup + +## SYNOPSIS +This endpoint allows you to create a new System Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"{Group_Name}\" + }' +``` + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkSystemGroup -ConsoleHost [-Attributes ] [-Description ] [-Email ] + [-MemberQueryExemptions ] [-MemberQueryFilters ] + [-MemberQuerySearchFilters ] [-MemberQueryType ] [-MembershipMethod ] + [-MemberSuggestionsNotify] [-Name ] [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-JcSdkSystemGroup -ConsoleHost -Body [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to create a new System Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/systemgroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"{Group_Name}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkSystemGroup -Name:() -Attributes:() -Description:() -Email:() -MemberQueryExemptions:() -MemberQueryFilters:() -MemberQueryType:() -MemberSuggestionsNotify:() -MembershipMethod:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkSystemGroup -Body:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +Type String + +## PARAMETERS + +### -Attributes +The graph attributes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +SystemGroupPost + +```yaml +Type: JumpCloud.SDK.V2.Models.ISystemGroupPost +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of a System Group + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Email +Email address of a System Group + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberQueryExemptions +Array of GraphObjects exempted from the query + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphObject[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberQueryFilters +For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberQuerySearchFilters +For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberQueryType +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MembershipMethod +The type of membership method for this group. +Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED.Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices).Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberSuggestionsNotify +True if notification emails are to be sent for membership suggestions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Display name of a System Group. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.ISystemGroupPost + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemGroup + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: SystemGroupPost + - `Name `: Display name of a System Group. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[Description ]`: Description of a System Group + - `[Email ]`: Email address of a System Group + - `[MemberQueryExemptions >]`: Array of GraphObjects exempted from the query + - `Id `: The ObjectID of the graph object. + - `Type `: The type of graph object. + - `[Attributes ]`: The graph attributes. + - `[MemberQueryFilters >]`: For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. + - `[MemberQuerySearchFilters ]`: For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. + - `[MemberQueryType ]`: + - `[MemberSuggestionsNotify ]`: True if notification emails are to be sent for membership suggestions. + - `[MembershipMethod ]`: The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED. Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices). Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. + +`MEMBERQUERYEXEMPTIONS `: Array of GraphObjects exempted from the query + - `Id `: The ObjectID of the graph object. + - `Type `: The type of graph object. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkUserGroup.md new file mode 100644 index 000000000..0d1f703b3 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkUserGroup.md @@ -0,0 +1,369 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkUserGroup.md +schema: 2.0.0 +--- + +# New-JcSdkUserGroup + +## SYNOPSIS +This endpoint allows you to create a new User Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"{Group_Name}\" + }' +``` + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkUserGroup -ConsoleHost [-Attributes ] [-Description ] [-Email ] + [-MemberQueryExemptions ] [-MemberQueryFilters ] + [-MemberQuerySearchFilters ] [-MemberQueryType ] [-MembershipMethod ] + [-MemberSuggestionsNotify] [-Name ] [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-JcSdkUserGroup -ConsoleHost -Body [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to create a new User Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/usergroups \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"{Group_Name}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkUserGroup -Name:() -Attributes:() -Description:() -Email:() -MemberQueryExemptions:() -MemberQueryFilters:() -MemberQueryType:() -MemberSuggestionsNotify:() -MembershipMethod:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +SuggestionCountAdd Int +SuggestionCountRemove Int +SuggestionCountTotal Int +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkUserGroup -Body:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +SuggestionCountAdd Int +SuggestionCountRemove Int +SuggestionCountTotal Int +Type String + +## PARAMETERS + +### -Attributes +The graph attributes for a UserGroup. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +UserGroupPost + +```yaml +Type: JumpCloud.SDK.V2.Models.IUserGroupPost +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of a User Group + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Email +Email address of a User Group + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberQueryExemptions +Array of GraphObjects exempted from the query + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphObject[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberQueryFilters +For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberQuerySearchFilters +For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberQueryType +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MembershipMethod +The type of membership method for this group. +Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED.Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices).Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberSuggestionsNotify +True if notification emails are to be sent for membership suggestions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Display name of a User Group. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IUserGroupPost + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IUserGroup + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: UserGroupPost + - `Name `: Display name of a User Group. + - `[Attributes ]`: The graph attributes for a UserGroup. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[SudoEnabled ]`: Enables sudo + - `[SudoWithoutPassword ]`: Enable sudo without password (requires 'enabled' to be true) + - `[LdapGroups >]`: + - `[Name ]`: + - `[PosixGroups >]`: + - `Id `: + - `Name `: + - `[RadiusReply >]`: + - `Name `: + - `Value `: + - `[SambaEnabled ]`: + - `[Description ]`: Description of a User Group + - `[Email ]`: Email address of a User Group + - `[MemberQueryExemptions >]`: Array of GraphObjects exempted from the query + - `Id `: The ObjectID of the graph object. + - `Type `: The type of graph object. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[MemberQueryFilters >]`: For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. + - `[MemberQuerySearchFilters ]`: For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. + - `[MemberQueryType ]`: + - `[MemberSuggestionsNotify ]`: True if notification emails are to be sent for membership suggestions. + - `[MembershipMethod ]`: The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED. Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices). Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. + +`MEMBERQUERYEXEMPTIONS `: Array of GraphObjects exempted from the query + - `Id `: The ObjectID of the graph object. + - `Type `: The type of graph object. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkWorkday.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkWorkday.md new file mode 100644 index 000000000..f8a38dc5e --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkWorkday.md @@ -0,0 +1,280 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkWorkday.md +schema: 2.0.0 +--- + +# New-JcSdkWorkday + +## SYNOPSIS +This endpoint allows you to create a new workday instance. + +You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. +Failure to provide these credentials will result in the request being rejected. + +Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. + +Currently, only one instance is allowed and it must be `Workday Import`. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Workday2\", + \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", + \"auth\": { + \"basic\": { + \"username\": \"someDeveloper\", + \"password\": \"notTheRealPassword\" + } + } + }' +``` + +## SYNTAX + +### CreateExpanded (Default) +``` +New-JcSdkWorkday -ConsoleHost [-BasicPassword ] [-BasicUsername ] [-Name ] + [-OauthCode ] [-ReportUrl ] [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-JcSdkWorkday -ConsoleHost -Body [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to create a new workday instance. + +You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. +Failure to provide these credentials will result in the request being rejected. + +Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. + +Currently, only one instance is allowed and it must be `Workday Import`. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Workday2\", + \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", + \"auth\": { + \"basic\": { + \"username\": \"someDeveloper\", + \"password\": \"notTheRealPassword\" + } + } + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +New-JcSdkWorkday -BasicPassword:() -BasicUsername:() -Name:() -OauthCode:() -ReportUrl:() +``` + +---- ---------- +BasicExpiry String +BasicIsValid Boolean +BasicMessage String +Id String +LastImport String +Name String +OauthExpiry String +OauthIsValid Boolean +OauthMessage String +ReportUrl String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +New-JcSdkWorkday -Body:() +``` + +---- ---------- +BasicExpiry String +BasicIsValid Boolean +BasicMessage String +Id String +LastImport String +Name String +OauthExpiry String +OauthIsValid Boolean +OauthMessage String +ReportUrl String + +## PARAMETERS + +### -BasicPassword +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BasicUsername +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +Workday Input + +```yaml +Type: JumpCloud.SDK.V2.Models.IWorkdayInput +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OauthCode +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportUrl +. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IWorkdayInput + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IWorkdayOutput + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: Workday Input + - `[BasicPassword ]`: + - `[BasicUsername ]`: + - `[Name ]`: + - `[OauthCode ]`: + - `[ReportUrl ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectory.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectory.md new file mode 100644 index 000000000..929746cb7 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectory.md @@ -0,0 +1,189 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectory.md +schema: 2.0.0 +--- + +# Remove-JcSdkActiveDirectory + +## SYNOPSIS +This endpoint allows you to delete an Active Directory Instance. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkActiveDirectory -ConsoleHost -Id [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkActiveDirectory -ConsoleHost -InputObject [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint allows you to delete an Active Directory Instance. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkActiveDirectory -Id:() +``` + +---- ---------- +Domain String +Id String +PrimaryAgent String +UseCase String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of this Active Directory instance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IActiveDirectory + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectoryAgent.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectoryAgent.md new file mode 100644 index 000000000..5f919c15c --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectoryAgent.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkActiveDirectoryAgent.md +schema: 2.0.0 +--- + +# Remove-JcSdkActiveDirectoryAgent + +## SYNOPSIS +This endpoint deletes an Active Directory agent. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkActiveDirectoryAgent -ConsoleHost -ActivedirectoryId -AgentId + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkActiveDirectoryAgent -ConsoleHost -InputObject [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint deletes an Active Directory agent. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/activedirectories/{activedirectory_id}/agents/{agent_id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkActiveDirectoryAgent -ActivedirectoryId:() -AgentId:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ActivedirectoryId +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentId +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAdministratorOrganization.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAdministratorOrganization.md new file mode 100644 index 000000000..ebb6352e1 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAdministratorOrganization.md @@ -0,0 +1,200 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAdministratorOrganization.md +schema: 2.0.0 +--- + +# Remove-JcSdkAdministratorOrganization + +## SYNOPSIS +This endpoint removes the association link between an Administrator and an Organization. + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkAdministratorOrganization -ConsoleHost -AdministratorId -Id [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkAdministratorOrganization -ConsoleHost -InputObject [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint removes the association link between an Administrator and an Organization. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkAdministratorOrganization -AdministratorId:() -Id:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -AdministratorId +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdm.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdm.md new file mode 100644 index 000000000..465964c91 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdm.md @@ -0,0 +1,222 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdm.md +schema: 2.0.0 +--- + +# Remove-JcSdkAppleMdm + +## SYNOPSIS +Removes an Apple MDM configuration. + +Warning: This is a destructive operation and will remove your Apple Push Certificates. +We will no longer be able to manage your devices and the only recovery option is to re-register all devices into MDM. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkAppleMdm -ConsoleHost -Id [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkAppleMdm -ConsoleHost -InputObject [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Removes an Apple MDM configuration. + +Warning: This is a destructive operation and will remove your Apple Push Certificates. +We will no longer be able to manage your devices and the only recovery option is to re-register all devices into MDM. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkAppleMdm -Id:() +``` + +---- ---------- +AllowMobileUserEnrollment Boolean +ApnsCertExpiry String +ApnsPushTopic String +AppleCertCreatorAppleId String +AppleCertSerialNumber String +DefaultIosUserEnrollmentDeviceGroupId String +DefaultSystemGroupId String +DepAccessTokenExpiry String +DepEnableZeroTouchEnrollment Boolean +DepServerTokenState String +DepSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +Id String +IoDefaultDeviceGroupObjectIds String +IoEnableZeroTouchEnrollment Boolean +IoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +IoSetupOptions String +IosWelcomeScreenButton String +IosWelcomeScreenParagraph String +IosWelcomeScreenTitle String +MacoDefaultDeviceGroupObjectIds String +MacoEnableZeroTouchEnrollment Boolean +MacoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +MacoSetupOptions String +MacosWelcomeScreenButton String +MacosWelcomeScreenParagraph String +MacosWelcomeScreenTitle String +Name String +Organization String +WelcomeScreenButton String +WelcomeScreenParagraph String +WelcomeScreenTitle String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IAppleMdm + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdmDevice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdmDevice.md new file mode 100644 index 000000000..2e18e2859 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdmDevice.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAppleMdmDevice.md +schema: 2.0.0 +--- + +# Remove-JcSdkAppleMdmDevice + +## SYNOPSIS +Remove a single Apple MDM device from MDM enrollment. + +#### Sample Request +``` + curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ + -H 'accept: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkAppleMdmDevice -ConsoleHost -InputObject [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Remove a single Apple MDM device from MDM enrollment. + +#### Sample Request +``` + curl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id} \\ + -H 'accept: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() +``` + +---- ---------- +CreatedAt String +DepRegistered Boolean +DeviceInformationActivationLockAllowedWhileSupervised Boolean +DeviceInformationAvailableDeviceCapacity System.Nullable[float] DeviceInformationAvailableDeviceCapacity {get;set;} +DeviceInformationDeviceCapacity System.Nullable[float] DeviceInformationDeviceCapacity {get;set;} +DeviceInformationDeviceName String +DeviceInformationIccid String +DeviceInformationImei String +DeviceInformationIsSupervised Boolean +DeviceInformationModelName String +DeviceInformationSecondIccid String +DeviceInformationSecondImei String +DeviceInformationSecondSubscriberCarrierNetwork String +DeviceInformationSubscriberCarrierNetwork String +DeviceInformationWifiMac String +Enrolled Boolean +HasActivationLockBypassCodes Boolean +Id String +OSVersion String +SecurityInfoEnrolledViaDep Boolean +SecurityInfoIsActivationLockManageable Boolean +SecurityInfoIsUserEnrollment Boolean +SecurityInfoPasscodePresent Boolean +SecurityInfoUserApprovedEnrollment Boolean +SerialNumber String +Udid String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -AppleMdmId +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IAppleMdmDevice + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApplicationLogo.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApplicationLogo.md new file mode 100644 index 000000000..e5113f031 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApplicationLogo.md @@ -0,0 +1,185 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApplicationLogo.md +schema: 2.0.0 +--- + +# Remove-JcSdkApplicationLogo + +## SYNOPSIS +Deletes the specified image from an application + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkApplicationLogo -ConsoleHost -ApplicationId [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkApplicationLogo -ConsoleHost -InputObject [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Deletes the specified image from an application + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkApplicationLogo -ApplicationId:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ApplicationId +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApprovalFlow.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApprovalFlow.md new file mode 100644 index 000000000..20b90fb35 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApprovalFlow.md @@ -0,0 +1,185 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkApprovalFlow.md +schema: 2.0.0 +--- + +# Remove-JcSdkApprovalFlow + +## SYNOPSIS +Endpoint for deleting accessworkflow by id + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkApprovalFlow -ConsoleHost -ApprovalFlowId [-OrganizationObjectId ] + [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkApprovalFlow -ConsoleHost -InputObject + [-OrganizationObjectId ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Endpoint for deleting accessworkflow by id + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkApprovalFlow -ApprovalFlowId:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + + + +## PARAMETERS + +### -ApprovalFlowId +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OrganizationObjectId +. + +```yaml +Type: System.Byte[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IJumpcloudIngressoDeleteAccessWorkflowResponse + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAuthenticationPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAuthenticationPolicy.md new file mode 100644 index 000000000..7c5e414eb --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAuthenticationPolicy.md @@ -0,0 +1,200 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkAuthenticationPolicy.md +schema: 2.0.0 +--- + +# Remove-JcSdkAuthenticationPolicy + +## SYNOPSIS +Delete the specified authentication policy. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkAuthenticationPolicy -ConsoleHost -Id [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkAuthenticationPolicy -ConsoleHost -InputObject [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Delete the specified authentication policy. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkAuthenticationPolicy -Id:() +``` + +---- ---------- +Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions +Description String +Disabled Boolean +EffectAction String +Id String +MfaRequired Boolean +Name String +TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] +Type String +UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserGroupExclusions String +UserGroupInclusions String +UserInclusions String +UserVerificationRequirement String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Unique identifier of the authentication policy + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IAuthnPolicy + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkBulkUserState.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkBulkUserState.md new file mode 100644 index 000000000..027b4a92a --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkBulkUserState.md @@ -0,0 +1,199 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkBulkUserState.md +schema: 2.0.0 +--- + +# Remove-JcSdkBulkUserState + +## SYNOPSIS +This endpoint deletes a scheduled statechange job. +#### Sample Request +``` +curl -X DELETE \"https://console.jumpcloud.com/api/v2/bulk/userstates/{ScheduledJob_ID}\" \\ + -H 'x-api-key: {API_KEY}' \\ + -H 'Content-Type: application/json' \\ + -H 'Accept: application/json' +``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkBulkUserState -ConsoleHost -Id [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkBulkUserState -ConsoleHost -InputObject [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint deletes a scheduled statechange job. +#### Sample Request +``` +curl -X DELETE \"https://console.jumpcloud.com/api/v2/bulk/userstates/{ScheduledJob_ID}\" \\ + -H 'x-api-key: {API_KEY}' \\ + -H 'Content-Type: application/json' \\ + -H 'Accept: application/json' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkBulkUserState -Id:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Unique identifier of the scheduled statechange job. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkCustomEmailConfiguration.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkCustomEmailConfiguration.md new file mode 100644 index 000000000..f873e3aa7 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkCustomEmailConfiguration.md @@ -0,0 +1,185 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkCustomEmailConfiguration.md +schema: 2.0.0 +--- + +# Remove-JcSdkCustomEmailConfiguration + +## SYNOPSIS +Delete the custom email configuration for the specified custom email type + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkCustomEmailConfiguration -ConsoleHost -CustomEmailType [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkCustomEmailConfiguration -ConsoleHost -InputObject [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the custom email configuration for the specified custom email type + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkCustomEmailConfiguration -CustomEmailType:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomEmailType +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoAccount.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoAccount.md new file mode 100644 index 000000000..50d59a557 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoAccount.md @@ -0,0 +1,187 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoAccount.md +schema: 2.0.0 +--- + +# Remove-JcSdkDuoAccount + +## SYNOPSIS +Removes the specified Duo account, an error will be returned if the account has some Duo application used in a protected resource. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkDuoAccount -ConsoleHost -Id [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkDuoAccount -ConsoleHost -InputObject [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Removes the specified Duo account, an error will be returned if the account has some Duo application used in a protected resource. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkDuoAccount -Id:() +``` + +---- ---------- +Id String +Name String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of the Duo Account + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IDuoAccount + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoApplication.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoApplication.md new file mode 100644 index 000000000..d0106f8d4 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoApplication.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkDuoApplication.md +schema: 2.0.0 +--- + +# Remove-JcSdkDuoApplication + +## SYNOPSIS +Deletes the specified Duo application, an error will be returned if the application is used in a protected resource. + +#### Sample Request +``` + curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}'' +``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkDuoApplication -ConsoleHost -AccountId -ApplicationId [-Confirm] + [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkDuoApplication -ConsoleHost -InputObject [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Deletes the specified Duo application, an error will be returned if the application is used in a protected resource. + +#### Sample Request +``` + curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}'' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkDuoApplication -AccountId:() -ApplicationId:() +``` + +---- ---------- +ApiHost String +Id String +IntegrationKey String +Name String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -AccountId +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IDuoApplication + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkGSuiteTranslationRule.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkGSuiteTranslationRule.md new file mode 100644 index 000000000..a966b97f1 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkGSuiteTranslationRule.md @@ -0,0 +1,220 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkGSuiteTranslationRule.md +schema: 2.0.0 +--- + +# Remove-JcSdkGSuiteTranslationRule + +## SYNOPSIS +This endpoint allows you to delete a translation rule for a specific G Suite instance. +These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. + +#### Sample Request + +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkGSuiteTranslationRule -ConsoleHost -GsuiteId -Id [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkGSuiteTranslationRule -ConsoleHost -InputObject [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to delete a translation rule for a specific G Suite instance. +These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. + +#### Sample Request + +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkGSuiteTranslationRule -GsuiteId:() -Id:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GsuiteId +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkIPList.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkIPList.md new file mode 100644 index 000000000..bc1a5c2ab --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkIPList.md @@ -0,0 +1,189 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkIPList.md +schema: 2.0.0 +--- + +# Remove-JcSdkIPList + +## SYNOPSIS +Delete a specific IP list. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkIPList -ConsoleHost -Id [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkIPList -ConsoleHost -InputObject [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Delete a specific IP list. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkIPList -Id:() +``` + +---- ---------- +Description String +Id String +Ips String +Name String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IIPList + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkLdapServerSambaDomain.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkLdapServerSambaDomain.md new file mode 100644 index 000000000..50372ece5 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkLdapServerSambaDomain.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkLdapServerSambaDomain.md +schema: 2.0.0 +--- + +# Remove-JcSdkLdapServerSambaDomain + +## SYNOPSIS +This endpoint allows you to delete a samba domain from an LDAP server. + +##### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkLdapServerSambaDomain -ConsoleHost -Id -LdapserverId [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkLdapServerSambaDomain -ConsoleHost -InputObject [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to delete a samba domain from an LDAP server. + +##### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkLdapServerSambaDomain -Id:() -LdapserverId:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Unique identifier of the samba domain. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LdapserverId +Unique identifier of the LDAP server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.String + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkOffice365TranslationRule.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkOffice365TranslationRule.md new file mode 100644 index 000000000..5be2719bd --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkOffice365TranslationRule.md @@ -0,0 +1,220 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkOffice365TranslationRule.md +schema: 2.0.0 +--- + +# Remove-JcSdkOffice365TranslationRule + +## SYNOPSIS +This endpoint allows you to delete a translation rule for a specific Office 365 instance. +These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. + +#### Sample Request + +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkOffice365TranslationRule -ConsoleHost -Id -Office365Id [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkOffice365TranslationRule -ConsoleHost -InputObject [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to delete a translation rule for a specific Office 365 instance. +These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. + +#### Sample Request + +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkOffice365TranslationRule -Id:() -Office365Id:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Office365Id +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicy.md new file mode 100644 index 000000000..dcc7e2464 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicy.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicy.md +schema: 2.0.0 +--- + +# Remove-JcSdkPolicy + +## SYNOPSIS +This endpoint allows you to delete a policy. + +#### Sample Request + +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/policies/5a837ecd232e110d4291e6b9 \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkPolicy -ConsoleHost -Id [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkPolicy -ConsoleHost -InputObject [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint allows you to delete a policy. + +#### Sample Request + +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/policies/5a837ecd232e110d4291e6b9 \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + ``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkPolicy -Id:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of the Policy object. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicyGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicyGroup.md new file mode 100644 index 000000000..cde6cb890 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicyGroup.md @@ -0,0 +1,209 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicyGroup.md +schema: 2.0.0 +--- + +# Remove-JcSdkPolicyGroup + +## SYNOPSIS +This endpoint allows you to delete a Policy Group. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkPolicyGroup -ConsoleHost -Id [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkPolicyGroup -ConsoleHost -InputObject [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to delete a Policy Group. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/policygroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkPolicyGroup -Id:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +Name String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of the Policy Group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPolicyGroup + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkProviderAdministrator.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkProviderAdministrator.md new file mode 100644 index 000000000..f6a03f48c --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkProviderAdministrator.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkProviderAdministrator.md +schema: 2.0.0 +--- + +# Remove-JcSdkProviderAdministrator + +## SYNOPSIS +This endpoint removes an Administrator associated with the Provider. +You must be associated with the provider to use this route. + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkProviderAdministrator -ConsoleHost -Id -ProviderId [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkProviderAdministrator -ConsoleHost -InputObject [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint removes an Administrator associated with the Provider. +You must be associated with the provider to use this route. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkProviderAdministrator -Id:() -ProviderId:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderId +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSoftwareApp.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSoftwareApp.md new file mode 100644 index 000000000..4f70c6514 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSoftwareApp.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSoftwareApp.md +schema: 2.0.0 +--- + +# Remove-JcSdkSoftwareApp + +## SYNOPSIS +Removes a Software Application configuration. + +Warning: This is a destructive operation and will unmanage the application on all affected systems. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkSoftwareApp -ConsoleHost -Id [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkSoftwareApp -ConsoleHost -InputObject [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Removes a Software Application configuration. + +Warning: This is a destructive operation and will unmanage the application on all affected systems. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkSoftwareApp -Id:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSystemGroup.md new file mode 100644 index 000000000..c32cafeb4 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSystemGroup.md @@ -0,0 +1,214 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkSystemGroup.md +schema: 2.0.0 +--- + +# Remove-JcSdkSystemGroup + +## SYNOPSIS +This endpoint allows you to delete a System Group. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkSystemGroup -ConsoleHost -Id [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkSystemGroup -ConsoleHost -InputObject [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to delete a System Group. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkSystemGroup -Id:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of the System Group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemGroup + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserGroup.md new file mode 100644 index 000000000..f332fa831 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserGroup.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserGroup.md +schema: 2.0.0 +--- + +# Remove-JcSdkUserGroup + +## SYNOPSIS +This endpoint allows you to delete a User Group. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkUserGroup -ConsoleHost -Id [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkUserGroup -ConsoleHost -InputObject [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to delete a User Group. + +#### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' + +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkUserGroup -Id:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +SuggestionCountAdd Int +SuggestionCountRemove Int +SuggestionCountTotal Int +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of the User Group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IUserGroup + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserPushEndpoint.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserPushEndpoint.md new file mode 100644 index 000000000..bc99b9591 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserPushEndpoint.md @@ -0,0 +1,196 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkUserPushEndpoint.md +schema: 2.0.0 +--- + +# Remove-JcSdkUserPushEndpoint + +## SYNOPSIS +This endpoint will delete a push endpoint associated with a user. + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkUserPushEndpoint -ConsoleHost -PushEndpointId -UserId [-Confirm] + [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkUserPushEndpoint -ConsoleHost -InputObject [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint will delete a push endpoint associated with a user. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkUserPushEndpoint -PushEndpointId:() -UserId:() +``` + +---- ---------- +DeviceAppVersion String +DeviceMake String +DeviceModel String +DeviceOS String +DeviceOSVersion String +DeviceUvEnabled Boolean +EnrollmentDate Datetime +Id String +LastUsedDate Datetime +Name String +State String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PushEndpointId +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPushEndpointResponse + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkWorkdayAuthorization.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkWorkdayAuthorization.md new file mode 100644 index 000000000..7648b5a66 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkWorkdayAuthorization.md @@ -0,0 +1,201 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkWorkdayAuthorization.md +schema: 2.0.0 +--- + +# Remove-JcSdkWorkdayAuthorization + +## SYNOPSIS +Removes any and all authorization methods from the workday instance + +##### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## SYNTAX + +### Delete (Default) +``` +Remove-JcSdkWorkdayAuthorization -ConsoleHost -WorkdayId [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-JcSdkWorkdayAuthorization -ConsoleHost -InputObject [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Removes any and all authorization methods from the workday instance + +##### Sample Request +``` +curl -X DELETE https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Remove-JcSdkWorkdayAuthorization -WorkdayId:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkdayId +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Restart-JcSdkAppleMdmDevice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Restart-JcSdkAppleMdmDevice.md new file mode 100644 index 000000000..b85bd1b4b --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Restart-JcSdkAppleMdmDevice.md @@ -0,0 +1,267 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Restart-JcSdkAppleMdmDevice.md +schema: 2.0.0 +--- + +# Restart-JcSdkAppleMdmDevice + +## SYNOPSIS +Restarts a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/restart \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{\"kextPaths\": [\"Path1\", \"Path2\"]}' +``` + +## SYNTAX + +### RestartExpanded (Default) +``` +Restart-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId + [-KextPaths ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Restart +``` +Restart-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId + -Body + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### RestartViaIdentity +``` +Restart-JcSdkAppleMdmDevice -ConsoleHost -InputObject + -Body + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### RestartViaIdentityExpanded +``` +Restart-JcSdkAppleMdmDevice -ConsoleHost -InputObject [-KextPaths ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Restarts a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/restart \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{\"kextPaths\": [\"Path1\", \"Path2\"]}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Restart-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Restart-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() -KextPaths:() +``` + + + +## PARAMETERS + +### -AppleMdmId +. + +```yaml +Type: System.String +Parameter Sets: Restart, RestartExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IPaths1Whnyt3ApplemdmsAppleMdmIdDevicesDeviceIdRestartPostRequestbodyContentApplicationJsonSchema +Parameter Sets: Restart, RestartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +. + +```yaml +Type: System.String +Parameter Sets: Restart, RestartExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: RestartViaIdentity, RestartViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KextPaths +The string to pass when doing a restart and performing a RebuildKernelCache. + +```yaml +Type: System.String[] +Parameter Sets: RestartExpanded, RestartViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.IPaths1Whnyt3ApplemdmsAppleMdmIdDevicesDeviceIdRestartPostRequestbodyContentApplicationJsonSchema + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: . + - `[KextPaths >]`: The string to pass when doing a restart and performing a RebuildKernelCache. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequest.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequest.md new file mode 100644 index 000000000..cdb2b17e8 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequest.md @@ -0,0 +1,301 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequest.md +schema: 2.0.0 +--- + +# Set-JcSdkAccessRequest + +## SYNOPSIS +Endpoint that set the workflow access request by id + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkAccessRequest -ConsoleHost -Id [-Admin ] [-ApprovedDuration ] + [-InternalNote ] [-OrganizationObjectIdInputFile ] [-Remarks ] [-Status ] + [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkAccessRequest -ConsoleHost -Id + -Body [-Confirm] [-WhatIf] + [] +``` + +### SetViaIdentity +``` +Set-JcSdkAccessRequest -ConsoleHost -InputObject + -Body [-Confirm] [-WhatIf] + [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkAccessRequest -ConsoleHost -InputObject [-Admin ] + [-ApprovedDuration ] [-InternalNote ] [-OrganizationObjectIdInputFile ] + [-Remarks ] [-Status ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Endpoint that set the workflow access request by id + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkAccessRequest -Id:() -Admin:() -ApprovedDuration:() -InternalNote:() -OrganizationObjectIdInputFile:() -Remarks:() -Status:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkAccessRequest -Id:() -Body:() +``` + + + +## PARAMETERS + +### -Admin +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApprovedDuration +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IPaths17F25RsApprovalflowrequestIdPutRequestbodyContentApplicationJsonSchema +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InternalNote +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationObjectIdInputFile +Input File for OrganizationObjectId (.) + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Remarks +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.IPaths17F25RsApprovalflowrequestIdPutRequestbodyContentApplicationJsonSchema + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateWorkflowAccessRequestResponse + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: . + - `[Admin ]`: + - `[ApprovedDuration ]`: + - `[InternalNote ]`: + - `[OrganizationObjectId ]`: + - `[Remarks ]`: + - `[Status ]`: + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequestApproval.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequestApproval.md new file mode 100644 index 000000000..9540d8325 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequestApproval.md @@ -0,0 +1,212 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAccessRequestApproval.md +schema: 2.0.0 +--- + +# Set-JcSdkAccessRequestApproval + +## SYNOPSIS +Endpoint for user approval + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkAccessRequestApproval -ConsoleHost [-ApprovedDuration ] [-Id ] + [-OrganizationObjectIdInputFile ] [-Remarks ] [-Status ] [-Confirm] [-WhatIf] + [] +``` + +### Set +``` +Set-JcSdkAccessRequestApproval -ConsoleHost -Body [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Endpoint for user approval + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkAccessRequestApproval -ApprovedDuration:() -Id:() -OrganizationObjectIdInputFile:() -Remarks:() -Status:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkAccessRequestApproval -Body:() +``` + + + +## PARAMETERS + +### -ApprovedDuration +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpcloudIngressoUserApprovalRequest +Parameter Sets: Set +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationObjectIdInputFile +Input File for OrganizationObjectId (.) + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Remarks +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpcloudIngressoUserApprovalRequest + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IJumpcloudIngressoUserApprovalRequestResponse + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: . + - `[ApprovedDuration ]`: + - `[Id ]`: + - `[OrganizationObjectId ]`: + - `[Remarks ]`: + - `[Status ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkActiveDirectoryAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkActiveDirectoryAssociation.md new file mode 100644 index 000000000..485230d56 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkActiveDirectoryAssociation.md @@ -0,0 +1,313 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkActiveDirectoryAssociation.md +schema: 2.0.0 +--- + +# Set-JcSdkActiveDirectoryAssociation + +## SYNOPSIS +This endpoint allows you to manage the _direct_ associations of an Active Directory instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{AD_Instance_ID}/associations \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{User_ID}\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkActiveDirectoryAssociation -ConsoleHost -ActivedirectoryId + [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### Set +``` +Set-JcSdkActiveDirectoryAssociation -ConsoleHost -ActivedirectoryId + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkActiveDirectoryAssociation -ConsoleHost -InputObject + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkActiveDirectoryAssociation -ConsoleHost -InputObject + [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint allows you to manage the _direct_ associations of an Active Directory instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/activedirectories/{AD_Instance_ID}/associations \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{User_ID}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkActiveDirectoryAssociation -ActivedirectoryId:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkActiveDirectoryAssociation -ActivedirectoryId:() -Id:() -Op:() -Type:() -Attributes:() +``` + + + +## PARAMETERS + +### -ActivedirectoryId +. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Attributes +The graph attributes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +GraphOperation (ActiveDirectory) + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphOperationActiveDirectoryAutoGenerated +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectID of graph object being added or removed as an association. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Op +How to modify the graph connection. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Targets which a "active_directory" can be associated to. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGraphOperationActiveDirectoryAutoGenerated + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GraphOperation (ActiveDirectory) + - `Id `: The ObjectID of graph object being added or removed as an association. + - `Op `: How to modify the graph connection. + - `Type `: Targets which a "active_directory" can be associated to. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAppleMdm.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAppleMdm.md new file mode 100644 index 000000000..585539567 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAppleMdm.md @@ -0,0 +1,755 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkAppleMdm.md +schema: 2.0.0 +--- + +# Set-JcSdkAppleMdm + +## SYNOPSIS +Set an Apple MDM configuration. +This endpoint is used to supply JumpCloud with a signed certificate from Apple in order to finalize the setup and allow JumpCloud to manage your devices. +It may also be used to set the DEP Settings. + +#### Sample Request +``` + curl -X PUT https://console.jumpcloud.com/api/v2/applemdms/{ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"MDM name\", + \"appleSignedCert\": \"{CERTIFICATE}\", + \"encryptedDepServerToken\": \"{SERVER_TOKEN}\", + \"dep\": { + \"welcomeScreen\": { + \"title\": \"Welcome\", + \"paragraph\": \"In just a few steps, you will be working securely from your Mac.\", + \"button\": \"continue\", + }, + }, + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkAppleMdm -ConsoleHost -Id [-AllowMobileUserEnrollment] + [-AppleCertCreatorAppleId ] [-AppleSignedCert ] + [-DefaultIosUserEnrollmentDeviceGroupId ] [-DefaultSystemGroupId ] + [-DepEnableZeroTouchEnrollment] [-DepSetupAssistantOptions ] + [-EncryptedDepServerToken ] [-IoDefaultDeviceGroupObjectIds ] + [-IoEnableZeroTouchEnrollment] [-IoSetupAssistantOptions ] + [-IoSetupOptions ] [-IosWelcomeScreenButton ] [-IosWelcomeScreenParagraph ] + [-IosWelcomeScreenTitle ] [-MacoDefaultDeviceGroupObjectIds ] + [-MacoEnableZeroTouchEnrollment] [-MacoSetupAssistantOptions ] + [-MacoSetupOptions ] [-MacosWelcomeScreenButton ] [-MacosWelcomeScreenParagraph ] + [-MacosWelcomeScreenTitle ] [-Name ] [-WelcomeScreenButton ] + [-WelcomeScreenParagraph ] [-WelcomeScreenTitle ] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkAppleMdm -ConsoleHost -Id -Body [-Confirm] [-WhatIf] + [] +``` + +### SetViaIdentity +``` +Set-JcSdkAppleMdm -ConsoleHost -InputObject -Body [-Confirm] + [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkAppleMdm -ConsoleHost -InputObject [-AllowMobileUserEnrollment] + [-AppleCertCreatorAppleId ] [-AppleSignedCert ] + [-DefaultIosUserEnrollmentDeviceGroupId ] [-DefaultSystemGroupId ] + [-DepEnableZeroTouchEnrollment] [-DepSetupAssistantOptions ] + [-EncryptedDepServerToken ] [-IoDefaultDeviceGroupObjectIds ] + [-IoEnableZeroTouchEnrollment] [-IoSetupAssistantOptions ] + [-IoSetupOptions ] [-IosWelcomeScreenButton ] [-IosWelcomeScreenParagraph ] + [-IosWelcomeScreenTitle ] [-MacoDefaultDeviceGroupObjectIds ] + [-MacoEnableZeroTouchEnrollment] [-MacoSetupAssistantOptions ] + [-MacoSetupOptions ] [-MacosWelcomeScreenButton ] [-MacosWelcomeScreenParagraph ] + [-MacosWelcomeScreenTitle ] [-Name ] [-WelcomeScreenButton ] + [-WelcomeScreenParagraph ] [-WelcomeScreenTitle ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Set an Apple MDM configuration. +This endpoint is used to supply JumpCloud with a signed certificate from Apple in order to finalize the setup and allow JumpCloud to manage your devices. +It may also be used to set the DEP Settings. + +#### Sample Request +``` + curl -X PUT https://console.jumpcloud.com/api/v2/applemdms/{ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"MDM name\", + \"appleSignedCert\": \"{CERTIFICATE}\", + \"encryptedDepServerToken\": \"{SERVER_TOKEN}\", + \"dep\": { + \"welcomeScreen\": { + \"title\": \"Welcome\", + \"paragraph\": \"In just a few steps, you will be working securely from your Mac.\", + \"button\": \"continue\", + }, + }, + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkAppleMdm -Id:() -Body:() +``` + +---- ---------- +AllowMobileUserEnrollment Boolean +ApnsCertExpiry String +ApnsPushTopic String +AppleCertCreatorAppleId String +AppleCertSerialNumber String +DefaultIosUserEnrollmentDeviceGroupId String +DefaultSystemGroupId String +DepAccessTokenExpiry String +DepEnableZeroTouchEnrollment Boolean +DepServerTokenState String +DepSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +Id String +IoDefaultDeviceGroupObjectIds String +IoEnableZeroTouchEnrollment Boolean +IoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +IoSetupOptions String +IosWelcomeScreenButton String +IosWelcomeScreenParagraph String +IosWelcomeScreenTitle String +MacoDefaultDeviceGroupObjectIds String +MacoEnableZeroTouchEnrollment Boolean +MacoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +MacoSetupOptions String +MacosWelcomeScreenButton String +MacosWelcomeScreenParagraph String +MacosWelcomeScreenTitle String +Name String +Organization String +WelcomeScreenButton String +WelcomeScreenParagraph String +WelcomeScreenTitle String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkAppleMdm -Id:() -AllowMobileUserEnrollment:() -AppleCertCreatorAppleId:() -AppleSignedCert:() -DefaultIosUserEnrollmentDeviceGroupId:() -DefaultSystemGroupId:() -DepEnableZeroTouchEnrollment:() -DepSetupAssistantOptions:() -EncryptedDepServerToken:() -IoDefaultDeviceGroupObjectIds:() -IoEnableZeroTouchEnrollment:() -IoSetupAssistantOptions:() -IoSetupOptions:() -IosWelcomeScreenButton:() -IosWelcomeScreenParagraph:() -IosWelcomeScreenTitle:() -MacoDefaultDeviceGroupObjectIds:() -MacoEnableZeroTouchEnrollment:() -MacoSetupAssistantOptions:() -MacoSetupOptions:() -MacosWelcomeScreenButton:() -MacosWelcomeScreenParagraph:() -MacosWelcomeScreenTitle:() -Name:() -WelcomeScreenButton:() -WelcomeScreenParagraph:() -WelcomeScreenTitle:() +``` + +---- ---------- +AllowMobileUserEnrollment Boolean +ApnsCertExpiry String +ApnsPushTopic String +AppleCertCreatorAppleId String +AppleCertSerialNumber String +DefaultIosUserEnrollmentDeviceGroupId String +DefaultSystemGroupId String +DepAccessTokenExpiry String +DepEnableZeroTouchEnrollment Boolean +DepServerTokenState String +DepSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +Id String +IoDefaultDeviceGroupObjectIds String +IoEnableZeroTouchEnrollment Boolean +IoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +IoSetupOptions String +IosWelcomeScreenButton String +IosWelcomeScreenParagraph String +IosWelcomeScreenTitle String +MacoDefaultDeviceGroupObjectIds String +MacoEnableZeroTouchEnrollment Boolean +MacoSetupAssistantOptions JumpCloud.SDK.V2.Models.DepSetupAssistantOption[] +MacoSetupOptions String +MacosWelcomeScreenButton String +MacosWelcomeScreenParagraph String +MacosWelcomeScreenTitle String +Name String +Organization String +WelcomeScreenButton String +WelcomeScreenParagraph String +WelcomeScreenTitle String + +## PARAMETERS + +### -AllowMobileUserEnrollment +A toggle to allow mobile device enrollment for an organization. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppleCertCreatorAppleId +The Apple ID of the admin who created the Apple signed certificate. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppleSignedCert +A signed certificate obtained from Apple after providing Apple with the plist file provided on POST. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +Apple MDM Patch + +```yaml +Type: JumpCloud.SDK.V2.Models.IAppleMdmPatch +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultIosUserEnrollmentDeviceGroupId +ObjectId uniquely identifying the MDM default iOS user enrollment device group. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultSystemGroupId +ObjectId uniquely identifying the MDM default System Group. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DepEnableZeroTouchEnrollment +A toggle to determine if DEP registered devices should go through JumpCloud Zero Touch Enrollment. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DepSetupAssistantOptions +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IDepSetupAssistantOption[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptedDepServerToken +The S/MIME encoded DEP Server Token returned by Apple Business Manager when creating an MDM instance. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IoDefaultDeviceGroupObjectIds +An array of ObjectIDs identifying the default device groups for this specific type (based on the OS family) of automated device enrollment. +Currently, only a single DeviceGroupID is supported. + +```yaml +Type: System.String[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IoEnableZeroTouchEnrollment +A toggle to determine if ADE registered devices should go through JumpCloud Zero Touch Enrollment. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IoSetupAssistantOptions +A Setup Option wrapped as an object + +```yaml +Type: JumpCloud.SDK.V2.Models.IDepSetupAssistantOption[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IoSetupOptions +A list of configured setup options for this enrollment. + +```yaml +Type: System.String[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IosWelcomeScreenButton +Text to display on the button on the DEP Welcome Screen. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IosWelcomeScreenParagraph +A message to display on the DEP Welcome Screen. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IosWelcomeScreenTitle +The title to display on the DEP Welcome Screen. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MacoDefaultDeviceGroupObjectIds +An array of ObjectIDs identifying the default device groups for this specific type (based on the OS family) of automated device enrollment. +Currently, only a single DeviceGroupID is supported. + +```yaml +Type: System.String[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MacoEnableZeroTouchEnrollment +A toggle to determine if ADE registered devices should go through JumpCloud Zero Touch Enrollment. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MacoSetupAssistantOptions +A Setup Option wrapped as an object + +```yaml +Type: JumpCloud.SDK.V2.Models.IDepSetupAssistantOption[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MacoSetupOptions +A list of configured setup options for this enrollment. + +```yaml +Type: System.String[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MacosWelcomeScreenButton +Text to display on the button on the DEP Welcome Screen. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MacosWelcomeScreenParagraph +A message to display on the DEP Welcome Screen. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MacosWelcomeScreenTitle +The title to display on the DEP Welcome Screen. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +A new name for the Apple MDM configuration. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WelcomeScreenButton +Text to display on the button on the DEP Welcome Screen. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WelcomeScreenParagraph +A message to display on the DEP Welcome Screen. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WelcomeScreenTitle +The title to display on the DEP Welcome Screen. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IAppleMdmPatch + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IAppleMdm + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: Apple MDM Patch + - `[AllowMobileUserEnrollment ]`: A toggle to allow mobile device enrollment for an organization. + - `[AppleCertCreatorAppleId ]`: The Apple ID of the admin who created the Apple signed certificate. + - `[AppleSignedCert ]`: A signed certificate obtained from Apple after providing Apple with the plist file provided on POST. + - `[DefaultIosUserEnrollmentDeviceGroupId ]`: ObjectId uniquely identifying the MDM default iOS user enrollment device group. + - `[DefaultSystemGroupId ]`: ObjectId uniquely identifying the MDM default System Group. + - `[DepEnableZeroTouchEnrollment ]`: A toggle to determine if DEP registered devices should go through JumpCloud Zero Touch Enrollment. + - `[DepSetupAssistantOptions >]`: + - `[Option ]`: Options to skip screens during MacOS and iOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `actionButton` - Skips the Action Button configuration pane. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `cameraButton` - Skips the Camera Button configuration pane. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `enableLockdownMode` - Skips the Lockdown Mode pane. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `intelligence` - Skips the Intelligence pane. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `termsOfAddress` - Skips the Terms of Address pane. * `tos` - Skips terms and conditions. * `appStore` - Skips the App Store pane. * `deviceToDeviceMigration` - Skips Device to Device Migration pane. * `displayZoom` - Skips zoom setup. * `homeButton` - Skips the Meet the New Home Button screen on iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus and iPhone SE. * `imessageAndFacetime` - Skips the iMessage and FaceTime screen in iOS. * `messagingActivationUsingPhoneNumber` - Skips the iMessage pane. * `moveFromAndroid` - If the Restore pane is not skipped, removes the Move from Android option in the Restore pane on iOS.O * `passcode` - Hides and disables the passcode pane. * `restoreComplete` - Skips the Restore Completed pane. * `safety` - Skips the Safety pane. * `setupCellular` - Skips the add cellular plan pane. * `softwareUpdate` - Skips the mandatory software update screen in iOS. * `unlockWithWatch` - Skips Unlock Your Mac with your Apple Watch pane. * `updateComplete` - Skips the Software Update Complete pane. * `wallpaper` - Skips the Wallpaper setup. * `watchMigration` - Skips the screen for watch migration. * `welcome` - Skips the Get Started pane. * `additionalPrivacySettings` - Skips the Additional Privacy Settings pane. * `multitasking` - Skips the Multitasking pane. * `osShowcase` - Skips the OS Showcase pane. * `webContentFiltering` - Skips the Web Content Filtering pane. * `safetyAndHandling` - Skips the Safety and Handling pane. + - `[EncryptedDepServerToken ]`: The S/MIME encoded DEP Server Token returned by Apple Business Manager when creating an MDM instance. + - `[IoDefaultDeviceGroupObjectIds >]`: An array of ObjectIDs identifying the default device groups for this specific type (based on the OS family) of automated device enrollment. Currently, only a single DeviceGroupID is supported. + - `[IoEnableZeroTouchEnrollment ]`: A toggle to determine if ADE registered devices should go through JumpCloud Zero Touch Enrollment. + - `[IoSetupAssistantOptions >]`: A Setup Option wrapped as an object + - `[IoSetupOptions >]`: A list of configured setup options for this enrollment. + - `[IosWelcomeScreenButton ]`: Text to display on the button on the DEP Welcome Screen. + - `[IosWelcomeScreenParagraph ]`: A message to display on the DEP Welcome Screen. + - `[IosWelcomeScreenTitle ]`: The title to display on the DEP Welcome Screen. + - `[MacoDefaultDeviceGroupObjectIds >]`: An array of ObjectIDs identifying the default device groups for this specific type (based on the OS family) of automated device enrollment. Currently, only a single DeviceGroupID is supported. + - `[MacoEnableZeroTouchEnrollment ]`: A toggle to determine if ADE registered devices should go through JumpCloud Zero Touch Enrollment. + - `[MacoSetupAssistantOptions >]`: A Setup Option wrapped as an object + - `[MacoSetupOptions >]`: A list of configured setup options for this enrollment. + - `[MacosWelcomeScreenButton ]`: Text to display on the button on the DEP Welcome Screen. + - `[MacosWelcomeScreenParagraph ]`: A message to display on the DEP Welcome Screen. + - `[MacosWelcomeScreenTitle ]`: The title to display on the DEP Welcome Screen. + - `[Name ]`: A new name for the Apple MDM configuration. + - `[WelcomeScreenButton ]`: Text to display on the button on the DEP Welcome Screen. + - `[WelcomeScreenParagraph ]`: A message to display on the DEP Welcome Screen. + - `[WelcomeScreenTitle ]`: The title to display on the DEP Welcome Screen. + +`DEPSETUPASSISTANTOPTIONS `: . + - `[Option ]`: Options to skip screens during MacOS and iOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `actionButton` - Skips the Action Button configuration pane. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `cameraButton` - Skips the Camera Button configuration pane. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `enableLockdownMode` - Skips the Lockdown Mode pane. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `intelligence` - Skips the Intelligence pane. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `termsOfAddress` - Skips the Terms of Address pane. * `tos` - Skips terms and conditions. * `appStore` - Skips the App Store pane. * `deviceToDeviceMigration` - Skips Device to Device Migration pane. * `displayZoom` - Skips zoom setup. * `homeButton` - Skips the Meet the New Home Button screen on iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus and iPhone SE. * `imessageAndFacetime` - Skips the iMessage and FaceTime screen in iOS. * `messagingActivationUsingPhoneNumber` - Skips the iMessage pane. * `moveFromAndroid` - If the Restore pane is not skipped, removes the Move from Android option in the Restore pane on iOS.O * `passcode` - Hides and disables the passcode pane. * `restoreComplete` - Skips the Restore Completed pane. * `safety` - Skips the Safety pane. * `setupCellular` - Skips the add cellular plan pane. * `softwareUpdate` - Skips the mandatory software update screen in iOS. * `unlockWithWatch` - Skips Unlock Your Mac with your Apple Watch pane. * `updateComplete` - Skips the Software Update Complete pane. * `wallpaper` - Skips the Wallpaper setup. * `watchMigration` - Skips the screen for watch migration. * `welcome` - Skips the Get Started pane. * `additionalPrivacySettings` - Skips the Additional Privacy Settings pane. * `multitasking` - Skips the Multitasking pane. * `osShowcase` - Skips the OS Showcase pane. * `webContentFiltering` - Skips the Web Content Filtering pane. * `safetyAndHandling` - Skips the Safety and Handling pane. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +`IOSETUPASSISTANTOPTIONS `: A Setup Option wrapped as an object + - `[Option ]`: Options to skip screens during MacOS and iOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `actionButton` - Skips the Action Button configuration pane. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `cameraButton` - Skips the Camera Button configuration pane. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `enableLockdownMode` - Skips the Lockdown Mode pane. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `intelligence` - Skips the Intelligence pane. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `termsOfAddress` - Skips the Terms of Address pane. * `tos` - Skips terms and conditions. * `appStore` - Skips the App Store pane. * `deviceToDeviceMigration` - Skips Device to Device Migration pane. * `displayZoom` - Skips zoom setup. * `homeButton` - Skips the Meet the New Home Button screen on iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus and iPhone SE. * `imessageAndFacetime` - Skips the iMessage and FaceTime screen in iOS. * `messagingActivationUsingPhoneNumber` - Skips the iMessage pane. * `moveFromAndroid` - If the Restore pane is not skipped, removes the Move from Android option in the Restore pane on iOS.O * `passcode` - Hides and disables the passcode pane. * `restoreComplete` - Skips the Restore Completed pane. * `safety` - Skips the Safety pane. * `setupCellular` - Skips the add cellular plan pane. * `softwareUpdate` - Skips the mandatory software update screen in iOS. * `unlockWithWatch` - Skips Unlock Your Mac with your Apple Watch pane. * `updateComplete` - Skips the Software Update Complete pane. * `wallpaper` - Skips the Wallpaper setup. * `watchMigration` - Skips the screen for watch migration. * `welcome` - Skips the Get Started pane. * `additionalPrivacySettings` - Skips the Additional Privacy Settings pane. * `multitasking` - Skips the Multitasking pane. * `osShowcase` - Skips the OS Showcase pane. * `webContentFiltering` - Skips the Web Content Filtering pane. * `safetyAndHandling` - Skips the Safety and Handling pane. + +`MACOSETUPASSISTANTOPTIONS `: A Setup Option wrapped as an object + - `[Option ]`: Options to skip screens during MacOS and iOS setup: * `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded. * `actionButton` - Skips the Action Button configuration pane. * `appearance` - Skips the Choose Your Look screen. * `appleID` - Skips Apple ID setup. * `biometric` - Skips biometric setup. * `cameraButton` - Skips the Camera Button configuration pane. * `diagnostics` - Skips the App Analytics pane. * `displayTone` - Skips display tone setup. * `enableLockdownMode` - Skips the Lockdown Mode pane. * `fileVault` - Skips FileVault setup assistant screen. * `icloudDiagnostics` - Skips iCloud analytics screen. * `icloudStorage` - Skips iCloud documents and desktop screen. * `intelligence` - Skips the Intelligence pane. * `location` - Skips location services setup. * `payment` - Skips Apple Pay setup. * `privacy` - Skips the Privacy setup. * `restore` - Skips restoring from backup. * `screenTime` - Skips screen time setup. * `siri` - Skips Siri setup. * `termsOfAddress` - Skips the Terms of Address pane. * `tos` - Skips terms and conditions. * `appStore` - Skips the App Store pane. * `deviceToDeviceMigration` - Skips Device to Device Migration pane. * `displayZoom` - Skips zoom setup. * `homeButton` - Skips the Meet the New Home Button screen on iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus and iPhone SE. * `imessageAndFacetime` - Skips the iMessage and FaceTime screen in iOS. * `messagingActivationUsingPhoneNumber` - Skips the iMessage pane. * `moveFromAndroid` - If the Restore pane is not skipped, removes the Move from Android option in the Restore pane on iOS.O * `passcode` - Hides and disables the passcode pane. * `restoreComplete` - Skips the Restore Completed pane. * `safety` - Skips the Safety pane. * `setupCellular` - Skips the add cellular plan pane. * `softwareUpdate` - Skips the mandatory software update screen in iOS. * `unlockWithWatch` - Skips Unlock Your Mac with your Apple Watch pane. * `updateComplete` - Skips the Software Update Complete pane. * `wallpaper` - Skips the Wallpaper setup. * `watchMigration` - Skips the screen for watch migration. * `welcome` - Skips the Get Started pane. * `additionalPrivacySettings` - Skips the Additional Privacy Settings pane. * `multitasking` - Skips the Multitasking pane. * `osShowcase` - Skips the OS Showcase pane. * `webContentFiltering` - Skips the Web Content Filtering pane. * `safetyAndHandling` - Skips the Safety and Handling pane. + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApplicationAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApplicationAssociation.md new file mode 100644 index 000000000..51c6e1287 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApplicationAssociation.md @@ -0,0 +1,310 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApplicationAssociation.md +schema: 2.0.0 +--- + +# Set-JcSdkApplicationAssociation + +## SYNOPSIS +This endpoint allows you to manage the _direct_ associations of an Application. +A direct association can be a non-homogeneous relationship between 2 different objects, for example Application and User Groups. + +#### Sample Request +``` +curl -X POST 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations' \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user_group\", + \"id\": \"{Group_ID}\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkApplicationAssociation -ConsoleHost -ApplicationId [-Attributes ] + [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkApplicationAssociation -ConsoleHost -ApplicationId + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkApplicationAssociation -ConsoleHost -InputObject + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkApplicationAssociation -ConsoleHost -InputObject + [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint allows you to manage the _direct_ associations of an Application. +A direct association can be a non-homogeneous relationship between 2 different objects, for example Application and User Groups. + +#### Sample Request +``` +curl -X POST 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations' \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user_group\", + \"id\": \"{Group_ID}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkApplicationAssociation -ApplicationId:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkApplicationAssociation -ApplicationId:() -Id:() -Op:() -Type:() -Attributes:() +``` + + + +## PARAMETERS + +### -ApplicationId +ObjectID of the Application. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Attributes +The graph attributes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +GraphOperation (Application) + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphOperationApplicationAutoGenerated +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectID of graph object being added or removed as an association. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Op +How to modify the graph connection. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Targets which a "application" can be associated to. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGraphOperationApplicationAutoGenerated + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GraphOperation (Application) + - `Id `: The ObjectID of graph object being added or removed as an association. + - `Op `: How to modify the graph connection. + - `Type `: Targets which a "application" can be associated to. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlow.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlow.md new file mode 100644 index 000000000..a1c78ce1a --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlow.md @@ -0,0 +1,517 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlow.md +schema: 2.0.0 +--- + +# Set-JcSdkApprovalFlow + +## SYNOPSIS +Endpoint for updating a new access workflow + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkApprovalFlow -ConsoleHost -ApprovalFlowId [-ApprovalType ] + [-ApproverRequirement ] [-ApproverResources ] + [-Description ] [-FixedDuration ] [-IconColor ] [-IconUrl ] + [-MultiSelectDuration ] [-Name ] [-NonAdminApproval] + [-OrganizationObjectIdInputFile ] [-ResourceId ] + [-SlackConfig ] [-SlackEnabled] [-Status ] [-TimeBasedAccess] + [-TtlConfig ] [-VisibleTo ] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkApprovalFlow -ConsoleHost -ApprovalFlowId + -Body [-Confirm] + [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkApprovalFlow -ConsoleHost -InputObject + -Body [-Confirm] + [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkApprovalFlow -ConsoleHost -InputObject [-ApprovalType ] + [-ApproverRequirement ] [-ApproverResources ] + [-Description ] [-FixedDuration ] [-IconColor ] [-IconUrl ] + [-MultiSelectDuration ] [-Name ] [-NonAdminApproval] + [-OrganizationObjectIdInputFile ] [-ResourceId ] + [-SlackConfig ] [-SlackEnabled] [-Status ] [-TimeBasedAccess] + [-TtlConfig ] [-VisibleTo ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Endpoint for updating a new access workflow + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkApprovalFlow -ApprovalFlowId:() -ApprovalType:() -ApproverRequirement:() -ApproverResources:() -Description:() -FixedDuration:() -IconColor:() -IconUrl:() -MultiSelectDuration:() -Name:() -NonAdminApproval:() -OrganizationObjectIdInputFile:() -ResourceId:() -SlackConfig:() -SlackEnabled:() -Status:() -TimeBasedAccess:() -TtlConfig:() -VisibleTo:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkApprovalFlow -ApprovalFlowId:() -Body:() +``` + + + +## PARAMETERS + +### -ApprovalFlowId +. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApprovalType +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApproverRequirement +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApproverResources +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpcloudIngressoApproverResource[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IPaths14Hfh8UApprovalflowsApprovalflowidPutRequestbodyContentApplicationJsonSchema +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FixedDuration +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IconColor +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IconUrl +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MultiSelectDuration +. + +```yaml +Type: System.String[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NonAdminApproval +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationObjectIdInputFile +Input File for OrganizationObjectId (.) + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlackConfig +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpcloudIngressoSlackConfig[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlackEnabled +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeBasedAccess +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TtlConfig +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VisibleTo +. + +```yaml +Type: System.String[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.IPaths14Hfh8UApprovalflowsApprovalflowidPutRequestbodyContentApplicationJsonSchema + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowResponse + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`APPROVERRESOURCES `: . + - `[RequireAll ]`: + - `[ResourceId ]`: + - `[ResourceName ]`: + - `[ResourceOrder ]`: + - `[ResourceType ]`: + +`BODY `: . + - `[ApprovalType ]`: + - `[ApproverRequirement ]`: + - `[ApproverResources >]`: + - `[RequireAll ]`: + - `[ResourceId ]`: + - `[ResourceName ]`: + - `[ResourceOrder ]`: + - `[ResourceType ]`: + - `[Description ]`: + - `[FixedDuration ]`: + - `[IconColor ]`: + - `[IconUrl ]`: + - `[MultiSelectDuration >]`: + - `[Name ]`: + - `[NonAdminApproval ]`: + - `[OrganizationObjectId ]`: + - `[ResourceId ]`: + - `[SlackConfig >]`: + - `[SlackResourceId ]`: + - `[SlackEnabled ]`: + - `[Status ]`: + - `[TimeBasedAccess ]`: + - `[TtlConfig ]`: + - `[VisibleTo >]`: + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +`SLACKCONFIG `: . + - `[SlackResourceId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlowSetting.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlowSetting.md new file mode 100644 index 000000000..c9667d4a4 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlowSetting.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlowSetting.md +schema: 2.0.0 +--- + +# Set-JcSdkApprovalFlowSetting + +## SYNOPSIS +Endpoint for updating a access workflow settings for an organization + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkApprovalFlowSetting -ConsoleHost [-AdminApprovalEmail] + [-ChannelEvents ] [-ExposeApprovalProgress] + [-OrganizationObjectIdInputFile ] [-ResourceRequest] [-UserApprovalEmail] [-UserRequestEmail] + [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkApprovalFlowSetting -ConsoleHost + -Body [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Endpoint for updating a access workflow settings for an organization + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkApprovalFlowSetting -AdminApprovalEmail:() -ChannelEvents:() -ExposeApprovalProgress:() -OrganizationObjectIdInputFile:() -ResourceRequest:() -UserApprovalEmail:() -UserRequestEmail:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkApprovalFlowSetting -Body:() +``` + + + +## PARAMETERS + +### -AdminApprovalEmail +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowSettingsRequest +Parameter Sets: Set +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ChannelEvents +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpcloudIngressoChannelEvent[] +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExposeApprovalProgress +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationObjectIdInputFile +Input File for OrganizationObjectId (.) + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceRequest +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserApprovalEmail +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserRequestEmail +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowSettingsRequest + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowSettingsResponse + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: . + - `[AdminApprovalEmail ]`: + - `[ChannelEvents >]`: + - `[ChannelObjectId ]`: + - `[EventTypes >]`: + - `[ExposeApprovalProgress ]`: + - `[OrganizationObjectId ]`: + - `[ResourceRequest ]`: + - `[UserApprovalEmail ]`: + - `[UserRequestEmail ]`: + +`CHANNELEVENTS `: . + - `[ChannelObjectId ]`: + - `[EventTypes >]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCommandAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCommandAssociation.md new file mode 100644 index 000000000..5e1a02787 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCommandAssociation.md @@ -0,0 +1,314 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCommandAssociation.md +schema: 2.0.0 +--- + +# Set-JcSdkCommandAssociation + +## SYNOPSIS +This endpoint will allow you to manage the _direct_ associations of this Command. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. + + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system_group\", + \"id\": \"Group_ID\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkCommandAssociation -ConsoleHost -CommandId [-Attributes ] [-Id ] + [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkCommandAssociation -ConsoleHost -CommandId -Body + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkCommandAssociation -ConsoleHost -InputObject + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkCommandAssociation -ConsoleHost -InputObject + [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint will allow you to manage the _direct_ associations of this Command. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups. + + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system_group\", + \"id\": \"Group_ID\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkCommandAssociation -CommandId:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkCommandAssociation -CommandId:() -Id:() -Op:() -Type:() -Attributes:() +``` + + + +## PARAMETERS + +### -Attributes +The graph attributes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +GraphOperation (Command) + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphOperationCommand +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CommandId +ObjectID of the Command. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectID of graph object being added or removed as an association. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Op +How to modify the graph connection. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Targets which a "command" can be associated to. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGraphOperationCommand + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GraphOperation (Command) + - `Id `: The ObjectID of graph object being added or removed as an association. + - `Op `: How to modify the graph connection. + - `Type `: Targets which a "command" can be associated to. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCustomEmailConfiguration.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCustomEmailConfiguration.md new file mode 100644 index 000000000..f36611d3d --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCustomEmailConfiguration.md @@ -0,0 +1,335 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkCustomEmailConfiguration.md +schema: 2.0.0 +--- + +# Set-JcSdkCustomEmailConfiguration + +## SYNOPSIS +Set the custom email configuration for the specified custom email type. + +This action is only available to paying customers. + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkCustomEmailConfiguration -ConsoleHost -CustomEmailType [-Body ] + [-Button ] [-Header ] [-NextStepContactInfo ] [-Subject ] [-Title ] + [-Type ] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkCustomEmailConfiguration -ConsoleHost -CustomEmailType -CustomEmail + [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkCustomEmailConfiguration -ConsoleHost -InputObject + -CustomEmail [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkCustomEmailConfiguration -ConsoleHost -InputObject [-Body ] + [-Button ] [-Header ] [-NextStepContactInfo ] [-Subject ] [-Title ] + [-Type ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Set the custom email configuration for the specified custom email type. + +This action is only available to paying customers. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkCustomEmailConfiguration -CustomEmailType:() -CustomEmail:() +``` + +---- ---------- +Body String +Button String +Header String +Id String +NextStepContactInfo String +Subject String +Title String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkCustomEmailConfiguration -CustomEmailType:() -Subject:() -Type:() -Body:() -Button:() -Header:() -NextStepContactInfo:() -Title:() +``` + +---- ---------- +Body String +Button String +Header String +Id String +NextStepContactInfo String +Subject String +Title String +Type String + +## PARAMETERS + +### -Body +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Button +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomEmail +Custom email content created by the admin user to personalize emails sent to their system users. + +```yaml +Type: JumpCloud.SDK.V2.Models.ICustomEmail +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CustomEmailType +. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Header +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NextStepContactInfo +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subject +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Title +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.ICustomEmail + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ICustomEmail + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`CUSTOMEMAIL `: Custom email content created by the admin user to personalize emails sent to their system users. + - `Subject `: + - `Type `: + - `[Body ]`: + - `[Button ]`: + - `[Header ]`: + - `[NextStepContactInfo ]`: + - `[Title ]`: + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkDuoApplication.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkDuoApplication.md new file mode 100644 index 000000000..9a2e471c7 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkDuoApplication.md @@ -0,0 +1,316 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkDuoApplication.md +schema: 2.0.0 +--- + +# Set-JcSdkDuoApplication + +## SYNOPSIS +Set the specified Duo application. + +#### Sample Request +``` + curl -X PUT https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Application Name\", + \"apiHost\": \"api-1234.duosecurity.com\", + \"integrationKey\": \"1234\", + \"secretKey\": \"5678\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkDuoApplication -ConsoleHost -AccountId -ApplicationId [-ApiHost ] + [-IntegrationKey ] [-Name ] [-SecretKey ] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkDuoApplication -ConsoleHost -AccountId -ApplicationId + -Body [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkDuoApplication -ConsoleHost -InputObject + -Body [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkDuoApplication -ConsoleHost -InputObject [-ApiHost ] + [-IntegrationKey ] [-Name ] [-SecretKey ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Set the specified Duo application. + +#### Sample Request +``` + curl -X PUT https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Application Name\", + \"apiHost\": \"api-1234.duosecurity.com\", + \"integrationKey\": \"1234\", + \"secretKey\": \"5678\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkDuoApplication -AccountId:() -ApplicationId:() -Body:() +``` + +---- ---------- +ApiHost String +Id String +IntegrationKey String +Name String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkDuoApplication -AccountId:() -ApplicationId:() -ApiHost:() -IntegrationKey:() -Name:() -SecretKey:() +``` + +---- ---------- +ApiHost String +Id String +IntegrationKey String +Name String + +## PARAMETERS + +### -AccountId +. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiHost +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +DuoApplicationUpdateReq + +```yaml +Type: JumpCloud.SDK.V2.Models.IDuoApplicationUpdateReq +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IntegrationKey +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretKey +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IDuoApplicationUpdateReq + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IDuoApplication + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: DuoApplicationUpdateReq + - `ApiHost `: + - `IntegrationKey `: + - `Name `: + - `[SecretKey ]`: + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkGSuiteAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkGSuiteAssociation.md new file mode 100644 index 000000000..6cf979de6 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkGSuiteAssociation.md @@ -0,0 +1,314 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkGSuiteAssociation.md +schema: 2.0.0 +--- + +# Set-JcSdkGSuiteAssociation + +## SYNOPSIS +This endpoint returns the _direct_ associations of this G Suite instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user_group\", + \"id\": \"{Group_ID}\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkGSuiteAssociation -ConsoleHost -GsuiteId [-Attributes ] [-Id ] + [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkGSuiteAssociation -ConsoleHost -GsuiteId -Body + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkGSuiteAssociation -ConsoleHost -InputObject + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkGSuiteAssociation -ConsoleHost -InputObject + [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint returns the _direct_ associations of this G Suite instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user_group\", + \"id\": \"{Group_ID}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkGSuiteAssociation -GsuiteId:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkGSuiteAssociation -GsuiteId:() -Id:() -Op:() -Type:() -Attributes:() +``` + + + +## PARAMETERS + +### -Attributes +The graph attributes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +GraphOperation (GSuite) + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphOperationGSuiteAutoGenerated +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GsuiteId +ObjectID of the G Suite instance. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectID of graph object being added or removed as an association. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Op +How to modify the graph connection. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Targets which a "g_suite" can be associated to. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGraphOperationGSuiteAutoGenerated + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GraphOperation (GSuite) + - `Id `: The ObjectID of graph object being added or removed as an association. + - `Op `: How to modify the graph connection. + - `Type `: Targets which a "g_suite" can be associated to. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkIPList.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkIPList.md new file mode 100644 index 000000000..c4711b6cb --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkIPList.md @@ -0,0 +1,285 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkIPList.md +schema: 2.0.0 +--- + +# Set-JcSdkIPList + +## SYNOPSIS +Replace a specific IP list. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Sample IP List\", + \"ips\": [ + \"192.168.10.10\" + ] + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkIPList -ConsoleHost -Id [-Description ] [-Ips ] [-Name ] + [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkIPList -ConsoleHost -Id -Body [-Confirm] [-WhatIf] + [] +``` + +### SetViaIdentity +``` +Set-JcSdkIPList -ConsoleHost -InputObject -Body [-Confirm] + [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkIPList -ConsoleHost -InputObject [-Description ] + [-Ips ] [-Name ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Replace a specific IP list. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Sample IP List\", + \"ips\": [ + \"192.168.10.10\" + ] + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkIPList -Id:() -Body:() +``` + +---- ---------- +Description String +Id String +Ips String +Name String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkIPList -Id:() -Description:() -Ips:() -Name:() +``` + +---- ---------- +Description String +Id String +Ips String +Name String + +## PARAMETERS + +### -Body +IPListRequest + +```yaml +Type: JumpCloud.SDK.V2.Models.IIPListRequest +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Ips +. + +```yaml +Type: System.String[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IIPListRequest + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IIPList + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: IPListRequest + - `[Description ]`: + - `[Ips >]`: + - `[Name ]`: + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerAssociation.md new file mode 100644 index 000000000..2e1702bef --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerAssociation.md @@ -0,0 +1,312 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerAssociation.md +schema: 2.0.0 +--- + +# Set-JcSdkLdapServerAssociation + +## SYNOPSIS +This endpoint allows you to manage the _direct_ associations of a LDAP Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{User_ID}\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkLdapServerAssociation -ConsoleHost -LdapserverId [-Attributes ] + [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkLdapServerAssociation -ConsoleHost -LdapserverId + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkLdapServerAssociation -ConsoleHost -InputObject + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkLdapServerAssociation -ConsoleHost -InputObject + [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint allows you to manage the _direct_ associations of a LDAP Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{User_ID}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkLdapServerAssociation -LdapserverId:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkLdapServerAssociation -LdapserverId:() -Id:() -Op:() -Type:() -Attributes:() +``` + + + +## PARAMETERS + +### -Attributes +The graph attributes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +GraphOperation (LdapServer) + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphOperationLdapServerAutoGenerated +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectID of graph object being added or removed as an association. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LdapserverId +ObjectID of the LDAP Server. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Op +How to modify the graph connection. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Targets which a "ldap_server" can be associated to. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGraphOperationLdapServerAutoGenerated + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GraphOperation (LdapServer) + - `Id `: The ObjectID of graph object being added or removed as an association. + - `Op `: How to modify the graph connection. + - `Type `: Targets which a "ldap_server" can be associated to. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerSambaDomain.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerSambaDomain.md new file mode 100644 index 000000000..506ddbc9a --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerSambaDomain.md @@ -0,0 +1,278 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkLdapServerSambaDomain.md +schema: 2.0.0 +--- + +# Set-JcSdkLdapServerSambaDomain + +## SYNOPSIS +This endpoint allows you to set the samba domain information for an LDAP server. + +##### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"sid\":\"{SID_ID}\", + \"name\":\"{WORKGROUP_NAME}\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkLdapServerSambaDomain -ConsoleHost -Id -LdapserverId [-Name ] + [-Sid ] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkLdapServerSambaDomain -ConsoleHost -Id -LdapserverId -Body + [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkLdapServerSambaDomain -ConsoleHost -InputObject -Body + [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkLdapServerSambaDomain -ConsoleHost -InputObject [-Name ] + [-Sid ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to set the samba domain information for an LDAP server. + +##### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"sid\":\"{SID_ID}\", + \"name\":\"{WORKGROUP_NAME}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkLdapServerSambaDomain -Id:() -LdapserverId:() -Body:() +``` + +---- ---------- +Id String +Name String +Sid String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkLdapServerSambaDomain -Id:() -LdapserverId:() -Name:() -Sid:() +``` + +---- ---------- +Id String +Name String +Sid String + +## PARAMETERS + +### -Body +Samba Domain + +```yaml +Type: JumpCloud.SDK.V2.Models.ISambaDomain +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Unique identifier of the samba domain. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LdapserverId +Unique identifier of the LDAP server. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of this domain's WorkGroup + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sid +Security identifier of this domain + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.ISambaDomain + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISambaDomain + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: Samba Domain + - `Name `: Name of this domain's WorkGroup + - `Sid `: Security identifier of this domain + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkOffice365Association.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkOffice365Association.md new file mode 100644 index 000000000..3b34af7ec --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkOffice365Association.md @@ -0,0 +1,312 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkOffice365Association.md +schema: 2.0.0 +--- + +# Set-JcSdkOffice365Association + +## SYNOPSIS +This endpoint allows you to manage the _direct_ associations of a Office 365 instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user_group\", + \"id\": \"{Group_ID}\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkOffice365Association -ConsoleHost -Office365Id [-Attributes ] + [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkOffice365Association -ConsoleHost -Office365Id + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkOffice365Association -ConsoleHost -InputObject + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkOffice365Association -ConsoleHost -InputObject + [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint allows you to manage the _direct_ associations of a Office 365 instance. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user_group\", + \"id\": \"{Group_ID}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkOffice365Association -Office365Id:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkOffice365Association -Office365Id:() -Id:() -Op:() -Type:() -Attributes:() +``` + + + +## PARAMETERS + +### -Attributes +The graph attributes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +GraphOperation (Office365) + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphOperationOffice365AutoGenerated +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectID of graph object being added or removed as an association. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Office365Id +ObjectID of the Office 365 instance. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Op +How to modify the graph connection. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Targets which a "office_365" can be associated to. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGraphOperationOffice365AutoGenerated + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GraphOperation (Office365) + - `Id `: The ObjectID of graph object being added or removed as an association. + - `Op `: How to modify the graph connection. + - `Type `: Targets which a "office_365" can be associated to. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicy.md new file mode 100644 index 000000000..078b4a5dc --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicy.md @@ -0,0 +1,311 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicy.md +schema: 2.0.0 +--- + +# Set-JcSdkPolicy + +## SYNOPSIS +This endpoint allows you to set a policy. +Given the amount of configurable parameters required to set a Policy, we suggest you use the JumpCloud Admin Console to set new policies. + + +##### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/policies/59fced45c9118022172547ff \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Policy_Parameters} + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkPolicy -ConsoleHost -Id [-Name ] [-Notes ] + [-Values ] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkPolicy -ConsoleHost -Id -Body [-Confirm] [-WhatIf] + [] +``` + +### SetViaIdentity +``` +Set-JcSdkPolicy -ConsoleHost -InputObject -Body + [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkPolicy -ConsoleHost -InputObject [-Name ] [-Notes ] + [-Values ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to set a policy. +Given the amount of configurable parameters required to set a Policy, we suggest you use the JumpCloud Admin Console to set new policies. + + +##### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/policies/59fced45c9118022172547ff \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + {Policy_Parameters} + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkPolicy -Id:() -Body:() +``` + +---- ---------- +Id String +Name String +TemplateActivation String +TemplateAlert String +TemplateBehavior String +TemplateDeliveryTypes String +TemplateDescription String +TemplateDisplayName String +TemplateId String +TemplateName String +TemplateOSMetaFamily String +TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] +TemplateReference String +TemplateState String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkPolicy -Id:() -Name:() -Notes:() -Values:() +``` + +---- ---------- +Id String +Name String +TemplateActivation String +TemplateAlert String +TemplateBehavior String +TemplateDeliveryTypes String +TemplateDescription String +TemplateDisplayName String +TemplateId String +TemplateName String +TemplateOSMetaFamily String +TemplateOSRestrictions JumpCloud.SDK.V2.Models.OSRestriction[] +TemplateReference String +TemplateState String + +## PARAMETERS + +### -Body +A request to update an instance of a policy template. + +```yaml +Type: JumpCloud.SDK.V2.Models.IPolicyUpdateRequest +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of the Policy object. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The description for this specific Policy. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notes +The notes for this specific Policy. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Values +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IPolicyValue[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.IPolicyUpdateRequest + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPolicy + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: A request to update an instance of a policy template. + - `Name `: The description for this specific Policy. + - `[Notes ]`: The notes for this specific Policy. + - `[Values >]`: + - `[ConfigFieldId ]`: The ObjectId of the corresponding Policy Template configuration field. + - `[Sensitive ]`: Defines if the value is sensitive or not. + - `[Value ]`: The value for the configuration field for this Policy instance. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +`VALUES `: . + - `[ConfigFieldId ]`: The ObjectId of the corresponding Policy Template configuration field. + - `[Sensitive ]`: Defines if the value is sensitive or not. + - `[Value ]`: The value for the configuration field for this Policy instance. + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyAssociation.md new file mode 100644 index 000000000..ee96799c7 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyAssociation.md @@ -0,0 +1,312 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyAssociation.md +schema: 2.0.0 +--- + +# Set-JcSdkPolicyAssociation + +## SYNOPSIS +This endpoint allows you to manage the _direct_ associations of a Policy. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations/ \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system_group\", + \"id\": \"{Group_ID}\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkPolicyAssociation -ConsoleHost -PolicyId [-Attributes ] [-Id ] + [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkPolicyAssociation -ConsoleHost -PolicyId -Body [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkPolicyAssociation -ConsoleHost -InputObject + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkPolicyAssociation -ConsoleHost -InputObject + [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint allows you to manage the _direct_ associations of a Policy. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations/ \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system_group\", + \"id\": \"{Group_ID}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkPolicyAssociation -PolicyId:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkPolicyAssociation -PolicyId:() -Id:() -Op:() -Type:() -Attributes:() +``` + + + +## PARAMETERS + +### -Attributes +The graph attributes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +GraphOperation (Policy) + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphOperationPolicy +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectID of graph object being added or removed as an association. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Op +How to modify the graph connection. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +ObjectID of the Policy. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Targets which a "policy" can be associated to. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGraphOperationPolicy + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GraphOperation (Policy) + - `Id `: The ObjectID of graph object being added or removed as an association. + - `Op `: How to modify the graph connection. + - `Type `: Targets which a "policy" can be associated to. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroup.md new file mode 100644 index 000000000..c67be49e0 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroup.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroup.md +schema: 2.0.0 +--- + +# Set-JcSdkPolicyGroup + +## SYNOPSIS +This endpoint allows you to do a full set of the Policy Group. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/policygroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"group_set + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkPolicyGroup -ConsoleHost -Id [-Name ] [-Confirm] [-WhatIf] + [] +``` + +### Set +``` +Set-JcSdkPolicyGroup -ConsoleHost -Id -Body [-Confirm] [-WhatIf] + [] +``` + +### SetViaIdentity +``` +Set-JcSdkPolicyGroup -ConsoleHost -InputObject -Body + [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkPolicyGroup -ConsoleHost -InputObject [-Name ] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to do a full set of the Policy Group. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/policygroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"group_set + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkPolicyGroup -Id:() -Body:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +Name String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkPolicyGroup -Id:() -Name:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +Name String +Type String + +## PARAMETERS + +### -Body +PolicyGroupData + +```yaml +Type: JumpCloud.SDK.V2.Models.IPolicyGroupData +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of the Policy Group. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Display name of a Policy Group. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.IPolicyGroupData + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPolicyGroup + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: PolicyGroupData + - `Name `: Display name of a Policy Group. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupAssociation.md new file mode 100644 index 000000000..ba4c11ce2 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupAssociation.md @@ -0,0 +1,314 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupAssociation.md +schema: 2.0.0 +--- + +# Set-JcSdkPolicyGroupAssociation + +## SYNOPSIS +This endpoint manages the _direct_ associations of this Policy Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system\", + \"id\": \"{SystemID}\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkPolicyGroupAssociation -ConsoleHost -GroupId [-Attributes ] + [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkPolicyGroupAssociation -ConsoleHost -GroupId -Body + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkPolicyGroupAssociation -ConsoleHost -InputObject + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkPolicyGroupAssociation -ConsoleHost -InputObject + [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint manages the _direct_ associations of this Policy Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Policy Groups and Policies. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system\", + \"id\": \"{SystemID}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkPolicyGroupAssociation -GroupId:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkPolicyGroupAssociation -GroupId:() -Id:() -Op:() -Type:() -Attributes:() +``` + + + +## PARAMETERS + +### -Attributes +The graph attributes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +GraphOperation (PolicyGroup) + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphOperationPolicyGroup +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the Policy Group. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectID of graph object being added or removed as an association. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Op +How to modify the graph connection. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Targets which a "policy_group" can be associated to. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGraphOperationPolicyGroup + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GraphOperation (PolicyGroup) + - `Id `: The ObjectID of graph object being added or removed as an association. + - `Op `: How to modify the graph connection. + - `Type `: Targets which a "policy_group" can be associated to. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupMember.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupMember.md new file mode 100644 index 000000000..9ec5f6ef8 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupMember.md @@ -0,0 +1,291 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkPolicyGroupMember.md +schema: 2.0.0 +--- + +# Set-JcSdkPolicyGroupMember + +## SYNOPSIS +This endpoint allows you to manage the Policy members of a Policy Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"policy\", + \"id\": \"{Policy_ID}\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkPolicyGroupMember -ConsoleHost -GroupId [-Attributes ] [-Id ] + [-Op ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkPolicyGroupMember -ConsoleHost -GroupId -Body + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkPolicyGroupMember -ConsoleHost -InputObject + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkPolicyGroupMember -ConsoleHost -InputObject + [-Attributes ] [-Id ] [-Op ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to manage the Policy members of a Policy Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/policygroups/{GroupID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"policy\", + \"id\": \"{Policy_ID}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkPolicyGroupMember -GroupId:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkPolicyGroupMember -GroupId:() -Id:() -Op:() -Attributes:() +``` + + + +## PARAMETERS + +### -Attributes +The graph attributes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +GraphOperation (PolicyGroup-Member) + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphOperationPolicyGroupMember +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the Policy Group. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectID of graph object being added or removed as an association. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Op +How to modify the graph connection. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGraphOperationPolicyGroupMember + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GraphOperation (PolicyGroup-Member) + - `Id `: The ObjectID of graph object being added or removed as an association. + - `Op `: How to modify the graph connection. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkRadiusServerAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkRadiusServerAssociation.md new file mode 100644 index 000000000..eb66ab80d --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkRadiusServerAssociation.md @@ -0,0 +1,316 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkRadiusServerAssociation.md +schema: 2.0.0 +--- + +# Set-JcSdkRadiusServerAssociation + +## SYNOPSIS +This endpoint allows you to manage the _direct_ associations of a Radius Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ +\t +\"type\":\"user\", +\"id\":\"{USER_ID}\", +\"op\":\"add\" +\t +}' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkRadiusServerAssociation -ConsoleHost -RadiusserverId [-Attributes ] + [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkRadiusServerAssociation -ConsoleHost -RadiusserverId + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkRadiusServerAssociation -ConsoleHost -InputObject + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkRadiusServerAssociation -ConsoleHost -InputObject + [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint allows you to manage the _direct_ associations of a Radius Server. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ +\t +\"type\":\"user\", +\"id\":\"{USER_ID}\", +\"op\":\"add\" +\t +}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkRadiusServerAssociation -RadiusserverId:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkRadiusServerAssociation -RadiusserverId:() -Id:() -Op:() -Type:() -Attributes:() +``` + + + +## PARAMETERS + +### -Attributes +The graph attributes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +GraphOperation (RadiusServer) + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphOperationRadiusServerAutoGenerated +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectID of graph object being added or removed as an association. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Op +How to modify the graph connection. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RadiusserverId +ObjectID of the Radius Server. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Targets which a "radius_server" can be associated to. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGraphOperationRadiusServerAutoGenerated + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GraphOperation (RadiusServer) + - `Id `: The ObjectID of graph object being added or removed as an association. + - `Op `: How to modify the graph connection. + - `Type `: Targets which a "radius_server" can be associated to. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareApp.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareApp.md new file mode 100644 index 000000000..b7327c3a2 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareApp.md @@ -0,0 +1,561 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareApp.md +schema: 2.0.0 +--- + +# Set-JcSdkSoftwareApp + +## SYNOPSIS +This endpoint set a specific Software Application configuration for the organization. +displayName can be changed alone if no settings are provided. +If a setting is provided, it should include all its information since this endpoint will set all the settings' fields. +The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. + +#### Sample Request - displayName only +``` + curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"displayName\": \"My Software App\" + }' +``` + +#### Sample Request - all attributes +``` + curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"displayName\": \"My Software App\", + \"settings\": [ + { + \"packageId\": \"123456\", + \"autoset : false, + \"allowUpdateDelay\": false, + \"packageManager\": \"APPLE_VPP\", + \"locationObjectId\": \"123456789012123456789012\", + \"location\": \"123456\", + \"desiredState\": \"Install\", + \"appleVpp\": { + \"appConfiguration\": \"\\\\\MyKey\\My String\\\\", + \"assignedLicenses\": 20, + \"availableLicenses\": 10, + \"details\": {}, + \"isConfigEnabled\": true, + \"supportedDeviceFamilies\": [ + \"IPAD\", + \"MAC\" + ], + \"totalLicenses\": 30 + }, + \"packageSubtitle\": \"My package subtitle\", + \"packageVersion\": \"1.2.3\", + \"packageKind\": \"software-package\", + \"assetKind\": \"software\", + \"assetSha256Size\": 256, + \"assetSha256Strings\": [ + \"a123b123c123d123\" + ], + \"description\": \"My app description\" + } + ] + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkSoftwareApp -ConsoleHost -Id [-CreatedAt ] [-DisplayName ] + [-Id1 ] [-Settings ] [-UpdatedAt ] [-Confirm] [-WhatIf] + [] +``` + +### Set +``` +Set-JcSdkSoftwareApp -ConsoleHost -Id -Body [-Confirm] [-WhatIf] + [] +``` + +### SetViaIdentity +``` +Set-JcSdkSoftwareApp -ConsoleHost -InputObject -Body + [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkSoftwareApp -ConsoleHost -InputObject [-Id ] + [-CreatedAt ] [-DisplayName ] [-Settings ] [-UpdatedAt ] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint set a specific Software Application configuration for the organization. +displayName can be changed alone if no settings are provided. +If a setting is provided, it should include all its information since this endpoint will set all the settings' fields. +The optional isConfigEnabled and appConfiguration apple_vpp attributes are not included in the response. + +#### Sample Request - displayName only +``` + curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"displayName\": \"My Software App\" + }' +``` + +#### Sample Request - all attributes +``` + curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"displayName\": \"My Software App\", + \"settings\": [ + { + \"packageId\": \"123456\", + \"autoset : false, + \"allowUpdateDelay\": false, + \"packageManager\": \"APPLE_VPP\", + \"locationObjectId\": \"123456789012123456789012\", + \"location\": \"123456\", + \"desiredState\": \"Install\", + \"appleVpp\": { + \"appConfiguration\": \"\\\\\MyKey\\My String\\\\", + \"assignedLicenses\": 20, + \"availableLicenses\": 10, + \"details\": {}, + \"isConfigEnabled\": true, + \"supportedDeviceFamilies\": [ + \"IPAD\", + \"MAC\" + ], + \"totalLicenses\": 30 + }, + \"packageSubtitle\": \"My package subtitle\", + \"packageVersion\": \"1.2.3\", + \"packageKind\": \"software-package\", + \"assetKind\": \"software\", + \"assetSha256Size\": 256, + \"assetSha256Strings\": [ + \"a123b123c123d123\" + ], + \"description\": \"My app description\" + } + ] + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkSoftwareApp -Id:() -Body:() +``` + +---- ---------- +DisplayName String +Id String +Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkSoftwareApp -Id:() -DisplayName:() -Id1:() -Settings:() +``` + +---- ---------- +DisplayName String +Id String +Settings JumpCloud.SDK.V2.Models.SoftwareAppSettings[] + +## PARAMETERS + +### -Body +Software Application Package + +```yaml +Type: JumpCloud.SDK.V2.Models.ISoftwareApp +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreatedAt +. + +```yaml +Type: System.DateTime +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id1 +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Settings +. + +```yaml +Type: JumpCloud.SDK.V2.Models.ISoftwareAppSettings[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdatedAt +. + +```yaml +Type: System.DateTime +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.ISoftwareApp + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISoftwareApp + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: Software Application Package + - `[CreatedAt ]`: + - `[DisplayName ]`: + - `[Id ]`: + - `[Settings >]`: + - `[AllowUpdateDelay ]`: + - `[AppCatalogInstallableObjectId ]`: ID of the app catalog installable that created this app. + - `[AppFileName ]`: + - `[AppleVppAppConfiguration ]`: Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'. + - `[AppleVppAssignedLicenses ]`: + - `[AppleVppAvailableLicenses ]`: + - `[AppleVppDetails ]`: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[AppleVppIsConfigEnabled ]`: Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''. + - `[AppleVppSupportedDeviceFamilies >]`: The supported device families for this VPP Application. + - `[AppleVppTotalLicenses ]`: + - `[Architectures >]`: + - `[AssetKind ]`: The manifest asset kind (ex: software). + - `[AssetSha256Size ]`: The incremental size to use for summing the package as it is downloaded. + - `[AssetSha256Strings >]`: The array of checksums, one each for the hash size up to the total size of the package. + - `[AutoUpdate ]`: + - `[BundleId ]`: + - `[CommandLineArguments ]`: Command line arguments to use with the application. + - `[CreatedAt ]`: + - `[Description ]`: The software app description. + - `[DesiredState ]`: State of Install or Uninstall + - `[DownloadUrl ]`: + - `[EnterpriseObjectId ]`: ID of the Enterprise with which this app is associated + - `[Format ]`: + - `[GoogleAndroidAppPricing ]`: Whether this app is free, free with in-app purchases, or paid. + - `[GoogleAndroidAppVersion ]`: Latest version currently available for this app. + - `[GoogleAndroidAuthor ]`: The name of the author of this app. + - `[GoogleAndroidAutoUpdateMode ]`: Controls the auto-update mode for the app. + - `[GoogleAndroidCategory ]`: The app category (e.g. COMMUNICATION, SOCIAL, etc.). + - `[GoogleAndroidContentRating ]`: The content rating for this app. + - `[GoogleAndroidDisplayMode ]`: The display mode of the web app. + - `[GoogleAndroidDistributionChannel ]`: How and to whom the package is made available. + - `[GoogleAndroidFeatures >]`: The array of android features for the app. + - `[GoogleAndroidFullDescription ]`: Full app description, if available. + - `[GoogleAndroidIconUrl ]`: A link to an image that can be used as an icon for the app. + - `[GoogleAndroidInstallType ]`: The type of installation to perform for an app. + - `[GoogleAndroidManagedConfigurationTemplateId ]`: The managed configurations template for the app. + - `[GoogleAndroidManagedProperties ]`: Indicates whether this app has managed properties or not. + - `[GoogleAndroidMinSdkVersion ]`: The minimum Android SDK necessary to run the app. + - `[GoogleAndroidName ]`: The name of the app in the form enterprises/{enterprise}/applications/{packageName}. + - `[GoogleAndroidPermissionGrants >]`: + - `[Id ]`: An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR. + - `[Policy ]`: The policy for granting the permission. + - `[GoogleAndroidRuntimePermission ]`: The policy for granting permission requests to apps. + - `[GoogleAndroidStartUrl ]`: The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps. + - `[GoogleAndroidType ]`: Type of this android application. + - `[GoogleAndroidUpdateTime ]`: The approximate time (within 7 days) the app was last published. + - `[GoogleAndroidVersionCode ]`: The current version of the web app. + - `[IconUrl ]`: URL to the icon for the app. + - `[Location ]`: Repository where the app is located within the package manager + - `[LocationObjectId ]`: ID of the repository where the app is located within the package manager + - `[MicrosoftStoreDoNotUpdate ]`: Indicates whether the app can be updated or not. + - `[MicrosoftStoreNonRemovable ]`: Indicates whether the app is removable by the users or not. + - `[MicrosoftStorePackageFamilyName ]`: Package Family Name for the app from Microsoft App Store. + - `[ObjectId ]`: + - `[PackageId ]`: + - `[PackageKind ]`: The package manifest kind (ex: software-package). + - `[PackageManager ]`: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. + - `[PackageSubtitle ]`: The package manifest subtitle. + - `[PackageVersion ]`: The package manifest version. + - `[PackageVersionUpdatedAt ]`: + - `[Scope ]`: The installation scope of the software app. + - `[ShortVersion ]`: + - `[StoredPackageObjectId ]`: ID of the stored package this app uses to reference the stored install media. + - `[StoredPackageVersions >]`: + - `[Metadata ]`: Dictionary of + - `[(Any) ]`: This indicates any property can be added to this object. + - `[Name ]`: + - `[RejectedReason ]`: + - `[Sha256Sum ]`: + - `[Size ]`: + - `[Status ]`: + - `[Version ]`: + - `[TeamId ]`: + - `[UpdateTool ]`: + - `[UpdateToolArguments ]`: + - `[UpdatedAt ]`: + - `[VersionlessDownloadUrl ]`: + - `[UpdatedAt ]`: + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +`SETTINGS `: . + - `[AllowUpdateDelay ]`: + - `[AppCatalogInstallableObjectId ]`: ID of the app catalog installable that created this app. + - `[AppFileName ]`: + - `[AppleVppAppConfiguration ]`: Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'. + - `[AppleVppAssignedLicenses ]`: + - `[AppleVppAvailableLicenses ]`: + - `[AppleVppDetails ]`: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[AppleVppIsConfigEnabled ]`: Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''. + - `[AppleVppSupportedDeviceFamilies >]`: The supported device families for this VPP Application. + - `[AppleVppTotalLicenses ]`: + - `[Architectures >]`: + - `[AssetKind ]`: The manifest asset kind (ex: software). + - `[AssetSha256Size ]`: The incremental size to use for summing the package as it is downloaded. + - `[AssetSha256Strings >]`: The array of checksums, one each for the hash size up to the total size of the package. + - `[AutoUpdate ]`: + - `[BundleId ]`: + - `[CommandLineArguments ]`: Command line arguments to use with the application. + - `[CreatedAt ]`: + - `[Description ]`: The software app description. + - `[DesiredState ]`: State of Install or Uninstall + - `[DownloadUrl ]`: + - `[EnterpriseObjectId ]`: ID of the Enterprise with which this app is associated + - `[Format ]`: + - `[GoogleAndroidAppPricing ]`: Whether this app is free, free with in-app purchases, or paid. + - `[GoogleAndroidAppVersion ]`: Latest version currently available for this app. + - `[GoogleAndroidAuthor ]`: The name of the author of this app. + - `[GoogleAndroidAutoUpdateMode ]`: Controls the auto-update mode for the app. + - `[GoogleAndroidCategory ]`: The app category (e.g. COMMUNICATION, SOCIAL, etc.). + - `[GoogleAndroidContentRating ]`: The content rating for this app. + - `[GoogleAndroidDisplayMode ]`: The display mode of the web app. + - `[GoogleAndroidDistributionChannel ]`: How and to whom the package is made available. + - `[GoogleAndroidFeatures >]`: The array of android features for the app. + - `[GoogleAndroidFullDescription ]`: Full app description, if available. + - `[GoogleAndroidIconUrl ]`: A link to an image that can be used as an icon for the app. + - `[GoogleAndroidInstallType ]`: The type of installation to perform for an app. + - `[GoogleAndroidManagedConfigurationTemplateId ]`: The managed configurations template for the app. + - `[GoogleAndroidManagedProperties ]`: Indicates whether this app has managed properties or not. + - `[GoogleAndroidMinSdkVersion ]`: The minimum Android SDK necessary to run the app. + - `[GoogleAndroidName ]`: The name of the app in the form enterprises/{enterprise}/applications/{packageName}. + - `[GoogleAndroidPermissionGrants >]`: + - `[Id ]`: An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR. + - `[Policy ]`: The policy for granting the permission. + - `[GoogleAndroidRuntimePermission ]`: The policy for granting permission requests to apps. + - `[GoogleAndroidStartUrl ]`: The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps. + - `[GoogleAndroidType ]`: Type of this android application. + - `[GoogleAndroidUpdateTime ]`: The approximate time (within 7 days) the app was last published. + - `[GoogleAndroidVersionCode ]`: The current version of the web app. + - `[IconUrl ]`: URL to the icon for the app. + - `[Location ]`: Repository where the app is located within the package manager + - `[LocationObjectId ]`: ID of the repository where the app is located within the package manager + - `[MicrosoftStoreDoNotUpdate ]`: Indicates whether the app can be updated or not. + - `[MicrosoftStoreNonRemovable ]`: Indicates whether the app is removable by the users or not. + - `[MicrosoftStorePackageFamilyName ]`: Package Family Name for the app from Microsoft App Store. + - `[ObjectId ]`: + - `[PackageId ]`: + - `[PackageKind ]`: The package manifest kind (ex: software-package). + - `[PackageManager ]`: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. + - `[PackageSubtitle ]`: The package manifest subtitle. + - `[PackageVersion ]`: The package manifest version. + - `[PackageVersionUpdatedAt ]`: + - `[Scope ]`: The installation scope of the software app. + - `[ShortVersion ]`: + - `[StoredPackageObjectId ]`: ID of the stored package this app uses to reference the stored install media. + - `[StoredPackageVersions >]`: + - `[Metadata ]`: Dictionary of + - `[(Any) ]`: This indicates any property can be added to this object. + - `[Name ]`: + - `[RejectedReason ]`: + - `[Sha256Sum ]`: + - `[Size ]`: + - `[Status ]`: + - `[Version ]`: + - `[TeamId ]`: + - `[UpdateTool ]`: + - `[UpdateToolArguments ]`: + - `[UpdatedAt ]`: + - `[VersionlessDownloadUrl ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareAppAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareAppAssociation.md new file mode 100644 index 000000000..e880cf129 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareAppAssociation.md @@ -0,0 +1,308 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareAppAssociation.md +schema: 2.0.0 +--- + +# Set-JcSdkSoftwareAppAssociation + +## SYNOPSIS +This endpoint allows you to associate or disassociate a software application to a system or system group. + +#### Sample Request +``` +$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '{ + \"id\": \"\\", + \"op\": \"add\", + \"type\": \"system\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkSoftwareAppAssociation -ConsoleHost -SoftwareAppId [-Attributes ] + [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkSoftwareAppAssociation -ConsoleHost -SoftwareAppId + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkSoftwareAppAssociation -ConsoleHost -InputObject + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkSoftwareAppAssociation -ConsoleHost -InputObject + [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint allows you to associate or disassociate a software application to a system or system group. + +#### Sample Request +``` +$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations \\ +-H 'Accept: application/json' \\ +-H 'Content-Type: application/json' \\ +-H 'x-api-key: {API_KEY}' \\ +-d '{ + \"id\": \"\\", + \"op\": \"add\", + \"type\": \"system\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkSoftwareAppAssociation -SoftwareAppId:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkSoftwareAppAssociation -SoftwareAppId:() -Id:() -Op:() -Type:() -Attributes:() +``` + + + +## PARAMETERS + +### -Attributes +The graph attributes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +GraphOperation (SoftwareApp) + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphOperationSoftwareApp +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectID of graph object being added or removed as an association. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Op +How to modify the graph connection. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftwareAppId +ObjectID of the Software App. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Targets which a "software_app" can be associated to. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGraphOperationSoftwareApp + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GraphOperation (SoftwareApp) + - `Id `: The ObjectID of graph object being added or removed as an association. + - `Op `: How to modify the graph connection. + - `Type `: Targets which a "software_app" can be associated to. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemAssociation.md new file mode 100644 index 000000000..a60a1d1f7 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemAssociation.md @@ -0,0 +1,360 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemAssociation.md +schema: 2.0.0 +--- + +# Set-JcSdkSystemAssociation + +## SYNOPSIS +This endpoint allows you to manage the _direct_ associations of a System. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"attributes\": { + \"sudo\": { + \"enabled\": true, + \"withoutPassword\": false + } + }, + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"UserID\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkSystemAssociation -ConsoleHost -SystemId [-Authorization ] [-Date ] + [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### Set +``` +Set-JcSdkSystemAssociation -ConsoleHost -SystemId -Body + [-Authorization ] [-Date ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkSystemAssociation -ConsoleHost -InputObject + -Body [-Authorization ] [-Date ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkSystemAssociation -ConsoleHost -InputObject + [-Authorization ] [-Date ] [-Attributes ] [-Id ] [-Op ] + [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to manage the _direct_ associations of a System. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"attributes\": { + \"sudo\": { + \"enabled\": true, + \"withoutPassword\": false + } + }, + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"UserID\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkSystemAssociation -SystemId:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkSystemAssociation -SystemId:() -Id:() -Op:() -Type:() -Attributes:() +``` + + + +## PARAMETERS + +### -Attributes +. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authorization +Authorization header for the System Context API + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +GraphOperation (System) + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphOperationSystem +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Date +Current date header for the System Context API + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectID of graph object being added or removed as an association. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Op +How to modify the graph connection. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SystemId +ObjectID of the System. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Targets which a "system" can be associated to. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGraphOperationSystem + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GraphOperation (System) + - `Id `: The ObjectID of graph object being added or removed as an association. + - `Op `: How to modify the graph connection. + - `Type `: Targets which a "system" can be associated to. + - `[Attributes ]`: + - `[(Any) ]`: This indicates any property can be added to this object. + - `[SudoEnabled ]`: Enables sudo + - `[SudoWithoutPassword ]`: Enable sudo without password (requires 'enabled' to be true) + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroup.md new file mode 100644 index 000000000..55e5e1f4f --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroup.md @@ -0,0 +1,425 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroup.md +schema: 2.0.0 +--- + +# Set-JcSdkSystemGroup + +## SYNOPSIS +This endpoint allows you to do a full set of the System Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Name_set + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkSystemGroup -ConsoleHost -Id [-Attributes ] [-Description ] + [-Email ] [-MemberQueryExemptions ] [-MemberQueryFilters ] + [-MemberQuerySearchFilters ] [-MemberQueryType ] [-MembershipMethod ] + [-MemberSuggestionsNotify] [-Name ] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkSystemGroup -ConsoleHost -Id -Body [-Confirm] [-WhatIf] + [] +``` + +### SetViaIdentity +``` +Set-JcSdkSystemGroup -ConsoleHost -InputObject -Body + [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkSystemGroup -ConsoleHost -InputObject [-Attributes ] + [-Description ] [-Email ] [-MemberQueryExemptions ] + [-MemberQueryFilters ] [-MemberQuerySearchFilters ] [-MemberQueryType ] + [-MembershipMethod ] [-MemberSuggestionsNotify] [-Name ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint allows you to do a full set of the System Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"Name_set + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkSystemGroup -Id:() -Body:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkSystemGroup -Id:() -Name:() -Attributes:() -Description:() -Email:() -MemberQueryExemptions:() -MemberQueryFilters:() -MemberQueryType:() -MemberSuggestionsNotify:() -MembershipMethod:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GraphAttributes +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +Type String + +## PARAMETERS + +### -Attributes +The graph attributes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +SystemGroupPut + +```yaml +Type: JumpCloud.SDK.V2.Models.ISystemGroupPut +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of a System Group + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Email +Email address of a System Group + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of the System Group. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MemberQueryExemptions +Array of GraphObjects exempted from the query + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphObject[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberQueryFilters +For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. + +```yaml +Type: System.String[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberQuerySearchFilters +For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberQueryType +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MembershipMethod +The type of membership method for this group. +Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED.Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices).Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberSuggestionsNotify +True if notification emails are to be sent for membership suggestions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Display name of a System Group. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.ISystemGroupPut + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.ISystemGroup + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: SystemGroupPut + - `Name `: Display name of a System Group. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[Description ]`: Description of a System Group + - `[Email ]`: Email address of a System Group + - `[MemberQueryExemptions >]`: Array of GraphObjects exempted from the query + - `Id `: The ObjectID of the graph object. + - `Type `: The type of graph object. + - `[Attributes ]`: The graph attributes. + - `[MemberQueryFilters >]`: For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. + - `[MemberQuerySearchFilters ]`: For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. + - `[MemberQueryType ]`: + - `[MemberSuggestionsNotify ]`: True if notification emails are to be sent for membership suggestions. + - `[MembershipMethod ]`: The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED. Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices). Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +`MEMBERQUERYEXEMPTIONS `: Array of GraphObjects exempted from the query + - `Id `: The ObjectID of the graph object. + - `Type `: The type of graph object. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupAssociation.md new file mode 100644 index 000000000..fe8e44005 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupAssociation.md @@ -0,0 +1,314 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupAssociation.md +schema: 2.0.0 +--- + +# Set-JcSdkSystemGroupAssociation + +## SYNOPSIS +This endpoint allows you to manage the _direct_ associations of a System Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{UserID}\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkSystemGroupAssociation -ConsoleHost -GroupId [-Attributes ] + [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkSystemGroupAssociation -ConsoleHost -GroupId -Body + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkSystemGroupAssociation -ConsoleHost -InputObject + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkSystemGroupAssociation -ConsoleHost -InputObject + [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint allows you to manage the _direct_ associations of a System Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{UserID}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkSystemGroupAssociation -GroupId:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkSystemGroupAssociation -GroupId:() -Id:() -Op:() -Type:() -Attributes:() +``` + + + +## PARAMETERS + +### -Attributes +The graph attributes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +GraphOperation (SystemGroup) + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphOperationSystemGroup +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the System Group. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectID of graph object being added or removed as an association. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Op +How to modify the graph connection. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Targets which a "system_group" can be associated to. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGraphOperationSystemGroup + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GraphOperation (SystemGroup) + - `Id `: The ObjectID of graph object being added or removed as an association. + - `Op `: How to modify the graph connection. + - `Type `: Targets which a "system_group" can be associated to. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupMember.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupMember.md new file mode 100644 index 000000000..1ec9f9acb --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupMember.md @@ -0,0 +1,323 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSystemGroupMember.md +schema: 2.0.0 +--- + +# Set-JcSdkSystemGroupMember + +## SYNOPSIS +This endpoint allows you to manage the system members of a System Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system\", + \"id\": \"{System_ID}\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkSystemGroupMember -ConsoleHost -GroupId [-Authorization ] [-Date ] + [-Attributes ] [-Id ] [-Op ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkSystemGroupMember -ConsoleHost -GroupId -Body + [-Authorization ] [-Date ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkSystemGroupMember -ConsoleHost -InputObject + -Body [-Authorization ] [-Date ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkSystemGroupMember -ConsoleHost -InputObject + [-Authorization ] [-Date ] [-Attributes ] [-Id ] [-Op ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to manage the system members of a System Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system\", + \"id\": \"{System_ID}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkSystemGroupMember -GroupId:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkSystemGroupMember -GroupId:() -Id:() -Op:() -Attributes:() +``` + + + +## PARAMETERS + +### -Attributes +The graph attributes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authorization +Authorization header for the System Context API + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +GraphOperation (SystemGroup-Member) + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphOperationSystemGroupMember +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Date +Current date header for the System Context API + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the System Group. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectID of graph object being added or removed as an association. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Op +How to modify the graph connection. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGraphOperationSystemGroupMember + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GraphOperation (SystemGroup-Member) + - `Id `: The ObjectID of graph object being added or removed as an association. + - `Op `: How to modify the graph connection. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserAssociation.md new file mode 100644 index 000000000..c4e96950a --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserAssociation.md @@ -0,0 +1,327 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserAssociation.md +schema: 2.0.0 +--- + +# Set-JcSdkUserAssociation + +## SYNOPSIS +This endpoint allows you to manage the _direct_ associations of a User. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"attributes\": { + \"sudo\": { + \"enabled\": true, + \"withoutPassword\": false + } + }, + \"op\": \"add\", + \"type\": \"system_group\", + \"id\": \"{GroupID}\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkUserAssociation -ConsoleHost -UserId [-Attributes ] [-Id ] + [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkUserAssociation -ConsoleHost -UserId -Body [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkUserAssociation -ConsoleHost -InputObject + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkUserAssociation -ConsoleHost -InputObject [-Attributes ] + [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to manage the _direct_ associations of a User. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"attributes\": { + \"sudo\": { + \"enabled\": true, + \"withoutPassword\": false + } + }, + \"op\": \"add\", + \"type\": \"system_group\", + \"id\": \"{GroupID}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkUserAssociation -UserId:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkUserAssociation -UserId:() -Id:() -Op:() -Type:() -Attributes:() +``` + + + +## PARAMETERS + +### -Attributes +. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +GraphOperation (User) + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphOperationUser +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectID of graph object being added or removed as an association. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Op +How to modify the graph connection. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Targets which a "user" can be associated to. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +ObjectID of the User. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGraphOperationUser + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GraphOperation (User) + - `Id `: The ObjectID of graph object being added or removed as an association. + - `Op `: How to modify the graph connection. + - `Type `: Targets which a "user" can be associated to. + - `[Attributes ]`: + - `[(Any) ]`: This indicates any property can be added to this object. + - `[SudoEnabled ]`: Enables sudo + - `[SudoWithoutPassword ]`: Enable sudo without password (requires 'enabled' to be true) + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroup.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroup.md new file mode 100644 index 000000000..5bc9dc476 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroup.md @@ -0,0 +1,443 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroup.md +schema: 2.0.0 +--- + +# Set-JcSdkUserGroup + +## SYNOPSIS +This endpoint allows you to do a full set of the User Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"group_set + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkUserGroup -ConsoleHost -Id [-Attributes ] [-Description ] + [-Email ] [-MemberQueryExemptions ] [-MemberQueryFilters ] + [-MemberQuerySearchFilters ] [-MemberQueryType ] [-MembershipMethod ] + [-MemberSuggestionsNotify] [-Name ] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkUserGroup -ConsoleHost -Id -Body [-Confirm] [-WhatIf] + [] +``` + +### SetViaIdentity +``` +Set-JcSdkUserGroup -ConsoleHost -InputObject -Body [-Confirm] + [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkUserGroup -ConsoleHost -InputObject [-Attributes ] + [-Description ] [-Email ] [-MemberQueryExemptions ] + [-MemberQueryFilters ] [-MemberQuerySearchFilters ] [-MemberQueryType ] + [-MembershipMethod ] [-MemberSuggestionsNotify] [-Name ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint allows you to do a full set of the User Group. + +See the [Dynamic Group Configuration KB article](https://jumpcloud.com/support/configure-dynamic-device-groups) for more details on maintaining a Dynamic Group. + +#### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"name\": \"group_set + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkUserGroup -Id:() -Body:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +SuggestionCountAdd Int +SuggestionCountRemove Int +SuggestionCountTotal Int +Type String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkUserGroup -Id:() -Name:() -Attributes:() -Description:() -Email:() -MemberQueryExemptions:() -MemberQueryFilters:() -MemberQueryType:() -MemberSuggestionsNotify:() -MembershipMethod:() +``` + +---- ---------- +Attributes JumpCloud.SDK.V2.Models.GroupAttributesUserGroup +Description String +Email String +Id String +MemberQueryExemptions JumpCloud.SDK.V2.Models.GraphObject[] +MemberQueryFilters JumpCloud.SDK.V2.Models.Any[] +MemberQueryType String +MembershipMethod String +MemberSuggestionsNotify Boolean +Name String +SuggestionCountAdd Int +SuggestionCountRemove Int +SuggestionCountTotal Int +Type String + +## PARAMETERS + +### -Attributes +The graph attributes for a UserGroup. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +UserGroupPut + +```yaml +Type: JumpCloud.SDK.V2.Models.IUserGroupPut +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of a User Group + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Email +Email address of a User Group + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ObjectID of the User Group. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MemberQueryExemptions +Array of GraphObjects exempted from the query + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphObject[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberQueryFilters +For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. + +```yaml +Type: System.String[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberQuerySearchFilters +For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberQueryType +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MembershipMethod +The type of membership method for this group. +Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED.Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices).Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberSuggestionsNotify +True if notification emails are to be sent for membership suggestions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Display name of a User Group. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.IUserGroupPut + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IUserGroup + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: UserGroupPut + - `Name `: Display name of a User Group. + - `[Attributes ]`: The graph attributes for a UserGroup. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[SudoEnabled ]`: Enables sudo + - `[SudoWithoutPassword ]`: Enable sudo without password (requires 'enabled' to be true) + - `[LdapGroups >]`: + - `[Name ]`: + - `[PosixGroups >]`: + - `Id `: + - `Name `: + - `[RadiusReply >]`: + - `Name `: + - `Value `: + - `[SambaEnabled ]`: + - `[Description ]`: Description of a User Group + - `[Email ]`: Email address of a User Group + - `[MemberQueryExemptions >]`: Array of GraphObjects exempted from the query + - `Id `: The ObjectID of the graph object. + - `Type `: The type of graph object. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[MemberQueryFilters >]`: For queryType 'Filter', this is a stringified JSON filter array that will be validated by API middleware. + - `[MemberQuerySearchFilters ]`: For queryType 'Search', this is a stringified JSON filter object that will be validated by API middleware. + - `[MemberQueryType ]`: + - `[MemberSuggestionsNotify ]`: True if notification emails are to be sent for membership suggestions. + - `[MembershipMethod ]`: The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED. Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices). Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +`MEMBERQUERYEXEMPTIONS `: Array of GraphObjects exempted from the query + - `Id `: The ObjectID of the graph object. + - `Type `: The type of graph object. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupAssociation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupAssociation.md new file mode 100644 index 000000000..03f43ec87 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupAssociation.md @@ -0,0 +1,314 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupAssociation.md +schema: 2.0.0 +--- + +# Set-JcSdkUserGroupAssociation + +## SYNOPSIS +This endpoint manages the _direct_ associations of this User Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system\", + \"id\": \"{SystemID}\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkUserGroupAssociation -ConsoleHost -GroupId [-Attributes ] [-Id ] + [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkUserGroupAssociation -ConsoleHost -GroupId -Body + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkUserGroupAssociation -ConsoleHost -InputObject + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkUserGroupAssociation -ConsoleHost -InputObject + [-Attributes ] [-Id ] [-Op ] [-Type ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint manages the _direct_ associations of this User Group. + +A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. + + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"system\", + \"id\": \"{SystemID}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkUserGroupAssociation -GroupId:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkUserGroupAssociation -GroupId:() -Id:() -Op:() -Type:() -Attributes:() +``` + + + +## PARAMETERS + +### -Attributes +The graph attributes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +GraphOperation (UserGroup) + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphOperationUserGroup +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the User Group. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectID of graph object being added or removed as an association. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Op +How to modify the graph connection. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Targets which a "user_group" can be associated to. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGraphOperationUserGroup + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GraphOperation (UserGroup) + - `Id `: The ObjectID of graph object being added or removed as an association. + - `Op `: How to modify the graph connection. + - `Type `: Targets which a "user_group" can be associated to. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupMember.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupMember.md new file mode 100644 index 000000000..e74d19a43 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupMember.md @@ -0,0 +1,291 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkUserGroupMember.md +schema: 2.0.0 +--- + +# Set-JcSdkUserGroupMember + +## SYNOPSIS +This endpoint allows you to manage the user members of a User Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{User_ID}\" + }' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkUserGroupMember -ConsoleHost -GroupId [-Attributes ] [-Id ] + [-Op ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkUserGroupMember -ConsoleHost -GroupId -Body + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentity +``` +Set-JcSdkUserGroupMember -ConsoleHost -InputObject + -Body [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkUserGroupMember -ConsoleHost -InputObject [-Attributes ] + [-Id ] [-Op ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to manage the user members of a User Group. + +#### Sample Request +``` +curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"op\": \"add\", + \"type\": \"user\", + \"id\": \"{User_ID}\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkUserGroupMember -GroupId:() -Body:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkUserGroupMember -GroupId:() -Id:() -Op:() -Attributes:() +``` + + + +## PARAMETERS + +### -Attributes +The graph attributes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +GraphOperation (UserGroup-Member) + +```yaml +Type: JumpCloud.SDK.V2.Models.IGraphOperationUserGroupMember +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +ObjectID of the User Group. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectID of graph object being added or removed as an association. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Op +How to modify the graph connection. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGraphOperationUserGroupMember + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GraphOperation (UserGroup-Member) + - `Id `: The ObjectID of graph object being added or removed as an association. + - `Op `: How to modify the graph connection. + - `[Attributes ]`: The graph attributes. + - `[(Any) ]`: This indicates any property can be added to this object. + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkWorkday.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkWorkday.md new file mode 100644 index 000000000..e44cfb5e4 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkWorkday.md @@ -0,0 +1,281 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkWorkday.md +schema: 2.0.0 +--- + +# Set-JcSdkWorkday + +## SYNOPSIS +This endpoint allows you to set the name and Custom Report URL for a Workday Instance. + +Currently, the name can not be changed from the default of `Workday Import`. + +##### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/workdays/{WorkdayID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ +\t\"reportUrl\":\"{Report_URL}\", +\t\"name\":\"{Name}\" +}\t' +``` + +## SYNTAX + +### SetExpanded (Default) +``` +Set-JcSdkWorkday -ConsoleHost -Id [-Name ] [-ReportUrl ] [-Confirm] + [-WhatIf] [] +``` + +### Set +``` +Set-JcSdkWorkday -ConsoleHost -Id -Body [-Confirm] [-WhatIf] + [] +``` + +### SetViaIdentity +``` +Set-JcSdkWorkday -ConsoleHost -InputObject -Body [-Confirm] + [-WhatIf] [] +``` + +### SetViaIdentityExpanded +``` +Set-JcSdkWorkday -ConsoleHost -InputObject [-Name ] + [-ReportUrl ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows you to set the name and Custom Report URL for a Workday Instance. + +Currently, the name can not be changed from the default of `Workday Import`. + +##### Sample Request +``` +curl -X PUT https://console.jumpcloud.com/api/v2/workdays/{WorkdayID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ +\t\"reportUrl\":\"{Report_URL}\", +\t\"name\":\"{Name}\" +}\t' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Set-JcSdkWorkday -Id:() -Body:() +``` + +---- ---------- +BasicExpiry String +BasicIsValid Boolean +BasicMessage String +Id String +LastImport String +Name String +OauthExpiry String +OauthIsValid Boolean +OauthMessage String +ReportUrl String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Set-JcSdkWorkday -Id:() -Name:() -ReportUrl:() +``` + +---- ---------- +BasicExpiry String +BasicIsValid Boolean +BasicMessage String +Id String +LastImport String +Name String +OauthExpiry String +OauthIsValid Boolean +OauthMessage String +ReportUrl String + +## PARAMETERS + +### -Body +Workday Fields + +```yaml +Type: JumpCloud.SDK.V2.Models.IWorkdayFields +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Set, SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SetViaIdentity, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportUrl +. + +```yaml +Type: System.String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.IWorkdayFields + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IWorkdayOutput + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: Workday Fields + - `[Name ]`: + - `[ReportUrl ]`: + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Stop-JcSdkAppleMdmDevice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Stop-JcSdkAppleMdmDevice.md new file mode 100644 index 000000000..36aee53d2 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Stop-JcSdkAppleMdmDevice.md @@ -0,0 +1,218 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Stop-JcSdkAppleMdmDevice.md +schema: 2.0.0 +--- + +# Stop-JcSdkAppleMdmDevice + +## SYNOPSIS +Shuts down a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/shutdown \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +## SYNTAX + +### Stop (Default) +``` +Stop-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId -DeviceId [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### StopViaIdentity +``` +Stop-JcSdkAppleMdmDevice -ConsoleHost -InputObject [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Shuts down a DEP-enrolled device. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/shutdown \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Stop-JcSdkAppleMdmDevice -AppleMdmId:() -DeviceId:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -AppleMdmId +. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Sync-JcSdkAppleMdmDevice.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Sync-JcSdkAppleMdmDevice.md new file mode 100644 index 000000000..aacde8cef --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Sync-JcSdkAppleMdmDevice.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Sync-JcSdkAppleMdmDevice.md +schema: 2.0.0 +--- + +# Sync-JcSdkAppleMdmDevice + +## SYNOPSIS +Refreshes the list of devices that a JumpCloud admin has added to their virtual MDM in Apple Business Manager - ABM so that they can be DEP enrolled with JumpCloud. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/refreshdepdevices \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +## SYNTAX + +### Sync (Default) +``` +Sync-JcSdkAppleMdmDevice -ConsoleHost -AppleMdmId [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### SyncViaIdentity +``` +Sync-JcSdkAppleMdmDevice -ConsoleHost -InputObject [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Refreshes the list of devices that a JumpCloud admin has added to their virtual MDM in Apple Business Manager - ABM so that they can be DEP enrolled with JumpCloud. + +#### Sample Request +``` + curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/refreshdepdevices \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Sync-JcSdkAppleMdmDevice -AppleMdmId:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -AppleMdmId +. + +```yaml +Type: System.String +Parameter Sets: Sync +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: SyncViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAppleMdmDeviceLockInformation.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAppleMdmDeviceLockInformation.md new file mode 100644 index 000000000..dba310017 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAppleMdmDeviceLockInformation.md @@ -0,0 +1,220 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAppleMdmDeviceLockInformation.md +schema: 2.0.0 +--- + +# Update-JcSdkAppleMdmDeviceLockInformation + +## SYNOPSIS +Refreshes the activation lock information for a device + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/refreshActivationLockInformation \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +## SYNTAX + +### Refresh (Default) +``` +Update-JcSdkAppleMdmDeviceLockInformation -ConsoleHost -AppleMdmId -DeviceId + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### RefreshViaIdentity +``` +Update-JcSdkAppleMdmDeviceLockInformation -ConsoleHost -InputObject + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Refreshes the activation lock information for a device + +#### Sample Request + +``` +curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/refreshActivationLockInformation \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Update-JcSdkAppleMdmDeviceLockInformation -AppleMdmId:() -DeviceId:() +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -AppleMdmId +. + +```yaml +Type: System.String +Parameter Sets: Refresh +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +. + +```yaml +Type: System.String +Parameter Sets: Refresh +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: RefreshViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAuthenticationPolicy.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAuthenticationPolicy.md new file mode 100644 index 000000000..858b2fbe8 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAuthenticationPolicy.md @@ -0,0 +1,626 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkAuthenticationPolicy.md +schema: 2.0.0 +--- + +# Update-JcSdkAuthenticationPolicy + +## SYNOPSIS +Patch the specified authentication policy. + +#### Sample Request +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ \"disabled\": false }' +``` + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-JcSdkAuthenticationPolicy -ConsoleHost -Id [-Conditions ] + [-CustomErrorMessage ] [-CustomErrorMessageEnabled] [-Description ] [-Disabled] + [-EffectAction ] [-MfaRequired] [-Name ] + [-ObligationMfaFactors ] [-PrimaryHelpText ] + [-PrimaryHelpUrl ] [-SecondaryHelpText ] [-SecondaryHelpUrl ] + [-TargetResources ] [-Type ] + [-UserAttributeExclusions ] + [-UserAttributeInclusions ] [-UserGroupExclusions ] + [-UserGroupInclusions ] [-UserInclusions ] [-UserVerificationRequirement ] + [-Confirm] [-WhatIf] [] +``` + +### Update +``` +Update-JcSdkAuthenticationPolicy -ConsoleHost -Id -Body [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentity +``` +Update-JcSdkAuthenticationPolicy -ConsoleHost -InputObject + -Body [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-JcSdkAuthenticationPolicy -ConsoleHost -InputObject + [-Conditions ] [-CustomErrorMessage ] [-CustomErrorMessageEnabled] [-Description ] + [-Disabled] [-EffectAction ] [-MfaRequired] [-Name ] + [-ObligationMfaFactors ] [-PrimaryHelpText ] + [-PrimaryHelpUrl ] [-SecondaryHelpText ] [-SecondaryHelpUrl ] + [-TargetResources ] [-Type ] + [-UserAttributeExclusions ] + [-UserAttributeInclusions ] [-UserGroupExclusions ] + [-UserGroupInclusions ] [-UserInclusions ] [-UserVerificationRequirement ] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Patch the specified authentication policy. + +#### Sample Request +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/authn/policies/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ \"disabled\": false }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Update-JcSdkAuthenticationPolicy -Id:() -Body:() +``` + +---- ---------- +Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions +Description String +Disabled Boolean +EffectAction String +Id String +MfaRequired Boolean +Name String +TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] +Type String +UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserGroupExclusions String +UserGroupInclusions String +UserInclusions String +UserVerificationRequirement String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Update-JcSdkAuthenticationPolicy -Id:() -Conditions:() -Description:() -Disabled:() -EffectAction:() -MfaRequired:() -Name:() -TargetResources:() -Type:() -UserAttributeExclusions:() -UserAttributeInclusions:() -UserGroupExclusions:() -UserGroupInclusions:() -UserInclusions:() -UserVerificationRequirement:() +``` + +---- ---------- +Conditions JumpCloud.SDK.V2.Models.AuthnPolicyConditions +Description String +Disabled Boolean +EffectAction String +Id String +MfaRequired Boolean +Name String +TargetResources JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget[] +Type String +UserAttributeExclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserAttributeInclusions JumpCloud.SDK.V2.Models.AuthnPolicyUserAttributeFilter[] +UserGroupExclusions String +UserGroupInclusions String +UserInclusions String +UserVerificationRequirement String + +## PARAMETERS + +### -Body +This represents an authentication policy. +See the details of each field for valid values and restrictions. + +```yaml +Type: JumpCloud.SDK.V2.Models.IAuthnPolicy +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Conditions +Dictionary of \ + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomErrorMessage +The custom error message to be displayed when the policy is applied. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomErrorMessageEnabled +Indicates whether the custom error message is enabled or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EffectAction +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Unique identifier of the authentication policy + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MfaRequired +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObligationMfaFactors +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IAuthnPolicyObligationsMfaFactorsItem[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryHelpText +The text to be displayed for the help link. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryHelpUrl +The URL to be opened when the help link is clicked. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryHelpText +The text to be displayed for the help link. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryHelpUrl +The URL to be opened when the help link is clicked. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResources +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IAuthnPolicyResourceTarget[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +AuthnPolicyType + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAttributeExclusions +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IAuthnPolicyUserAttributeFilter[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAttributeInclusions +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IAuthnPolicyUserAttributeFilter[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserGroupExclusions +. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserGroupInclusions +. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInclusions +. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserVerificationRequirement +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IAuthnPolicy + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IAuthnPolicy + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: This represents an authentication policy. See the details of each field for valid values and restrictions. + - `[Conditions ]`: Dictionary of + - `[(Any) ]`: This indicates any property can be added to this object. + - `[CustomErrorMessage ]`: The custom error message to be displayed when the policy is applied. + - `[CustomErrorMessageEnabled ]`: Indicates whether the custom error message is enabled or not. + - `[Description ]`: + - `[Disabled ]`: + - `[EffectAction ]`: + - `[MfaRequired ]`: + - `[Name ]`: + - `[ObligationMfaFactors >]`: + - `[Type ]`: + - `[PrimaryHelpText ]`: The text to be displayed for the help link. + - `[PrimaryHelpUrl ]`: The URL to be opened when the help link is clicked. + - `[SecondaryHelpText ]`: The text to be displayed for the help link. + - `[SecondaryHelpUrl ]`: The URL to be opened when the help link is clicked. + - `[TargetResources >]`: + - `Type `: + - `[Id ]`: Object ID of the resource target. If undefined, then all resources of the given type are targeted. + - `[Type ]`: AuthnPolicyType + - `[UserAttributeExclusions >]`: + - `[Field ]`: The only field that is currently supported is ldap_binding_user + - `[Operator ]`: + - `[Value ]`: Can be any value - string, number, boolean, array or object. + - `[UserAttributeInclusions >]`: + - `[UserGroupExclusions >]`: + - `[UserGroupInclusions >]`: + - `[UserInclusions >]`: + - `[UserVerificationRequirement ]`: + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +`OBLIGATIONMFAFACTORS `: . + - `[Type ]`: + +`TARGETRESOURCES `: . + - `Type `: + - `[Id ]`: Object ID of the resource target. If undefined, then all resources of the given type are targeted. + +`USERATTRIBUTEEXCLUSIONS `: . + - `[Field ]`: The only field that is currently supported is ldap_binding_user + - `[Operator ]`: + - `[Value ]`: Can be any value - string, number, boolean, array or object. + +`USERATTRIBUTEINCLUSIONS `: . + - `[Field ]`: The only field that is currently supported is ldap_binding_user + - `[Operator ]`: + - `[Value ]`: Can be any value - string, number, boolean, array or object. + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkBulkUser.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkBulkUser.md new file mode 100644 index 000000000..ad3c88679 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkBulkUser.md @@ -0,0 +1,268 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkBulkUser.md +schema: 2.0.0 +--- + +# Update-JcSdkBulkUser + +## SYNOPSIS +The endpoint allows you to update a bulk job to asynchronously update users. +See [update a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_put) for full list of attributes. + +#### Sample Request +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '[ +\t{ +\t \"id\":\"5be9fb4ddb01290001e85109\", +\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", +\t\t\"department\":\"{UPDATED_DEPARTMENT}\", +\t\t\"attributes\":[ +\t\t\t{\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} +\t\t] +\t}, +\t{ +\t \"id\":\"5be9fb4ddb01290001e85109\", +\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", +\t\t\"costCenter\":\"{UPDATED_COST_CENTER}\", +\t\t\"phoneNumbers\":[ +\t\t\t{\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, +\t\t\t{\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} +\t\t] +\t} +] +``` + +## SYNTAX + +``` +Update-JcSdkBulkUser -ConsoleHost -Body > [-SuppressEmail] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +The endpoint allows you to update a bulk job to asynchronously update users. +See [update a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_put) for full list of attributes. + +#### Sample Request +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '[ +\t{ +\t \"id\":\"5be9fb4ddb01290001e85109\", +\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", +\t\t\"department\":\"{UPDATED_DEPARTMENT}\", +\t\t\"attributes\":[ +\t\t\t{\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} +\t\t] +\t}, +\t{ +\t \"id\":\"5be9fb4ddb01290001e85109\", +\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", +\t\t\"costCenter\":\"{UPDATED_COST_CENTER}\", +\t\t\"phoneNumbers\":[ +\t\t\t{\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, +\t\t\t{\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} +\t\t] +\t} +] +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Update-JcSdkBulkUser +``` + + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +{{ Add code here }} +``` + +{{ Add output here }} + +## PARAMETERS + +### -Body +Array of bulk-user-update + +```yaml +Type: System.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserUpdate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuppressEmail +An option indicating whether to suppress the job results email that will +otherwise be sent to the Administrator who created the job. +If true, the +email won't be sent. +If omitted or false, the email will be sent. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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.Collections.Generic.List`1[[JumpCloud.SDK.V2.Models.IBulkUserUpdate, JumpCloud.SDK.V2.private, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IJobIdResult + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY >`: Array of bulk-user-update + - `[AccountLocked ]`: + - `[Addresses >]`: type, poBox, extendedAddress, streetAddress, locality, region, postalCode, country + - `[Country ]`: + - `[ExtendedAddress ]`: + - `[Locality ]`: + - `[PoBox ]`: + - `[PostalCode ]`: + - `[Region ]`: + - `[StreetAddress ]`: + - `[Type ]`: + - `[AllowPublicKey ]`: + - `[AlternateEmail ]`: + - `[Attributes >]`: + - `[Name ]`: + - `[Value ]`: + - `[Company ]`: + - `[CostCenter ]`: + - `[DelegatedAuthorityId ]`: ObjectId of the target Active Directory connection + - `[DelegatedAuthorityName ]`: Authority name + - `[Department ]`: + - `[Description ]`: + - `[DisableDeviceMaxLoginAttempts ]`: + - `[Displayname ]`: + - `[Email ]`: + - `[EmployeeIdentifier ]`: Must be unique per user. + - `[EmployeeType ]`: + - `[EnableManagedUid ]`: + - `[EnableUserPortalMultifactor ]`: + - `[ExternalDn ]`: + - `[ExternalPasswordExpirationDate ]`: + - `[ExternalSourceType ]`: + - `[ExternallyManaged ]`: + - `[Firstname ]`: + - `[Id ]`: Object ID of the user being updated + - `[JobTitle ]`: + - `[Lastname ]`: + - `[LdapBindingUser ]`: + - `[Location ]`: + - `[ManagedAppleId ]`: + - `[Manager ]`: Relation with another systemuser to identify the last as a manager. + - `[MfaConfigured ]`: + - `[MfaExclusion ]`: + - `[MfaExclusionDays ]`: + - `[MfaExclusionUntil ]`: + - `[Middlename ]`: + - `[Organization ]`: Organization object id of the user + - `[Password ]`: + - `[PasswordNeverExpires ]`: + - `[PasswordlessSudo ]`: + - `[PhoneNumbers >]`: + - `[Number ]`: + - `[Type ]`: + - `[PublicKey ]`: + - `[Relationships >]`: + - `[Type ]`: + - `[Value ]`: + - `[RestrictedField ]`: + - `[RestrictedFieldId ]`: + - `[RestrictedFieldType ]`: + - `[SambaServiceUser ]`: + - `[SshKeys >]`: + - `Name `: The name of the SSH key. + - `PublicKey `: The Public SSH key. + - `[State ]`: + - `[Sudo ]`: + - `[Suspended ]`: + - `[UnixGuid ]`: + - `[UnixUid ]`: + - `[Username ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkGSuite.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkGSuite.md new file mode 100644 index 000000000..cb67d614d --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkGSuite.md @@ -0,0 +1,407 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkGSuite.md +schema: 2.0.0 +--- + +# Update-JcSdkGSuite + +## SYNOPSIS +This endpoint allows updating some attributes of a G Suite. + +##### Sample Request + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"userLockoutAction\": \"suspend\", + \"userPasswordExpirationAction\": \"maintain\" + }' +``` +Sample Request, set a default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": { + \"id\": \"{domainObjectID}\" + } + }' +``` + +Sample Request, unset the default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": {} + }' +``` + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-JcSdkGSuite -ConsoleHost -Id [-DefaultDomainId ] [-GroupsEnabled] + [-ImportFilter ] [-Name ] [-OrganizationObjectIdInputFile ] + [-UserLockoutAction ] [-UserPasswordExpirationAction ] [-Confirm] [-WhatIf] + [] +``` + +### Update +``` +Update-JcSdkGSuite -ConsoleHost -Id -Body [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentity +``` +Update-JcSdkGSuite -ConsoleHost -InputObject -Body [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-JcSdkGSuite -ConsoleHost -InputObject [-DefaultDomainId ] + [-GroupsEnabled] [-ImportFilter ] [-Name ] [-OrganizationObjectIdInputFile ] + [-UserLockoutAction ] [-UserPasswordExpirationAction ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint allows updating some attributes of a G Suite. + +##### Sample Request + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"userLockoutAction\": \"suspend\", + \"userPasswordExpirationAction\": \"maintain\" + }' +``` +Sample Request, set a default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": { + \"id\": \"{domainObjectID}\" + } + }' +``` + +Sample Request, unset the default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": {} + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Update-JcSdkGSuite -Id:() -Body:() +``` + +---- ---------- +DefaultDomainDomain String +DefaultDomainId String +GroupsEnabled Boolean +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Update-JcSdkGSuite -Id:() -DefaultDomainId:() -GroupsEnabled:() -Name:() -UserLockoutAction:() -UserPasswordExpirationAction:() +``` + +---- ---------- +DefaultDomainDomain String +DefaultDomainId String +GroupsEnabled Boolean +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + +## PARAMETERS + +### -Body +GSuite + +```yaml +Type: JumpCloud.SDK.V2.Models.IGsuite +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultDomainId +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupsEnabled +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Unique identifier of the GSuite. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImportFilter +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationObjectIdInputFile +Input File for OrganizationObjectId (OrganizationObjectId is the object id of the organization that the account belongs to.) + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserLockoutAction +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPasswordExpirationAction +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IGsuite + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IGsuite + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: GSuite + - `[DefaultDomainId ]`: + - `[GroupsEnabled ]`: + - `[ImportFilter ]`: + - `[Name ]`: + - `[OrganizationObjectId ]`: OrganizationObjectId is the object id of the organization that the account belongs to. + - `[UserLockoutAction ]`: + - `[UserPasswordExpirationAction ]`: + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkIPList.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkIPList.md new file mode 100644 index 000000000..fb4f724b2 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkIPList.md @@ -0,0 +1,275 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkIPList.md +schema: 2.0.0 +--- + +# Update-JcSdkIPList + +## SYNOPSIS +Update a specific IP list. + +#### Sample Request +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{\"name\": \"New IP List Name\"}' +``` + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-JcSdkIPList -ConsoleHost -Id [-Description ] [-Ips ] + [-Name ] [-Confirm] [-WhatIf] [] +``` + +### Update +``` +Update-JcSdkIPList -ConsoleHost -Id -Body [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentity +``` +Update-JcSdkIPList -ConsoleHost -InputObject -Body + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-JcSdkIPList -ConsoleHost -InputObject [-Description ] + [-Ips ] [-Name ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update a specific IP list. + +#### Sample Request +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/iplists/{id} \\ + -H 'accept: application/json' \\ + -H 'content-type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{\"name\": \"New IP List Name\"}' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Update-JcSdkIPList -Id:() -Body:() +``` + +---- ---------- +Description String +Id String +Ips String +Name String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Update-JcSdkIPList -Id:() -Description:() -Ips:() -Name:() +``` + +---- ---------- +Description String +Id String +Ips String +Name String + +## PARAMETERS + +### -Body +IPListRequest + +```yaml +Type: JumpCloud.SDK.V2.Models.IIPListRequest +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Ips +. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IIPListRequest + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IIPList + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: IPListRequest + - `[Description ]`: + - `[Ips >]`: + - `[Name ]`: + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkLdapServer.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkLdapServer.md new file mode 100644 index 000000000..38ced44d6 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkLdapServer.md @@ -0,0 +1,286 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkLdapServer.md +schema: 2.0.0 +--- + +# Update-JcSdkLdapServer + +## SYNOPSIS +This endpoint allows updating some attributes of an LDAP server. + +Sample Request + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"userLockoutAction\": \"remove\", + \"userPasswordExpirationAction\": \"disable\" + }' +``` + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-JcSdkLdapServer -ConsoleHost -Id [-Id1 ] [-UserLockoutAction ] + [-UserPasswordExpirationAction ] [-Confirm] [-WhatIf] [] +``` + +### Update +``` +Update-JcSdkLdapServer -ConsoleHost -Id + -Body [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentity +``` +Update-JcSdkLdapServer -ConsoleHost -InputObject + -Body [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-JcSdkLdapServer -ConsoleHost -InputObject [-Id ] + [-UserLockoutAction ] [-UserPasswordExpirationAction ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +This endpoint allows updating some attributes of an LDAP server. + +Sample Request + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"userLockoutAction\": \"remove\", + \"userPasswordExpirationAction\": \"disable\" + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Update-JcSdkLdapServer -Id:() -Body:() +``` + +---- ---------- +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Update-JcSdkLdapServer -Id:() -Id1:() -UserLockoutAction:() -UserPasswordExpirationAction:() +``` + +---- ---------- +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + +## PARAMETERS + +### -Body +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IPaths1Ka5IlhLdapserversIdPatchRequestbodyContentApplicationJsonSchema +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Unique identifier of the LDAP server. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id1 +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -UserLockoutAction +LDAP Server Action + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPasswordExpirationAction +LDAP Server Action + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.IPaths1Ka5IlhLdapserversIdPatchRequestbodyContentApplicationJsonSchema + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPaths1Dvt4UsLdapserversIdPatchResponses200ContentApplicationJsonSchema + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: . + - `[Id ]`: + - `[UserLockoutAction ]`: LDAP Server Action + - `[UserPasswordExpirationAction ]`: LDAP Server Action + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkOffice365.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkOffice365.md new file mode 100644 index 000000000..f94e37859 --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkOffice365.md @@ -0,0 +1,379 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkOffice365.md +schema: 2.0.0 +--- + +# Update-JcSdkOffice365 + +## SYNOPSIS +This endpoint allows updating some attributes of an Office 365 instance. + +##### + +Sample Request + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"userLockoutAction\": \"maintain\", + \"userPasswordExpirationAction\": \"suspend\", + }' +``` + +Sample Request, set a default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": { + \"id\": \"{domainObjectID}\" + } + }' +``` + +Sample Request, unset the default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": {} + }' +``` + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-JcSdkOffice365 -ConsoleHost -Office365Id [-DefaultDomainId ] [-GroupsEnabled] + [-Name ] [-UserLockoutAction ] [-UserPasswordExpirationAction ] [-Confirm] [-WhatIf] + [] +``` + +### Update +``` +Update-JcSdkOffice365 -ConsoleHost -Office365Id -Body [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentity +``` +Update-JcSdkOffice365 -ConsoleHost -InputObject -Body [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-JcSdkOffice365 -ConsoleHost -InputObject [-DefaultDomainId ] + [-GroupsEnabled] [-Name ] [-UserLockoutAction ] [-UserPasswordExpirationAction ] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint allows updating some attributes of an Office 365 instance. + +##### + +Sample Request + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"userLockoutAction\": \"maintain\", + \"userPasswordExpirationAction\": \"suspend\", + }' +``` + +Sample Request, set a default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": { + \"id\": \"{domainObjectID}\" + } + }' +``` + +Sample Request, unset the default domain + +``` +curl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\ + -H 'Accept: application/json' \\ + -H 'Content-Type: application/json' \\ + -H 'x-api-key: {API_KEY}' \\ + -d '{ + \"defaultDomain\": {} + }' +``` + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Update-JcSdkOffice365 -Office365Id:() -Body:() +``` + +---- ---------- +DefaultDomainDomain String +DefaultDomainId String +GroupsEnabled Boolean +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Update-JcSdkOffice365 -Office365Id:() -DefaultDomainId:() -GroupsEnabled:() -Name:() -UserLockoutAction:() -UserPasswordExpirationAction:() +``` + +---- ---------- +DefaultDomainDomain String +DefaultDomainId String +GroupsEnabled Boolean +Id String +Name String +UserLockoutAction String +UserPasswordExpirationAction String + +## PARAMETERS + +### -Body +Office 365 + +```yaml +Type: JumpCloud.SDK.V2.Models.IOffice365 +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultDomainId +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupsEnabled +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Office365Id +ObjectID of the Office 365 instance. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserLockoutAction +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPasswordExpirationAction +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.IOffice365 + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IOffice365 + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: Office 365 + - `[DefaultDomainId ]`: + - `[GroupsEnabled ]`: + - `[Name ]`: + - `[UserLockoutAction ]`: + - `[UserPasswordExpirationAction ]`: + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkUserPushEndpoint.md b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkUserPushEndpoint.md new file mode 100644 index 000000000..59c4c397e --- /dev/null +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkUserPushEndpoint.md @@ -0,0 +1,272 @@ +--- +external help file: +Module Name: JumpCloud.SDK.V2 +online version: https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkUserPushEndpoint.md +schema: 2.0.0 +--- + +# Update-JcSdkUserPushEndpoint + +## SYNOPSIS +This endpoint will update a push endpoint associated with a user. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-JcSdkUserPushEndpoint -ConsoleHost -PushEndpointId -UserId [-Name ] + [-State ] [-Confirm] [-WhatIf] [] +``` + +### Update +``` +Update-JcSdkUserPushEndpoint -ConsoleHost -PushEndpointId -UserId + -Body + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentity +``` +Update-JcSdkUserPushEndpoint -ConsoleHost -InputObject + -Body + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-JcSdkUserPushEndpoint -ConsoleHost -InputObject [-Name ] + [-State ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +This endpoint will update a push endpoint associated with a user. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Update-JcSdkUserPushEndpoint -PushEndpointId:() -UserId:() -Body:() +``` + +---- ---------- +DeviceAppVersion String +DeviceMake String +DeviceModel String +DeviceOS String +DeviceOSVersion String +DeviceUvEnabled Boolean +EnrollmentDate Datetime +Id String +LastUsedDate Datetime +Name String +State String + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Update-JcSdkUserPushEndpoint -PushEndpointId:() -UserId:() -Name:() -State:() +``` + +---- ---------- +DeviceAppVersion String +DeviceMake String +DeviceModel String +DeviceOS String +DeviceOSVersion String +DeviceUvEnabled Boolean +EnrollmentDate Datetime +Id String +LastUsedDate Datetime +Name String +State String + +## PARAMETERS + +### -Body +. + +```yaml +Type: JumpCloud.SDK.V2.Models.IPathsO4Si39UsersUserIdPushendpointsPushEndpointIdPatchRequestbodyContentApplicationJsonSchema +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsoleHost +Region for JumpCloud API host. +Use 'console' for US or 'console.eu' for EU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PushEndpointId +. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity + +### JumpCloud.SDK.V2.Models.IPathsO4Si39UsersUserIdPushendpointsPushEndpointIdPatchRequestbodyContentApplicationJsonSchema + +## OUTPUTS + +### JumpCloud.SDK.V2.Models.IPushEndpointResponse + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`BODY `: . + - `[Name ]`: + - `[State ]`: + +`INPUTOBJECT `: Identity Parameter + - `[AccountId ]`: + - `[ActivedirectoryId ]`: + - `[AdministratorId ]`: + - `[AgentId ]`: + - `[AppleMdmId ]`: + - `[ApplicationId ]`: ObjectID of the Application. + - `[ApprovalFlowId ]`: + - `[CommandId ]`: ObjectID of the Command. + - `[CustomEmailType ]`: + - `[DeviceId ]`: + - `[GroupId ]`: ObjectID of the Policy Group. + - `[GsuiteId ]`: ObjectID of the G Suite instance. + - `[Id ]`: ObjectID of this Active Directory instance. + - `[JobId ]`: + - `[LdapserverId ]`: ObjectID of the LDAP Server. + - `[Office365Id ]`: ObjectID of the Office 365 instance. + - `[PolicyId ]`: ObjectID of the Policy. + - `[ProviderId ]`: + - `[PushEndpointId ]`: + - `[RadiusserverId ]`: ObjectID of the Radius Server. + - `[SoftwareAppId ]`: ObjectID of the Software App. + - `[SystemId ]`: ObjectID of the System. + - `[UserId ]`: ObjectID of the User. + - `[WorkdayId ]`: + +## RELATED LINKS + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/test-module.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/test-module.ps1 index 297542d04..0ff3e247b 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/test-module.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/test-module.ps1 @@ -30,7 +30,7 @@ $requireResourceModule = (($baseName -ne "Resources") -and ($Record.IsPresent -o if ($requireResourceModule) { # Load the latest Az.Accounts installed - Import-Module -Name Az.Accounts -RequiredVersion (Get-Module -Name Az.Accounts -ListAvailable | Sort-Object -Property Version -Descending)[0].Version + # Import-Module -Name Az.Accounts -RequiredVersion (Get-Module -Name Az.Accounts -ListAvailable | Sort-Object -Property Version -Descending)[0].Version $resourceModulePSD = Get-Item -Path (Join-Path $HOME '.PSSharedModules\Resources\Az.Resources.TestSupport.psd1') Import-Module -Name $resourceModulePSD.FullName } @@ -68,12 +68,491 @@ try $env:AzPSAutorestTestPlaybackMode = $true } $testFolder = Join-Path $PSScriptRoot 'test' - if ($null -ne $TestName) - { - Invoke-Pester -Script @{ Path = $testFolder } -TestName $TestName -ExcludeTag $ExcludeTag -EnableExit -OutputFile (Join-Path $testFolder "$moduleName-TestResults.xml") - } else { - Invoke-Pester -Script @{ Path = $testFolder } -ExcludeTag $ExcludeTag -EnableExit -OutputFile (Join-Path $testFolder "$moduleName-TestResults.xml") - } +<# +(Get-Command -Name New-JcSdkPolicy) | ForEach-Object { + $ParameterName = $_.Name + $_.ParameterSets | ForEach-Object { + $Parameters = ($_.Parameters | Sort-Object @{e = 'IsMandatory'; desc = $true }, @{e = 'Name'; desc = $false } | ForEach-Object { + if ($_.Name -notin ('Fields', 'Filter', 'Sort', 'Search', 'Paginate', 'Break', 'HttpPipelineAppend', 'HttpPipelinePrepend', 'PassThru', 'Proxy', 'ProxyCredential', 'ProxyUseDefaultCredentials', 'CommonParameters', 'WhatIf', 'Confirm', 'Verbose', 'Debug', 'ErrorAction', 'WarningAction', 'InformationAction', 'ErrorVariable', 'WarningVariable', 'InformationVariable', 'OutVariable', 'OutBuffer', 'PipelineVariable')) + { + $ParameterType = If ($_.ParameterType.Name -eq 'switchparameter') { '' }Else { " <$($_.ParameterType.Name.ToLower())>" } + If ($_.IsMandatory) + { + "-$($_.Name)$($ParameterType)" + } + else + { + "[-$($_.Name)$($ParameterType)]" + } + } + } + ) -join ' ' + Write-Host ("`n$($_.Name): $($ParameterName) $($Parameters)") + } +} +TODO: + Clear-JcSdkSystem.Tests.ps1: Setup Orgs with a device that can be cleared each time + Lock-JcSdkSystem.Tests.ps1: Setup Orgs with a device that can be locked each time + Restart-JcSdkSystem.Tests.ps1: Setup Orgs with a device that can be restarted each time + Remove-JcSdkSystem.Tests.ps1: Disabled untill we can also create systems + Reset-JcSdkUserMfa.Tests.ps1: Configure MFA for $global:PesterTestUser + New-JcSdkDuoApplication.Tests.ps1: Set up DUO in Pester Orgs +#> +$testFolder = $testFolder # .\jcapi-powershell\SDKs\PowerShell\JumpCloud.SDK.V1\test +$moduleName = $moduleName # JumpCloud.SDK.V1 + +#region Import Modules +If ($moduleName -eq 'JumpCloud.SDK.V2') +{ + Import-Module -Name $modulePath.Replace('JumpCloud.SDK.V2', 'JumpCloud.SDK.V1') -Force +} +#endregion Import Modules +#region Define Objects +If ($moduleName -eq 'JumpCloud.SDK.V1' -or $moduleName -eq 'JumpCloud.SDK.V2' -and "MTP" -notin $Env:IncludeTagList) +{ + # Get a ApplicationTemplate + $global:PesterTestApplicationTemplate = Get-JcSdkApplicationTemplate | Select-Object -First 1 + # Get a CommandResult + $global:PesterTestCommandResult = Get-JcSdkCommandResult | Select-Object -First 1 + # Get Organization + $global:PesterTestOrganization = Get-JcSdkOrganization + # Get a System + $global:PesterTestSystem = Get-JcSdkSystem | Select-Object -First 1 + # # Create a Application + $global:PesterDefApplicationConfig = [JumpCloud.SDK.V1.Models.IApplicationConfig]@{} + $randomBookmarkName = "Bookmark$(Get-Random -Maximum 999 -Minimum 100)" + $global:PesterDefApplication = @{ + Name = 'bookmark' + ssoUrl = "https://JumpCloud$(Get-Random -Maximum 999 -Minimum 100).com" + config = $global:PesterDefApplicationConfig + DisplayName = $randomBookmarkName + DisplayLabel = $randomBookmarkName + } + # Post a command file (README.md from SDK directory) + $headers = @{} + $headers.Add("x-api-key", $env:JCApiKey) + $body = @{ + content = "./README.md" + name = "README.md" + destination = "/tmp/README.md" + } + # Upload file to ORG and create reusable global object of that File + $global:PesterDefCommandFile = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/files' -Method POST -Headers $headers -Body $body + # Declare a Command definition + $global:PesterDefCommandName = "PesterTestCommand$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + $global:PesterDefCommand = @{ + Name = $global:PesterDefCommandName + Command = 'echo "Hello World"' + User = "000000000000000000000000" + launchType = "trigger" + trigger = $global:PesterDefCommandName + commandType = "linux" + files = $global:PesterDefCommandFile._id + } + # Create a command, assign it to systems, and run it + $NewCommand = New-JcSdkCommand @global:PesterDefCommand + $global:PesterTestCommand = Get-JcSdkCommand | Where-Object { $_.Name -eq $NewCommand.Name } | Select-Object -First 1 + # Using Requests, assign the command to the system / Splatting the command object with system does not work perhaps it's been deprecated in favor of associations? + # This Association is set to run one instance of the command on a system + # It is removed in order for the Set-JcSdkCommandAssociation tests to work as expected + $CommandAssociaion = Get-JcSdkSystem | Where-Object { $_.osfamily -eq 'linux' } | Select-Object -ExpandProperty Id + $headers = @{ + "x-api-key" = $env:JCApiKey + "content-type" = "application/json" + } + $body = @{ + id = $CommandAssociaion + op = "add" + type = "system" + } | ConvertTo-Json + $response = Invoke-RestMethod -Uri "https://console.jumpcloud.com/api/v2/commands/$($global:PesterTestCommand.Id)/associations" -Method POST -Headers $headers -Body $body + # Invoke SDK Command Trigger to generate Command Results + Invoke-JcSdkCommandTrigger -Triggername $global:PesterTestCommand.trigger + # Remove the Command Associations to continue tests as normal + $body = @{ + id = $CommandAssociaion + op = "remove" + type = "system" + } | ConvertTo-Json + $response = Invoke-RestMethod -Uri "https://console.jumpcloud.com/api/v2/commands/$($global:PesterTestCommand.Id)/associations" -Method POST -Headers $headers -Body $body + # Create a User + $global:PesterDefUser = @{ + Username = "pester.test.$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + FirstName = "Pester" + LastName = "Test" + Password = "Testing123!" + Email = "pester.test@example$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ })).com" + } + # Create a User SSH Key + $global:PesterDefUserSshKey = @{ + Id = $null # Defined later in New-JcSdkUserSshKey.Tests.ps1 + Name = "PesterTestUserSshKeyName" + PublicKey = "PesterTestUserSshKeyPublicKey" + } + # Create a RADIUS Server + $global:PesterDefRadiusServer = @{ + Name = "PesterTestRadiusServer-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + SharedSecret = "Testing123!" + NetworkSourceIP = [IPAddress]::Parse([String](Get-Random)).IPAddressToString + } +} +If ($moduleName -eq 'JumpCloud.SDK.V2' -and "MTP" -notin $Env:IncludeTagList) +{ + # Get the Apple MDM + $global:PesterTestAppleMDM = Get-JcSdkAppleMdm | Select-Object -First 1 + # Get LDAP Server + $global:PesterTestLdapServer = Get-JcSdkLdapServer | Select-Object -First 1 + # Get all Directories + $global:PesterTestDirectories = Get-JcSdkDirectory + $global:PesterTestGSuite = $global:PesterTestDirectories | Where-Object { $_.type -eq "g_suite" } | Select-Object -First 1 + $global:PesterTestOffice365 = $global:PesterTestDirectories | Where-Object { $_.type -eq "office_365" } | Select-Object -First 1 + $global:PesterTestLdap = $global:PesterTestDirectories | Where-Object { $_.type -eq "ldap_server" } | Select-Object -First 1 + # Get a Policy Template + $global:PesterTestPolicyTemplate = Get-JcSdkPolicyTemplate | Select-Object -First 1 + # Create an ActiveDirectory + $global:PesterDefActiveDirectory = [JumpCloud.SDK.V2.Models.ActiveDirectory]@{ + 'domain' = "DC=ADTEST{0};DC=ORG" -f [string]( -join ((65..90) + (97..122) | Get-Random -Count 6 | ForEach-Object { [char]$_ })); + } + # Create a Authentication Policy + $global:PesterDefAuthenticationPolicy = [JumpCloud.SDK.V2.Models.AuthnPolicy]@{ + Name = "AuthenticationPolicy-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + EffectAction = 'allow' + TargetResources = [JumpCloud.SDK.V2.Models.AuthnPolicyResourceTarget]@{"type" = "user_portal" } + Type = 'user_portal' + UserGroupInclusions = $null # Defined later in New-JcSdkAuthenticationPolicy.Tests.ps1 + } + + # Create a Bulk User Configuration: + $global:pesterDefBulkUsername = "PesterBulkUser-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + $global:PesterDefBulkUser = [JumpCloud.SDK.V2.Models.BulkUserCreate]@{ + Email = "$($global:pesterDefBulkUsername)@example$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ })).com"; + Firstname = $global:pesterDefBulkUsername; + Lastname = $global:pesterDefBulkUsername; + Username = $global:pesterDefBulkUsername; + AccountLocked = $false + Activated = $true + Addresses = @( + @{ + streetAddress = "8080 Testing Ave" + type = "home" + poBox = "202" + locality = "Boulder" + region = "CO" + postalCode = "80301" + country = "US" + } + ) + AllowPublicKey = $true + #AlternateEmail = 'bulkUser11234@alderaan2.org' + Company = 'someCompany' + CostCenter = 'something' + Department = 'something' + Description = 'some description' + DisableDeviceMaxLoginAttempts = $false + Displayname = 'display' + EmployeeIdentifier = (Get-Random -min 10000000 -max 99999999) + EmployeeType = 'bulk' + EnableManagedUid = $false + EnableUserPortalMultifactor = $true + ExternallyManaged = $false + JobTitle = 'bulk' + LdapBindingUser = $false + Location = 'Singapore' + ManagedAppleId = 'bulkUser11234@alderaan2.org' + Manager = $(Get-JCSdkUser | Select-Object -First 1).Id + #MfaExclusion = $true + #MfaExclusionDays = ((Get-Date).AddDays(+7)) + Password = 'T#st1234' + PasswordNeverExpires = $false + PasswordlessSudo = $false + PhoneNumbers = @( + @{ + number = "1112223333" + type = "home" + } + @{ + number = "2221113333" + type = "mobile" + } + ) + #State = "SUSPENDED" + } + $global:pesterDefBulkUpdateUsername = "PesterBulkUser-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + $BulkUserUpdateUser = New-JCSdkUser -Email "$($global:pesterDefBulkUpdateUsername)@example$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ })).com" -Username $global:pesterDefBulkUpdateUsername -Firstname "BulkUserUpdate" -LastName "BulkUserUpdate" + $global:PesterDefUpdateBulkUser = [JumpCloud.SDK.V2.Models.BulkUserUpdate]@{ + Id = $BulkUserUpdateUser.Id + Email = "$($global:pesterDefBulkUpdateUsername)@example$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ })).com"; + Firstname = $global:pesterDefBulkUpdateUsername; ; + Lastname = $global:pesterDefBulkUpdateUsername; ; + Username = $global:pesterDefBulkUpdateUsername; ; + AccountLocked = $false + Addresses = @( + @{ + streetAddress = "8080 Testing Ave" + type = "home" + poBox = "202" + locality = "Boulder" + region = "CO" + postalCode = "80301" + country = "US" + } + ) + AllowPublicKey = $true + #AlternateEmail = 'bulkUser11234@alderaan2.org' + Company = 'someCompany' + CostCenter = 'something' + Department = 'something' + Description = 'some description' + DisableDeviceMaxLoginAttempts = $false + Displayname = 'display' + EmployeeIdentifier = (Get-Random -min 10000000 -max 99999999) + EmployeeType = 'bulk' + EnableManagedUid = $false + EnableUserPortalMultifactor = $true + ExternallyManaged = $false + JobTitle = 'bulk' + LdapBindingUser = $false + Location = 'Singapore' + ManagedAppleId = 'bulkUser11234@alderaan2.org' + Manager = $(Get-JCSdkUser | Select-Object -First 1).Id + #MfaExclusion = $true + #MfaExclusionUntil = ((Get-Date).AddDays(+7)) + Password = 'T#st1234' + PasswordNeverExpires = $false + PasswordlessSudo = $false + PhoneNumbers = @( + @{ + number = "1112223333" + type = "home" + } + @{ + number = "2221113333" + type = "mobile" + } + ) + #State = "SUSPENDED" + } + # Create a Custom Email Configuration + $global:PesterDefCustomEmailConfiguration = [JumpCloud.SDK.V2.Models.CustomEmail]@{ + Type = 'password_reset_confirmation' + # Having multiple breaks remove tests + # Type = Get-Random @('password_reset_confirmation', 'password_expiration_warning', 'lockout_notice_user', 'password_expiration', 'user_change_password') + Subject = "CUSTOM" + } + # Create a GSuite Translation Rule + $global:PesterDefGSuiteTranslationRule = [JumpCloud.SDK.V2.Models.GSuiteTranslationRule]@{ + GsuiteId = $global:PesterTestGSuite.Id + BuiltIn = 'user_work_addresses' + Direction = 'export' + } + # Create a IP List + $global:PesterDefIPList = [JumpCloud.SDK.V2.Models.IPList]@{ + Description = 'PesterIpList' + Ips = [IPAddress]::Parse([String](Get-Random)).IPAddressToString + Name = "Pester IP Test List $(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + } + # Create a LdapServer + $global:PesterDefLdapServer = @{ + Id = $PesterTestLdapServer.Id + Name = "jumpcloud" + UserLockoutAction = "remove" + UserPasswordExpirationAction = "remove" + } + # Create a Office365 Translation Rule + $global:PesterDefOffice365TranslationRule = [JumpCloud.SDK.V2.Models.Office365TranslationRule]@{ + Office365Id = $global:PesterTestOffice365.Id + BuiltIn = 'user_street_address' + } + # Create a Policy + $global:PesterDefPolicy = Get-Random @( + [JumpCloud.SDK.V2.Models.Policy]@{ + Name = "Pester_Windows - $(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + TemplateId = (Get-JcSdkPolicyTemplate | Where-Object { $_.OSMetaFamily -eq 'windows' } | Select-Object -First 1).Id + }, + [JumpCloud.SDK.V2.Models.Policy]@{ + Name = "Pester_Linux - $(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + TemplateId = (Get-JcSdkPolicyTemplate | Where-Object { $_.OSMetaFamily -eq 'linux' } | Select-Object -First 1).Id + }, + [JumpCloud.SDK.V2.Models.Policy]@{ + Name = "Pester_Darwin - $(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + TemplateId = (Get-JcSdkPolicyTemplate | Where-Object { $_.OSMetaFamily -eq 'darwin' } | Select-Object -First 1).Id + } + ) + # Create a Software App + $global:PesterDefSoftwareApp = [JumpCloud.SDK.V2.Models.SoftwareApp]@{ + DisplayName = "Adobe Reader" + Settings = [JumpCloud.SDK.V2.Models.SoftwareAppSettings]@{ + PackageId = 'adobereader' + packageManager = 'CHOCOLATEY' + Scope = 'system' + } + } + # Create a static User Group + $global:PesterDefUserGroupStatic = [JumpCloud.SDK.V2.Models.UserGroupPost]::new() + $global:PesterDefUserGroupStatic.Name = "PesterTestUserGroup-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + + # Create a User Group with Filter type membership + $UserFilter = [JumpCloud.SDK.V2.Models.MemberQuery]::new() + $UserFilter.Filters = @('description:$eq:test') + $UserFilter.QueryType = "Filter" + $global:PesterDefUserGroupFilter = [JumpCloud.SDK.V2.Models.UserGroupPost]::new() + $global:PesterDefUserGroupFilter.Name = "PesterTestUserGroupFilter-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + $global:PesterDefUserGroupFilter.MemberQueryFilters = $UserFilter.Filters + $global:PesterDefUserGroupFilter.MemberQueryType = $UserFilter.QueryType + # Create a User Group with Search type membership + $UserFilter = [JumpCloud.SDK.V2.Models.MemberQuery]::new() + $UserFilter.Filters = '{"filter":{"and":["department:$eq:Sales","company:$co:Toast"]}}' + $UserFilter.QueryType = "Search" + $global:PesterDefUserGroupSearch = [JumpCloud.SDK.V2.Models.UserGroupPost]::new() + $global:PesterDefUserGroupSearch.Name = "PesterTestUserGroupSearch-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + $global:PesterDefUserGroupSearch.MemberQuerySearchFilters = $UserFilter.Filters + $global:PesterDefUserGroupSearch.MemberQueryType = $UserFilter.QueryType + + # Create a System Group + $global:PesterDefSystemGroupStatic = [JumpCloud.SDK.V2.Models.SystemGroupPost]::new() + $global:PesterDefSystemGroupStatic.Name = "PesterTestSystemGroup-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + # Create a System Group with Filter type membership + $SystemFilter = [JumpCloud.SDK.V2.Models.MemberQuery]::new() + $SystemFilter.Filters = @('osFamily:$eq:linux', 'osFamily:$eq:windows') + $SystemFilter.QueryType = "Filter" + $global:PesterDefSystemGroupFilter = [JumpCloud.SDK.V2.Models.SystemGroupPost]::new() + $global:PesterDefSystemGroupFilter.Name = "PesterTestSystemGroupFilter-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + $global:PesterDefSystemGroupFilter.MemberQueryFilters = $systemFilter.Filters + $global:PesterDefSystemGroupFilter.MemberQueryType = $SystemFilter.QueryType + + # Create a System Group with Search type membership + $SystemFilter = [JumpCloud.SDK.V2.Models.MemberQuery]::new() + $SystemFilter.Filters = '{"filter":{"and":["osFamily:$eq:windows","hostname:$co:ISB"]}}' + $SystemFilter.QueryType = "Search" + $global:PesterDefSystemGroupSearch = [JumpCloud.SDK.V2.Models.SystemGroupPost]::new() + $global:PesterDefSystemGroupSearch.Name = "PesterTestSystemGroupSearch-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + $global:PesterDefSystemGroupSearch.MemberQuerySearchFilters = $SystemFilter.Filters + $global:PesterDefSystemGroupSearch.MemberQueryType = $SystemFilter.QueryType + + # Create a Policy Group + $global:PesterDefPolicyGroup = [JumpCloud.SDK.V2.Models.PolicyGroup]@{ + Name = "PesterTestPolicyGroup-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + } +} +If ($moduleName -eq 'JumpCloud.SDK.V1' -or $moduleName -eq 'JumpCloud.SDK.V2' -and "MTP" -in $Env:IncludeTagList) +{ + # Set MTP Keys & Continue to test + $env:JCApiKey = $env:JCApiKeyMTP + $env:JCOrgId = (Get-JcSdkOrganization | Select-Object -First 1).Id + + $global:PesterDefProviderAdminName = "ProviderAdmin-$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ }))" + + $global:PesterDefProviderAdmin = @{ + Email = "$($global:PesterDefProviderAdminName)@example$(-join ((65..90) + (97..122) | Get-Random -Count 5 | ForEach-Object { [char]$_ })).com"; + Firstname = 'AdminFirst' + Lastname = 'AdminLast' + RoleName = 'Help Desk' + } + # Get admins on an org (Required to test V1 MTP methods) + $headers = @{ + "x-api-key" = $env:JCApiKey + "x-org-id" = $env:JCOrgId + } + $global:PesterTestAdministratorUsers = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/users?skip=0&limit=20' -Method GET -Headers $headers +} +#endregion Define Objects + +#region Run Pester Tests +# If V2 is being run then run the V1 tests also because of dependencies +$moduleTestFolder = If ($moduleName -eq 'JumpCloud.SDK.V2') +{ + @($testFolder.Replace('V2', 'V1'), $testFolder) +} +else +{ + $testFolder +} +# Validate script syntax +$LintFilePath = "$PSScriptRoot/custom/generated/*.ps1" +# Import Settings: + +$ScriptAnalyzerResult = Invoke-ScriptAnalyzer -Path:("$LintFilePath") -recurse -Settings:("$PSScriptRoot/../../../Tools/PSScriptAnalyzerSettings.psd1") +If ($ScriptAnalyzerResult) +{ + $ScriptAnalyzerResult +} + +$Filter = "*" +$PesterTestFiles = @() +# Populate with test file basenames that need to be run in a specific order +$OrderedTestsSetup = @('New-JcSdkUserGroup.Tests', 'New-JcSdkAuthenticationPolicy.Tests', 'New-JcSdkCommand.Tests', 'Invoke-JcSdkCommandTrigger.Tests') +$OrderedTestsUpdate = @() +$OrderedTestsMain = @('Lock-JcSdkUser.Tests', 'Unlock-JcSdkUser.Tests') +$OrderedTestsTakeDown = @('Remove-JcSdkUserSshKey.Tests', 'Remove-JcSdkUser.Tests') +$TestFiles = Get-ChildItem -Path:($moduleTestFolder) -Recurse | Where-Object { $_.BaseName -like "*$($Filter).Tests*" } +# Add "New" tests (Setup Org) +$OrderedTestsSetup | ForEach-Object { $FileBaseName = $_; $PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -eq $FileBaseName }; } +$PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -like "New-*" -and $_.BaseName -notin $PesterTestFiles.BaseName } +# Add "Set" tests (Setup Org) +$OrderedTestsUpdate | ForEach-Object { $FileBaseName = $_; $PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -eq $FileBaseName }; } +$PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -like "Set-*" -and $_.BaseName -notin $PesterTestFiles.BaseName } +# Add tests that are not "Get" or "Remove" (Setup Org) +$OrderedTestsUpdate | ForEach-Object { $FileBaseName = $_; $PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -eq $FileBaseName }; } +$PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -notlike "Get-*" -and $_.BaseName -notlike "Remove-*" -and $_.BaseName -notin $PesterTestFiles.BaseName } +# # Add "Get" tests (Setup Org) +$OrderedTestsMain | ForEach-Object { $FileBaseName = $_; $PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -eq $FileBaseName }; } +$PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -like "Get-*" -and $_.BaseName -notin $PesterTestFiles.BaseName } +# Add "Remove" tests (Cleanup Org) +$OrderedTestsTakeDown | ForEach-Object { $FileBaseName = $_; $PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -eq $FileBaseName }; } +$PesterTestFiles += $TestFiles | Where-Object { $_.BaseName -like "Remove-*" -and $_.BaseName -notin $PesterTestFiles.BaseName } +# Run tests +$PesterTestResultFolder = (Join-Path $testFolder "results") +If (!(Test-Path -Path:($PesterTestResultFolder))) { New-Item -Path:($PesterTestResultFolder) -ItemType:('Directory') | Out-Null } +$PesterTestResultPath = Join-Path $PesterTestResultFolder "$moduleName-TestResults.xml" +$PesterTestCoveragePath = Join-Path $PesterTestResultFolder "$moduleName-TestCoverage.xml" +# Print Test Coverage & Pester 5 Compatibility: +. "$PSScriptRoot/../../../Tools/ValidateTests.ps1" -SDKName $moduleName +# Write-Host "$($PesterTestFiles.FullName)" +$configuration = New-PesterConfiguration +$configuration.Run.Path = $($PesterTestFiles.FullName) +$configuration.Should.ErrorAction = 'Continue' +$configuration.CodeCoverage.Enabled = $false +$configuration.testresult.Enabled = $true +$configuration.testresult.OutputFormat = 'JUnitXml' +$configuration.Filter.Tag = $Env:IncludeTagList +$configuration.Filter.ExcludeTag = $Env:ExcludeTagList +$configuration.CodeCoverage.OutputPath = ($PesterTestCoveragePath) +$configuration.testresult.OutputPath = ($PesterTestResultPath) +# Invoke pester +Invoke-Pester -configuration $configuration +#endregion Run Pester Tests + +#region Clean Up (This section should ideally be taken care of by the "Remove-" tests) +If ($moduleName -eq 'JumpCloud.SDK.V1') +{ + # # Remove Commands + # $null = Get-JcSdkCommand | ForEach-Object { Remove-JcSdkCommand -Id:($_.Id) } + # # Remove Users and SSH Keys + # $null = Get-JcSdkUser | ForEach-Object { + # $UserId = $_.Id + # If ( $_.ExternallyManaged ) + # { + # Set-JcSdkUser -Id:($UserId) -ExternallyManaged:($false) + # } + # If ($_.SshKeys) + # { + # $_.SshKeys | ForEach-Object { + # Remove-JcSdkUserSshKey -Id:($_.Id) -SystemuserId:($UserId) + # } + # } + # Remove-JcSdkUser -Id:($UserId) + # } + # # Remove RADIUS Servers + # $null = Get-JcSdkRadiusServer | ForEach-Object { Remove-JcSdkRadiusServer -Id:($_.Id) } +} +If ($moduleName -eq 'JumpCloud.SDK.V2') +{ + # Remove-JcSdkCustomEmailConfiguration -CustomEmailType:('password_reset_confirmation') + # Remove-JcSdkGSuiteTranslationRule -GsuiteId:((Get-JcSdkDirectory | Where-Object { $_.type -eq "g_suite" } | Select-Object -First 1).id) -Id:((Get-JcSdkGSuiteTranslationRule -GsuiteId:((Get-JcSdkDirectory | Where-Object { $_.type -eq "g_suite" } | Select-Object -First 1).id)).id) + # Remove-JcSdkOffice365TranslationRule -Office365Id:((Get-JcSdkDirectory | Where-Object { $_.type -eq "office_365" } | Select-Object -First 1).id) -Id:((Get-JcSdkOffice365TranslationRule -Office365Id:((Get-JcSdkDirectory | Where-Object { $_.type -eq "office_365" } | Select-Object -First 1).id)).id) +} +#endregion Clean Up + } Finally { if ($TestMode -ne 'playback') @@ -86,3 +565,4 @@ try } Write-Host -ForegroundColor Green '-------------Done-------------' + diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/test/loadEnv.ps1 b/SDKs/PowerShell/JumpCloud.SDK.V2/test/loadEnv.ps1 index 9fa946467..d85c34bd4 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/test/loadEnv.ps1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/test/loadEnv.ps1 @@ -16,4 +16,17 @@ $env = @{} if (Test-Path -Path $envFilePath) { $env = Get-Content (Join-Path $PSScriptRoot $envFile) | ConvertFrom-Json $PSDefaultParameterValues=@{"*:Tenant"=$env.Tenant} -} \ No newline at end of file +} +# Determine default host values based on environment +$apiHost = 'api' +$consoleHost = 'console' + +if ($env:JCEnvironment -eq 'EU') { + $apiHost = 'api.eu' + $consoleHost = 'console.eu' +} + +# Set both parameter defaults so all SDKs work correctly +$PSDefaultParameterValues['*-JcSdk*:ApiHost'] = $apiHost +$PSDefaultParameterValues['*-JcSdk*:ConsoleHost'] = $consoleHost +# Write-Host "Test environment loaded. ApiHost set to: $apiHost, ConsoleHost set to: $consoleHost" From 6f627945b07019d955deb5b3a5f90376ad943da8 Mon Sep 17 00:00:00 2001 From: Joe Workman Date: Mon, 11 May 2026 09:14:11 -0600 Subject: [PATCH 06/11] ModuleIdentifier --- .../JumpCloud.SDK.DirectoryInsights/custom/ModuleIdentifier.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/custom/ModuleIdentifier.cs b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/custom/ModuleIdentifier.cs index 944d146a6..9fefdbd7f 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/custom/ModuleIdentifier.cs +++ b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/custom/ModuleIdentifier.cs @@ -2,6 +2,6 @@ namespace ModuleNameSpace { public static class ModuleIdentifier { - public const string SDKName = ""; + public const string SDKName = "DirectoryInsights"; } } From 07856c25a40e7bad5c9f509d75597a08453a6314 Mon Sep 17 00:00:00 2001 From: Joe Workman Date: Mon, 11 May 2026 09:14:25 -0600 Subject: [PATCH 07/11] module identifier missing in BuildAutoRest --- BuildAutoRest.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/BuildAutoRest.ps1 b/BuildAutoRest.ps1 index 29cb8478a..d373cbec1 100644 --- a/BuildAutoRest.ps1 +++ b/BuildAutoRest.ps1 @@ -190,7 +190,7 @@ ForEach ($SDK In $SDKName) } # After AutoRest generation, create a ModuleIdentifier.cs file for each SDK $moduleIdentifierPath = "$OutputFullPath/custom/ModuleIdentifier.cs" - $sdkIdentifier = switch ($SDKNameItem) { + $sdkIdentifier = switch ($SDKName) { 'JumpCloud.SDK.DirectoryInsights' { 'DirectoryInsights' } 'JumpCloud.SDK.V1' { 'V1' } 'JumpCloud.SDK.V2' { 'V2' } From e56c2d21451049a8369062ddaed476525c61c96b Mon Sep 17 00:00:00 2001 From: Joe Workman Date: Mon, 11 May 2026 09:16:22 -0600 Subject: [PATCH 08/11] v1 --- SDKs/PowerShell/JumpCloud.SDK.V1/custom/ModuleIdentifier.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SDKs/PowerShell/JumpCloud.SDK.V1/custom/ModuleIdentifier.cs b/SDKs/PowerShell/JumpCloud.SDK.V1/custom/ModuleIdentifier.cs index 944d146a6..4ccbc0c4a 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V1/custom/ModuleIdentifier.cs +++ b/SDKs/PowerShell/JumpCloud.SDK.V1/custom/ModuleIdentifier.cs @@ -2,6 +2,6 @@ namespace ModuleNameSpace { public static class ModuleIdentifier { - public const string SDKName = ""; + public const string SDKName = "V1"; } } From c3f6953a50d60189439d6c2f38cbcb466bc981ca Mon Sep 17 00:00:00 2001 From: Joe Workman Date: Mon, 11 May 2026 09:20:59 -0600 Subject: [PATCH 09/11] v2 --- SDKs/PowerShell/JumpCloud.SDK.V2/custom/ModuleIdentifier.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/ModuleIdentifier.cs b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/ModuleIdentifier.cs index 944d146a6..bfdbd4863 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/custom/ModuleIdentifier.cs +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/custom/ModuleIdentifier.cs @@ -2,6 +2,6 @@ namespace ModuleNameSpace { public static class ModuleIdentifier { - public const string SDKName = ""; + public const string SDKName = "V2"; } } From 4ef52d2dc41133e8e052188cf73aeab7ea7290be Mon Sep 17 00:00:00 2001 From: Joe Workman Date: Mon, 11 May 2026 09:33:52 -0600 Subject: [PATCH 10/11] validate module + changelog --- .github/workflows/jcapi-powershell-ci.yml | 1 + JumpCloud.SDK.DirectoryInsights.md | 32 +++++++++++++++++++++++ JumpCloud.SDK.V1.md | 32 +++++++++++++++++++++++ JumpCloud.SDK.V2.md | 32 +++++++++++++++++++++++ Tools/ModuleValidation.Tests.ps1 | 4 +-- 5 files changed, 99 insertions(+), 2 deletions(-) diff --git a/.github/workflows/jcapi-powershell-ci.yml b/.github/workflows/jcapi-powershell-ci.yml index 91c93008d..da7bbc6af 100644 --- a/.github/workflows/jcapi-powershell-ci.yml +++ b/.github/workflows/jcapi-powershell-ci.yml @@ -144,6 +144,7 @@ jobs: v2: ${{ needs.Check-PR-Labels.outputs.v2 }} directoryinsights: ${{ needs.Check-PR-Labels.outputs.directoryinsights }} RELEASE_TYPE: ${{ needs.Check-PR-Labels.outputs.RELEASE_TYPE }} + SKIP_API_TRANSFORM: ${{ needs.Check-PR-Labels.outputs.SKIP_API_TRANSFORM }} run: | # Construct the PR_LABELS variable for the Pester test script $prLabels = @() diff --git a/JumpCloud.SDK.DirectoryInsights.md b/JumpCloud.SDK.DirectoryInsights.md index 30aef8176..2b4a7fa02 100644 --- a/JumpCloud.SDK.DirectoryInsights.md +++ b/JumpCloud.SDK.DirectoryInsights.md @@ -1,3 +1,35 @@ +## JumpCloud.SDK.DirectoryInsights-0.2.0 +Release Date: May 11, 2026 +#### RELEASE NOTES +``` +Support for the IN region has been added to the Directory Insights SDK. +``` +#### FEATURES: +Support for the IN region has been added to the Directory Insights SDK. +#### IMPROVEMENTS: +NA +#### BUG FIXES: +NA +#### Generated Changes: + +
+Functions Added + +No changes +
+ +
+Functions Modified + +No changes +
+ +
+Functions Removed + +No changes +
+ ## JumpCloud.SDK.DirectoryInsights-0.1.1 Release Date: November 24, 2025 #### RELEASE NOTES diff --git a/JumpCloud.SDK.V1.md b/JumpCloud.SDK.V1.md index 4b5722530..2a2633cd7 100644 --- a/JumpCloud.SDK.V1.md +++ b/JumpCloud.SDK.V1.md @@ -1,3 +1,35 @@ +## JumpCloud.SDK.V1-0.2.0 +Release Date: May 11, 2026 +#### RELEASE NOTES +``` +Support for the IN region has been added to the V1 SDK. +``` +#### FEATURES: +Support for the IN region has been added to the V1 SDK. +#### IMPROVEMENTS: +NA +#### BUG FIXES: +NA +#### Generated Changes: + +
+Functions Added + +No changes +
+ +
+Functions Modified + +No changes +
+ +
+Functions Removed + +No changes +
+ ## JumpCloud.SDK.V1-0.1.3 Release Date: March 26, 2026 #### RELEASE NOTES diff --git a/JumpCloud.SDK.V2.md b/JumpCloud.SDK.V2.md index afd361a5a..ff8d8a6de 100644 --- a/JumpCloud.SDK.V2.md +++ b/JumpCloud.SDK.V2.md @@ -1,3 +1,35 @@ +## JumpCloud.SDK.V2-0.3.0 +Release Date: May 11, 2026 +#### RELEASE NOTES +``` +Support for the IN region has been added to the V2 SDK. +``` +#### FEATURES: +Support for the IN region has been added to the V2 SDK. +#### IMPROVEMENTS: +NA +#### BUG FIXES: +NA +#### Generated Changes: + +
+Functions Added + +No changes +
+ +
+Functions Modified + +No changes +
+ +
+Functions Removed + +No changes +
+ ## JumpCloud.SDK.V2-0.2.1 Release Date: March 26, 2026 #### RELEASE NOTES diff --git a/Tools/ModuleValidation.Tests.ps1 b/Tools/ModuleValidation.Tests.ps1 index d50e3d949..d2c329567 100644 --- a/Tools/ModuleValidation.Tests.ps1 +++ b/Tools/ModuleValidation.Tests.ps1 @@ -89,8 +89,8 @@ Describe -Tag:('ModuleValidation') 'Module Validation' -ForEach $modulesToValida Get-Content -Path $changelogPath | Should -Not -Match '\{\{Fill in the' } - It "ensures the Swagger spec is up to date with no pending changes for <_>" { - # Note: Assumes dependent scripts are in the parent directory of this test script. + It "ensures the Swagger spec is up to date with no pending changes for <_>" -Skip:($env:SKIP_API_TRANSFORM -eq 'true') { + # When CI sets SKIP_API_TRANSFORM (PR label skip-api-transform), ApiTransform is not required here. . (Join-Path $PSScriptRoot '..' 'ApiTransform.ps1') -SDKName $moduleName 3>$null $sdkSwaggerFile = Join-Path $PSScriptRoot '..' 'SwaggerSpecs' "$moduleName.json" From cc0c5f8629e48a23fd449fad8cea857640caa31c Mon Sep 17 00:00:00 2001 From: Joe Workman Date: Wed, 20 May 2026 08:52:02 -0600 Subject: [PATCH 11/11] changelog + regenerate psd1 --- JumpCloud.SDK.DirectoryInsights.md | 2 +- JumpCloud.SDK.V1.md | 2 +- JumpCloud.SDK.V2.md | 2 +- .../JumpCloud.SDK.DirectoryInsights.psd1 | 2 +- SDKs/PowerShell/JumpCloud.SDK.V1/JumpCloud.SDK.V1.psd1 | 2 +- SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.psd1 | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/JumpCloud.SDK.DirectoryInsights.md b/JumpCloud.SDK.DirectoryInsights.md index 2b4a7fa02..dded946ce 100644 --- a/JumpCloud.SDK.DirectoryInsights.md +++ b/JumpCloud.SDK.DirectoryInsights.md @@ -1,5 +1,5 @@ ## JumpCloud.SDK.DirectoryInsights-0.2.0 -Release Date: May 11, 2026 +Release Date: May 20, 2026 #### RELEASE NOTES ``` Support for the IN region has been added to the Directory Insights SDK. diff --git a/JumpCloud.SDK.V1.md b/JumpCloud.SDK.V1.md index 2a2633cd7..564c38fc6 100644 --- a/JumpCloud.SDK.V1.md +++ b/JumpCloud.SDK.V1.md @@ -1,5 +1,5 @@ ## JumpCloud.SDK.V1-0.2.0 -Release Date: May 11, 2026 +Release Date: May 20, 2026 #### RELEASE NOTES ``` Support for the IN region has been added to the V1 SDK. diff --git a/JumpCloud.SDK.V2.md b/JumpCloud.SDK.V2.md index ff8d8a6de..575ffda81 100644 --- a/JumpCloud.SDK.V2.md +++ b/JumpCloud.SDK.V2.md @@ -1,5 +1,5 @@ ## JumpCloud.SDK.V2-0.3.0 -Release Date: May 11, 2026 +Release Date: May 20, 2026 #### RELEASE NOTES ``` Support for the IN region has been added to the V2 SDK. diff --git a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/JumpCloud.SDK.DirectoryInsights.psd1 b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/JumpCloud.SDK.DirectoryInsights.psd1 index 161ec712f..1e88e0052 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/JumpCloud.SDK.DirectoryInsights.psd1 +++ b/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/JumpCloud.SDK.DirectoryInsights.psd1 @@ -3,7 +3,7 @@ # # Generated by: JumpCloud # -# Generated on: 5/11/2026 +# Generated on: 5/20/2026 # @{ diff --git a/SDKs/PowerShell/JumpCloud.SDK.V1/JumpCloud.SDK.V1.psd1 b/SDKs/PowerShell/JumpCloud.SDK.V1/JumpCloud.SDK.V1.psd1 index 988ee741c..371e2a880 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V1/JumpCloud.SDK.V1.psd1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V1/JumpCloud.SDK.V1.psd1 @@ -3,7 +3,7 @@ # # Generated by: JumpCloud # -# Generated on: 5/11/2026 +# Generated on: 5/20/2026 # @{ diff --git a/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.psd1 b/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.psd1 index a15db575d..6cde7db62 100644 --- a/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.psd1 +++ b/SDKs/PowerShell/JumpCloud.SDK.V2/JumpCloud.SDK.V2.psd1 @@ -3,7 +3,7 @@ # # Generated by: JumpCloud # -# Generated on: 5/11/2026 +# Generated on: 5/20/2026 # @{