JumpCloud provides a precompiled binary within our API Utility rollup. Download the latest rollup on GitHub, the uncompressed package will contain the file CSVImporter_os_arch.
Linux / Mac OS X:
# ./CSVImporter_darwin_amd64 Usage of ./CSVImporter: -csv="": -csv=<filename> -key="": -key=<API-key-value> # ./CSVImporter_darwin_amd64 -csv="PATH_TO_CSV" -key="YOUR_API_KEY"
PS C:\Users\Administrator\Downloads> .\CSVImporter_windows_amd64.exe Usage of ./CSVImporter: -csv="": -csv=<filename> -key="": -key=<API-key-value> PS C:\Users\Administrator\Downloads> .\CSVImporter_windows_amd64.exe -csv="PATH_TO_CSV" -key="YOUR_API_KEY"
Building the CSV File
- The column headers in row one are for reference only and should be removed before attempting import
- A minimum 9 fields are required
- Username and email are required, if SUDO Access is left blank, the user will be granted Global Administrator
- Email addresses must be all lowercase
- If the password is not set, the user will receive an email to complete registration. Setting the password will bypass that step and immediately activate the user.
Importing a User Only
The exported CSV should look like this:
NOTE: Some spreadsheet programs may not output commas when the column has no values, e.g., Google Sheets will include the comma if each column in the first row has a space, then the file downloaded as csv. As noted, the row with column headings should be deleted prior to import.
Importing a User and Adding it to a Tag
The import utility allows for binding the user to an existing managed system via Tag (optional). See Getting Started: Tags
To tag a user to an existing system, specify the Host Name in column I as it appears in the System Details in the JumpCloud console. The tag will be created with one of two naming conventions:
If a first/last name are specified for the user:
Hostname - FirstName LastName (Username)If no first/last name:
Hostname - (Username)E.g., where the hostname of the system is 'John-Doe's MacBook Pro.local'
Adding Administrators to your Systems
Additional administrators (optional) can be added to the tag at the same time, specify them in column J and higher.
UID / GID (optional): If the global setting 'Keep UID consistent across all servers' is enabled in Settings, the UID and GID will be automatically assigned. Otherwise, specify the desired values.