API Reference

Create Computer Extension Attribute.

post
https://{region}.api.jamfcloud.com/pro/v1/computer-extension-attributes

Create Computer Extension Attribute to collect extra inventory information.

Required Permissions: extension-attributes:create

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Computer Extension Attribute to be created.

string
required

Display name for the extension attribute.

string

Description for the extension attribute.

string
enum
required
Defaults to STRING

Type of data being collected.

Allowed:
boolean
Defaults to true

Enabled by default, but for inputType Script we can disable it as well.
Possible values are:
false
true

string
enum
required
Defaults to GENERAL

Category in which to display the extension attribute in Jamf Pro.

Allowed:
string
enum
required
Defaults to TEXT

Extension attributes collect inventory data by using an input type.The type of the Input used to populate the extension attribute.

Allowed:
string | null

When we run this script it returns a data value each time a computer submits inventory to Jamf Pro. Provide scriptContents only when inputType is 'SCRIPT'.

popupMenuChoices
array of strings
length ≥ 0

When added with list of choices while creating computer extension attributes these Pop-up menu can be displayed in inventory information. User can choose a value from the pop-up menu list when enrolling a computer any time using Jamf Pro. Provide popupMenuChoices only when inputType is 'POPUP'.

popupMenuChoices
string

Directory Service attribute use to populate the extension attribute.
Required when inputType is "DIRECTORY_SERVICE_ATTRIBUTE_MAPPING"

boolean
Defaults to false

Collect multiple values for this extension attribute. ldapExtensionAttributeAllowed is disabled by default, only for inputType 'DIRECTORY_SERVICE_ATTRIBUTE_MAPPING' it can be enabled. It's value cannot be modified during edit operation.
Possible values are:
false
true

string
enum

It is used to specify to either delete or retain the extension attributes values when inputType is Script and enabled is false.

Allowed:
Headers
uuid
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The tenant UUID identifier. Send it to address tenant scope. This API is also published at environment scope — send that scope's header instead. Send exactly one scope header per request.

uuid
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The environment UUID identifier. Send it to address environment scope. This API is also published at tenant scope — send that scope's header instead. Send exactly one scope header per request.

Responses

Updated 15 days ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 15 days ago

Did this page help you?