Import Custom User Attributes from CSV

Within JumpCloud you can configure custom user attributes, see Custom User Attributes to learn more. This article is intended to provide IT Admins a method of modifying these attributes using the JumpCloud API.

JumpCloud provides a pre-compiled binary within our API Utility rollup. Download the latest rollup on GitHub. The uncompressed package will contain the file ImportUserAttributes_os_arch.

ImportUserAttributes Usage

Linux / Mac OS X:

./ImportUserAttributes_darwin_amd64

Usage of ./ImportUserAttributes:
-api-key="": -api-key=
-input="": -input=
-output="": -output=

-url="": -url=https://console.jumpcloud.com/api

./ImportUserAttributes_darwin_amd64 -api-key="YOUR_API_KEY" -input="PATH_TO_CSV" -output="PATH_TO_OUTPUT_LOG" -url="https://console.jumpcloud.com/api"

Windows:

PS C:\Users\Administrator\Downloads> .\ImportUserAttributes.exe
Usage of ./ImportUserAttributes:
-api-key="": -api-key=
-input="": -input=
-output="": -output=
-url="": -url=https://console.jumpcloud.com/api

PS C:\Users\Administrator\Downloads> .\ImportUserAttributes_darwin_amd64 -api-key="YOUR_API_KEY" -input="PATH_TO_CSV" -output="PATH_TO_OUTPUT_LOG" -url="https://console.jumpcloud.com/api"

Building the CSV File

The first row will need to apply the following format for the first two columns headers:

  • email: Users are identified from the CSV based on the email address input, and should match that of the email address of the JumpCloud User.
  • [insert custom attribute name here]: This entry represents the Attribute Name that you would like to assign the users. See Custom User Attributes or more information on the Name attribute.

From the second row onward, the entries are values for either email or the custom attribute name specified. In the below example, the users are given a custom attribute name of Manager. The inputs denote the user's manager's name.

custom-attribute-name.png

The exported CSV should look like this based on the above:

email,Manager
[email protected],John Doe
[email protected],Jane Doe
[email protected],John Doe
[email protected],Jane Doe

Resulting Custom User Attributes

Now, you should be able to confirm that the user's new custom attribute is available under Details Custom Attributes in the User panel.

details-custom-attributes.png
Back to Top

Still Have Questions?

If you cannot find an answer to your question in our FAQ, you can always contact us.

Submit a Case