Skip to main content
Code42 Support

Add reference information to devices, users, and organizations

Available in:

StandardPremiumEnterprise
Small Business
Applies to:

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 administration 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

The examples in this article use the command line tool curl to interact with the Code42 API. For a list of tools that can be used to interact with the API, see Code42 API tools.

Use the administration console to edit reference information

  1. Sign in to your authority server's administration console.
  2. Select Devices, Users, or Organizations.
  3. Click the name of the device, user, or organization.
  4. From the action menu, select Edit.
  5. Click Reference.
    User reference information
  6. Configure the reference fields for the device, user, or organization:
    • External Reference
    • Notes
  7. Click Save.

Use the Code42 API to add reference information

Code42 API not available for Code42 CrashPlan Standard
Use of the Code42 API is not permitted for customers with the Code42 CrashPlan 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.

In the example Code42 API requests below, replace the following values as needed to match your Code42 environment:

  • username:password
  • https://authority-server.example.com:4285
  • <values in brackets>

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.

  1. 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:password' '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:password' 'https://master-server.example.com:4285/api/Computer?q=<name> | python -m json.tool
      
  2. Locate the device's guid in the output. For example:
    "guid": "681099810721783680"
    
  3. Set the computerExtRef and notes parameters for the appropriate device guid:
    curl -X PUT -u 'username:password' -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
    
  4. 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.

  1. Find a user's userUid using one of these methods:
    • Search for the user by email address:
      curl -X GET -u 'username:password' '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:password' '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:password' 'https://master-server.example.com:4285/api/User?q=<firstname>&&<lastname>' | python -m json.tool
      
  2. Locate the user's userUid in the output. For example:
    "userUid": "fa1633c3e5507360"
    
  3. Set the userExtRef and notes parameters for the appropriate userUid:
    curl -X PUT -u 'username:password' -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
    
  4. 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.

  1. Find the organization's orgUid by searching for its name:
    curl -X GET -u 'username:password' 'https://master-server.example.com:4285/api/Org?q=<organization_name>' | python -m json.tool
    
  2. Locate the organization's orgUid in the output. For example:
    "orgUid": "691968598454770525"
    
  3. Set the orgExtRef and notes parameters for the appropriate orgUid:
    curl -X PUT -u 'username:password' -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 
  4. Examine the output of the command to verify that orgExtRef and notes contain the correct values.
  • Was this article helpful?