Add reference information to devices, users, and organizations

Last updated
Save as PDF

Who is this article for?

CrashPlan Cloud

CrashPlan for Small Business

CrashPlan On-Premises

Find your product plan in the Code42 console on the Account menu.
Not a CrashPlan On-Premises customer? Search or browse Incydr and Instructor, CrashPlan Cloud, or CrashPlan for Small Business.

Instructor, no.

Incydr Professional, Enterprise, Gov F2, and Horizon, no.

Incydr Basic, Advanced, and Gov F1, no.

CrashPlan Cloud, no.

Retired product plans, yes.

CrashPlan for Small Business, no.

Overview

Reference fields allow you to add descriptive information to devices, users, and organizations in your Code42 environment. This descriptive information can be used to add additional context for administrators, and also to integrate with external systems.

This article describes how to use the reference fields from both the Code42 console and the Code42 API.

Reference fields

The Code42 platform supports the following reference fields for devices, users, and organizations:

External Reference: Intended for optional external reference information, such as a serial number, asset tag, employee ID, or help desk issue ID.
Notes: Intended for optional descriptive information.

Considerations

Use the Code42 console to edit reference information

Sign in to your authority server's Code42 console.
Select Devices, Users, or Organizations.
Click the name of the device, user, or organization.
From the action menu, select Edit.
Click Reference.
Configure the reference fields for the device, user, or organization:
- External Reference
- Notes
Click Save.

Use the Code42 API to add reference information

Code42 API not available for Code42 Standard
Use of the Code42 API is not permitted for customers with the Code42 Standard product plan.

Consider using the Code42 API to add reference information if you need to:

Add reference information for many devices, users, or organizations in your Code42 environment via scripting.
Configure an external system in your environment to automatically set reference information.

The examples below illustrate how to set the reference information for one user, device, or organization at a time. If you want to set values for many items at once, use the examples as the basis for a custom script.

Use the Code42 API to add reference information for a device

The Code42 API Computer resource allows you to set the computerExtRef and notes parameters for a device.

Find a device's guid using one of these methods:

Search by the userUid of the user that owns the device:

curl -X GET -u 'username' 'https://master-server.example.com:4285/api/Computer?userUid=<userUid>' | python -m json.tool

Search for the device by name:

curl -X GET -u 'username' 'https://master-server.example.com:4285/api/Computer?q=<name> | python -m json.tool

Locate the device's guid in the output. For example:
```
"guid": "681099810721783680"
```

Set the computerExtRef and notes parameters for the appropriate device guid:

curl -X PUT -u 'username' -d '{ "computerExtRef": "Asset 410", "notes": "A note about the device" }' -H 'Content-Type: application/json' 'https://master-server.example.com:4285/api/Computer/<guid>?idType=guid' | python -m json.tool

Examine the output of the command to verify that computerExtRef and notes contain the correct values.

Use the Code42 API to add reference information for a user

The Code42 API User resource allows you to set the userExtRef and notes parameters for a user.

Find a user's userUid using one of these methods:

Search for the user by email address:

curl -X GET -u 'username' 'https://master-server.example.com:4285/api/User?email=<email_address>' | python -m json.tool

Search for the user by username:

 curl -X GET -u 'username' 'https://master-server.example.com:4285/api/User?username=<username>' | python -m json.tool

Search for the user by first and last name:

curl -X GET -u 'username' 'https://master-server.example.com:4285/api/User?q=<firstname>&&<lastname>' | python -m json.tool

Locate the user's userUid in the output. For example:
```
"userUid": "fa1633c3e5507360"
```

Set the userExtRef and notes parameters for the appropriate userUid:

curl -X PUT -u 'username' -d '{ "userExtRef": "ID040189", "notes": "A note about the user" }' -H 'Content-Type: application/json' 'https://master-server.example.com:4285/api/User/<userUid>?idType=uid' | python -m json.tool

Examine the output of the command to verify that userExtRef and notes contain the correct values.

Use the Code42 API to add reference information for an organization

The Code42 API Org resource allows you to set the orgExtRef and notes parameters for an organization.

Find the organization's orgUid by searching for its name:

curl -X GET -u 'username' 'https://master-server.example.com:4285/api/Org?q=<organization_name>' | python -m json.tool

Locate the organization's orgUid in the output. For example:
```
"orgUid": "691968598454770525"
```

Set the orgExtRef and notes parameters for the appropriate orgUid:

curl -X PUT -u 'username' -d '{ "orgExtRef": "An organization identifier", "notes": "A note about this organization" }' -H 'Content-Type: application/json' 'https://master-server.example.com:4285/api/Org/<orgUid>?idType=orgUid' | python -m json.tool

Examine the output of the command to verify that orgExtRef and notes contain the correct values.