Retrieve Object IDs from the API

JumpCloud, like many other directories, gives each object a specific or unique identifier. These objectIDs are associated with almost every item that is configurable within the platform. You may need these objectIDs if you’re troubleshooting an issue, writing custom scripts, calling the API, or integrating third party apps with the JumpCloud Platform.

In this article we’ll cover the most common Object IDs and how to get them through the API and JumpCloud PowerShell Module.

Prerequisites:

• To perform any of the following steps you’ll need your API Key. To gather your API key, see JumpCloud APIs – Accessing your API Key.
• To perform steps using the JumpCloud PowerShell Module, you’ll have to install it on your device. To download and install the JumpCloud PowerShell Module, see Install the JumpCloud PowerShell Module.

Retrieving ObjectIDs from the API or PowerShell Module

This section covers how to locate the ObjectIDs of the most common JumpCloud objects such as Users, User Groups, Devices, Device Groups, Policies, ApplicationIDs, and more through the API and the JumpCloud PowerShell Module.

Locating the User’s UserID

via cURL to API (Username)

This will print out the user’s id within JumpCloud. Ensure to replace ENTER_USERNAME_HERE with the target user’s username and replace API_KEY_GOES_HERE with your JumpCloud Admin API Key.

Example Output

via cURL to API (User’s Email Address)

This lets you retrieve the user id by searching for an email address. Ensure to replace the values: YOUR_ORG_ID, YOUR_API_KEY, and USER-EMAIL.

Example Output

via PowerShell Module

Example Output

Locating the Device’s SystemID

In JumpCloud, devices may also be called systems. In the Admin Portal, the device’s unique identifier is called the SystemId. In the API, the SystemId is refereed to as just _id or id. The SystemId is also found within the Agent configuration file on the targeted device as well.

via cURL to API

This will print out the device’s id within JumpCloud. Ensure you replace ENTER_HOSTNAME_HERE with the target device’s hostname, and replace API_KEY_GOES_HERE with your JumpCloud Admin API Key. You can find the Hostname of the Device in the Admin Portal within the Details panel of the selected Device.

Example Output

via PowerShell Module

Example Output

Retrieving Nested Values

You can use dot notation to access nested variables within API commands by filtering or searching. This method allows you to traverse through variables to locate specific values.

You get the following response for the API command.

The following example retrieves the MDM internal device ID by filtering the System List command.

• Postman:
  • Filter:

• API command:

This approach allows the use of nested variables for efficient data retrieval and management.

Locating the User Group ID

via cURL to API

This will print out the User Group’s id and other attributes within JumpCloud. Ensure you replace ENTER_USERGROUP_NAME_HERE with the target User Group’s name, and replace API_KEY_GOES_HERE with your JumpCloud Admin API Key.

Example Output

via PowerShell

Example Output

Locating Device Group ID

via cURL to API

This will print out the Device Group’s id (otherwise known as System Group) and other attributes within JumpCloud. Ensure you replace ENTER_DEVICEGROUP_NAME_HERE with the target Device Group’s name, and replace API_KEY_GOES_HERE with your JumpCloud Admin API Key.

Example Output

via PowerShell Module

Example Output

Locating SSO Application ID

via cURL to API

This will print out the Application’s id. Ensure you replace ENTER_APPLICATION_NAME_HERE with the target Device Group’s name, and replace API_KEY_GOES_HERE with your JumpCloud Admin API Key.

Example Output

via PowerShell Module

Example Output

Locating RADIUS NetworkID

The JumpCloud API cannot filter RADIUS down to a singular network without the objectID. You can get the objectID from the Admin Portal, or via PowerShell instead. In this API endpoint, it lists all RADIUS servers within the organization. You will be able to see all configured RADIUS servers, their configurations, and Ids.

via cURL to API

Example Output

via PowerShell Module

Example Output

Locating Device PolicyID

via cURL to API

This will print out the Device Policy’s id along with all of the other associated attributes. Ensure you replace ENTER_DEVICE_POLICY_NAME_HERE with the target Device Policy’s name, and replace API_KEY_GOES_HERE with your JumpCloud Admin API Key.

If you would like to pull just the ID, we recommend using the PowerShell Module, or using additional regex commands post cURL.

Example Output

via PowerShell Module

Example Output

Other objects within JumpCloud

If you’re looking to pull the objectIDs of other objects or items within the JumpCloud platform, you can reference JumpCloud’s API Documentation or the Wiki for JumpCloud’s PowerShell Module.

If you'd rather pull ObjectIDs from the Admin Portal GUI, see Retrieve Object IDs from the Admin Portal.