Skip to main content

Cyware Orchestrate

Jamf

App Vendor: Jamf

App Category: Network Security

Connector Version: 1.0.0

API Version: v1

Note

This app is currently released as a beta version.

About App

Jamf provides Apple device management solutions, empowering you to streamline device deployment, management, and security with intuitive software and services

The Jamf app is configured with Orchestrate to perform the following actions:

Action Name

Description

Create Advanced Mobile Device Search

This action creates an advanced search for mobile devices

Create Advanced User Content Search

This action creates an advanced search for user content

Generic Action

This is a generic action used to transcend the actions implemented by making a request to any endpoint

Get Advanced Mobile Device Searches

This action gets all advanced searches configured for mobile devices

Get Advanced Mobile Device Search Result

This action gets the result of an advanced search for mobile devices

Get Advanced User Content Searches

This action gets all advanced searches configured for user content

Get Advanced User Content Search Result

This action gets the result of an advanced search for user content

Get Buildings

This action searches all buildings

Get Computer Inventory

This action gets the inventory of all computers

Get LDAP Configurations

This action gets all LDAP configurations

Configuration Parameters

The following configuration parameters are required for the Jamf app to communicate with the Jamf enterprise application. The parameters can be configured by creating instances in the app.

Parameter

Description

Field Type

Required/Optional

Comments

Hostname 

Enter the hostname of the Jamf server

Text

Required

Client ID 

Enter the client ID to authenticate with the Jamf server

Text

Required

Client Secret 

Enter the client secret to authenticate with the Jamf server

Password

Required

Verify 

Choose your preference to verify SSL while making requests. Enabling this setting will ensure secure communication with the server.

Boolean

Optional

Default value: false

Timeout 

Enter the timeout value (in seconds) for the request

Integer

Optional

Default value: 15

Allowed range: 15-120

Action: Get Advanced Mobile Device Searches

This action gets all advanced searches configured for mobile devices

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Additional Data 

Enter any additional parameters to be sent with the request. This data is encoded into the URL.

Key Value

Optional

Action: Get Advanced Mobile Device Search Result

This action gets the result of an advanced search for mobile devices

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Search ID 

Enter the ID of the advanced search to get the result

Text

Required

Additional Data 

Enter any additional parameters to be sent with the request. This data is encoded into the URL.

Key Value

Optional

Action: Get Advanced User Content Searches

This action gets all advanced searches configured for user content

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Additional Data 

Enter any additional parameters to be sent with the request. This data is encoded into the URL.

Key Value

Optional

Action: Get Advanced User Content Search Result

This action gets the result of an advanced search for user content

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Search ID

Enter the ID of the advanced search to get the result.

Text

Required

Additional Data 

Enter any additional parameters to be sent with the request. This data is encoded into the URL.

Key Value

Optional

Action: Get Buildings

This action searches sorted and paged buildings in Jamf.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Filter 

Enter the query in the RSQL format, allowing to filter out the buildings collection.

Text

Optional

The default filter is an empty query that returns all results for the requested page.

Fields allowed in the query are name, streetaddress1, streetaddress2, city, stateprovince, zippostalcode, country.

This parameter can be combined with paging and sorting. Example: filter=city=="chicago" and name=="build"

Sort 

Enter the sorting criteria.

Example:

id:asc

Text

Optional

Page 

Enter the page number to get the results from.

Integer

Optional

Page Size 

Enter the number of results to be displayed per page.

Integer

Optional

Additional Data 

Enter any additional parameters to be sent with the request. This data is encoded into the URL.

Key Value

Optional

Action: Get Computer Inventory

This action gets the inventory of all computers.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Sections 

Enter the sections of the computer inventory to get.

Example: General, or purchasing

Text

Optional

Filter 

Enter the query in the RSQL format, allowing it to filter out the computers collection.

Text

Optional

The default filter is an empty query that returns all results for the requested page.

Fields allowed in the query are name, serialnumber, macaddress, ipaddress, osname, osversion, osbuild, osplatform, osfamily, model, modelidentifier, and modeldisplay.

Page 

Enter the page number to get the results

Integer

Optional

Page Size 

Enter the number of results to be displayed per page

Integer

Optional

Additional Data 

Enter any additional parameters to be sent with the request. This data is encoded into the URL.

Key Value

Optional

Action: Get LDAP Configurations

This action gets all LDAP configurations.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

LDAP Identifier 

Enter the identifier of the LDAP configuration

Text

Required

Additional Data 

Enter any additional parameters to be sent with the request. This data is encoded into the URL.

Key Value

Optional

Action: Generic Action

This is a generic action used to transcend the actions implemented by making a request to any endpoint

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Method 

Enter the HTTP method.

Example:

GET

Text

Required

Supported values:

  • GET

  • POST

  • PUT

  • DELETE

Endpoint 

Enter the endpoint to make the request. Example:

/computers

Text

Required

Query Params 

Enter the query parameters to pass to the API

Key Value

Optional

Payload 

Enter the payload to pass to the API

Any

Optional

Extra Fields 

Enter the extra fields to pass to the API

Key Value

Optional