Connect-JCOnline

NAME Connect-JCOnline



SYNOPSIS

The Connect-JCOnline function sets the global variable $JCAPIKEY





SYNTAX

Connect-JCOnline [-JumpCloudApiKey] <System.String> [[-JumpCloudOrgId] <System.String>] [[-JCEnvironment]

{production | staging}] [-force] [<CommonParameters>]





DESCRIPTION

By calling the Connect-JCOnline function you are setting the variable $JCAPIKEY within the global scope. By

setting this variable in the global scope the variable $JCAPIKEY can be reused by other functions in the JumpCloud

module. If you wish to change the API key to connect to another JumpCloud org simply call the Connect-JCOnline

function and enter the alternative API key. Introduced in JumpCloud module version 1.2 the Connect-JCOnline

function will also check to ensure you are running the latest version of the JumpCloud PowerShell module and offer

to update the module if there is an update available. To prevent the module update check the '-force' parameter

can be used.





PARAMETERS

-JCEnvironment <System.String>

Specific to JumpCloud development team to connect to staging dev environment.



Required? false

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-JumpCloudApiKey <System.String>

Please enter your JumpCloud API key. This can be found in the JumpCloud admin console within "API Settings"

accessible from the drop down icon next to the admin email address in the top right corner of the JumpCloud

admin console.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-JumpCloudOrgId <System.String>

Organization Id can be found in the Settings page within the admin console. Only needed for multi tenant

admins.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-force <System.Management.Automation.SwitchParameter>

Using the "-Force" parameter the module update check is skipped. The '-Force' parameter should be used when

using the JumpCloud module in scripts or other automation environments.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String







OUTPUTS

System.Object







NOTES









-------------------------- Example 1 --------------------------



Connect-JCOnline lu8792c9d4y2398is1tb6h0b83ebf0e92s97t382





-------------------------- Example 2 --------------------------



Connect-JCOnline lu8792c9d4y2398is1tb6h0b83ebf0e92s97t382 -force



Using the "-Force" parameter the module update check is skipped. The '-Force' parameter should be used when using

the JumpCloud module in scripts or other automation environments.

-------------------------- Example 3 --------------------------



Connect-JCOnline -JumpCloudAPIKey lu8792c9d4y2398is1tb6h0b83ebf0e92s97t382 -JumpCloudOrgID

5b5o13o06tsand0c29a0t3s6 -force



Providing the JumpCloudAPIKey key and the intended JumpCloudOrg ID to connect to multi tenant admins can skip the

JumpCloudOrgID connection screen and directly connect to an Org.



Using the "-Force" parameter the module update check is skipped. The '-Force' parameter should be used when using

the JumpCloud module in scripts or other automation environments.



RELATED LINKS

Online Version: https://github.com/TheJumpCloud/support ... t-JCOnline