category: Endpoint provider: Jamf commonfields: id: jamf v2 version: -1 sectionorder: - Connect configuration: - display: Server URL name: url required: true type: 0 additionalinfo: 'Your server URL (e.g., https://yourdomain.jamfcloud.com)' section: Connect - display: Username name: credentials required: false type: 9 section: Connect - display: Client ID name: client_credentials type: 9 required: false displaypassword: Client Secret section: Connect - display: Trust any certificate (not secure) name: insecure type: 8 required: false section: Connect - display: Use system proxy settings name: proxy type: 8 required: false section: Connect description: Enterprise Mobility Management (EMM) for Apple devices (Mac, iPhone, Apple TV, iPad). Can be used to control various configurations via different policies, install and uninstall applications, lock devices, smart groups searches, and more. display: JAMF v2 name: jamf v2 script: commands: - arguments: - defaultValue: '50' description: The maximum number of results to be returned on each page. The maximum size is 200. name: limit - defaultValue: '0' description: The number of the requested page. name: page description: Returns a list of all computers with their associated IDs. By default, returns the first 50 computers to the context (ID + name). name: jamf-get-computers outputs: - contextPath: JAMF.Computer.id description: The computer ID. type: Number - contextPath: JAMF.Computer.name description: The computer name. type: String - contextPath: JAMF.Computer.Paging.total_results description: The number of computers returned in this specific search. type: Number - contextPath: JAMF.Computer.Paging.page_size description: The number of computers returned on each page. type: Number - contextPath: JAMF.Computer.Paging.current_page description: The number of the requested page. type: Number - arguments: - defaultValue: '50' description: The maximum number of results to be returned on each page. The maximum size is 200. name: limit - defaultValue: '0' description: The number of the requested page. name: page description: 'Returns the “basic” subset for all of the computers. The “basic” subset includes: MAC address, model, UDID, name, department, building, serial number, username, ID.' name: jamf-get-computers-basic-subset outputs: - contextPath: JAMF.Computer.id description: The computer ID. type: Number - contextPath: JAMF.Computer.name description: The computer name. type: String - contextPath: JAMF.Computer.managed description: Whether the computer is managed. type: Boolean - contextPath: JAMF.Computer.username description: The computer username. type: String - contextPath: JAMF.Computer.model description: The computer model. type: String - contextPath: JAMF.Computer.mac_address description: The computer MAC address. type: String - contextPath: JAMF.Computer.udid description: The computer UDID. type: String - contextPath: JAMF.Computer.serial_number description: The computer serial number. type: String - arguments: - description: |- The computer ID. To get the computer ID, run the `jamf-get-computers` command to get all computers names and IDs. name: id required: true description: 'Returns the "general" subset of a specific computer, e.g.: name, MAC address, IP, serial number, UDID, etc.' name: jamf-get-computer-by-id outputs: - contextPath: JAMF.Computer.id description: The computer ID. type: Number - contextPath: JAMF.Computer.name description: The computer name. type: String - contextPath: JAMF.Computer.network_adapter_type description: The computer network adapter type. type: String - contextPath: JAMF.Computer.mac_address description: The computer MAC address. type: Date - contextPath: JAMF.Computer.alt_network_adapter_type description: The computer alt network adapter type. type: String - contextPath: JAMF.Computer.alt_mac_address description: The computer alt MAC address. type: String - contextPath: JAMF.Computer.ip_address description: The computer IP address. type: String - contextPath: JAMF.Computer.last_reported_ip description: The computer last reported IP address. type: String - contextPath: JAMF.Computer.serial_number description: The computer serial number. type: String - contextPath: JAMF.Computer.udid description: The computer UDID. type: String - contextPath: JAMF.Computer.jamf_version description: The computer Jamf version. type: String - contextPath: JAMF.Computer.platform description: The computer platform. type: String - contextPath: JAMF.Computer.barcode_1 description: The computer barcode_1. type: String - contextPath: JAMF.Computer.barcode_2 description: The computer barcode_2. type: String - contextPath: JAMF.Computer.asset_tag description: The computer asset tag. type: String - contextPath: JAMF.Computer.remote_management.managed description: Whether the computer is remotely managed. type: Boolean - contextPath: JAMF.Computer.remote_management.management_username description: The computer remote management username. type: String - contextPath: JAMF.Computer.supervised description: Whether the computer is supervised. type: Boolean - contextPath: JAMF.Computer.mdm_capable description: Whether the computer is enabled for mobile device management (MDM). type: Boolean - contextPath: JAMF.Computer.mdm_capable_users description: The computer has MDM capable users. type: Boolean - contextPath: JAMF.Computer.distribution_point description: The computer distribution point. type: String - contextPath: JAMF.Computer.site.id description: The computer site ID. type: Number - contextPath: JAMF.Computer.site.name description: The computer site name. type: String - contextPath: JAMF.Computer.itunes_store_account_is_active description: The computer iTunes store account. type: Boolean - arguments: - defaultValue: '50' description: The maximum number of results to be returned on each page. The maximum size is 200. name: limit - defaultValue: '0' description: The number of the requested page. name: page - description: 'The filter query for the Pro API (supports RSQL). For example, general.name=="Computer 1*", userAndLocation.email=="user@email.com".' name: filter required: true description: Returns general data for computers that match specific characteristics defined by a filter query. name: jamf-get-computer-by-match outputs: - contextPath: JAMF.Computer.id description: The computer ID. type: Number - contextPath: JAMF.Computer.name description: The computer name. type: String - contextPath: JAMF.Computer.udid description: The computer UDID. type: String - contextPath: JAMF.Computer.serial_number description: The computer serial number. type: String - contextPath: JAMF.Computer.mac_address description: The computer MAC address. type: String - contextPath: JAMF.Computer.alt_mac_address description: The computer alt MAC address. type: String - contextPath: JAMF.Computer.asset_tag description: The computer asset tag. type: String - contextPath: JAMF.Computer.barcode_1 description: The computer barcode 1. type: String - contextPath: JAMF.Computer.barcode_2 description: The computer barcode 2. type: String - contextPath: JAMF.Computer.username description: The computer username. type: String - contextPath: JAMF.Computer.realname description: The computer real name. type: String - contextPath: JAMF.Computer.email description: The computer email address. type: String - contextPath: JAMF.Computer.email_address description: The computer email address. type: String - contextPath: JAMF.Computer.room description: The computer room. type: String - contextPath: JAMF.Computer.position description: The computer position. type: String - contextPath: JAMF.Computer.Paging.total_results description: The number of computers returned in this specific search. type: Number - contextPath: JAMF.Computer.Paging.page_size description: The number of computers to be returned on each page. type: Number - contextPath: JAMF.Computer.Paging.current_page description: The number of the requested page. type: Number - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the general subset for a specific computer according to the given arguments. name: jamf-get-computer-general-subset outputs: - contextPath: JAMF.ComputerSubset.Computer.general.id description: The computer ID. type: Number - contextPath: JAMF.ComputerSubset.Computer.general.name description: The computer name. type: String - contextPath: JAMF.ComputerSubset.Computer.general.network_adapter_type description: The computer network adapter type. type: String - contextPath: JAMF.ComputerSubset.Computer.general.mac_address description: The computer MAC address. type: Date - contextPath: JAMF.ComputerSubset.Computer.general.alt_network_adapter_type description: The computer alt network adapter type. type: String - contextPath: JAMF.ComputerSubset.Computer.general.alt_mac_address description: The computer alt MAC address. type: String - contextPath: JAMF.ComputerSubset.Computer.general.ip_address description: The computer IP address. type: String - contextPath: JAMF.ComputerSubset.Computer.general.last_reported_ip description: The computer last reported IP address. type: String - contextPath: JAMF.ComputerSubset.Computer.general.serial_number description: The computer serial number. type: String - contextPath: JAMF.ComputerSubset.Computer.general.udid description: The computer UDID. type: String - contextPath: JAMF.ComputerSubset.Computer.general.jamf_version description: The computer Jamf version. type: String - contextPath: JAMF.ComputerSubset.Computer.general.platform description: The computer platform. type: String - contextPath: JAMF.ComputerSubset.Computer.general.barcode_1 description: The computer barcode 1. type: String - contextPath: JAMF.ComputerSubset.Computer.general.barcode_2 description: The computer barcode 2. type: String - contextPath: JAMF.ComputerSubset.Computer.general.asset_tag description: The computer asset tag. type: String - contextPath: JAMF.ComputerSubset.Computer.general.remote_management.managed description: Whether the computer is remotely managed. type: Boolean - contextPath: JAMF.ComputerSubset.Computer.general.remote_management.management_username description: The computer managment username. type: String - contextPath: JAMF.ComputerSubset.Computer.general.supervised description: Whether the computer is supervised. type: Boolean - contextPath: JAMF.ComputerSubset.Computer.general.mdm_capable description: Whether the computer is MDM capable. type: Boolean - contextPath: JAMF.ComputerSubset.Computer.general.mdm_capable_users description: Whether the computer has MDM capable users. type: Boolean - contextPath: JAMF.ComputerSubset.Computer.general.management_status.user_approved_mdm description: Whether the MDM is user-approved. type: Boolean - contextPath: JAMF.ComputerSubset.Computer.general.distribution_point description: The computer distribution point format. type: String - contextPath: JAMF.ComputerSubset.Computer.general.site.id description: The computer site ID. type: Number - contextPath: JAMF.ComputerSubset.Computer.general.site.name description: The computer site name. type: String - contextPath: JAMF.ComputerSubset.Computer.general.itunes_store_account_is_active description: The computer iTunes store account. type: Boolean - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the location subset for a specific computer according to the given arguments. name: jamf-get-computer-location-subset outputs: - contextPath: JAMF.ComputerSubset.Computer.location.username description: The computer username. type: String - contextPath: JAMF.ComputerSubset.Computer.location.realname description: The computer real name. type: String - contextPath: JAMF.ComputerSubset.Computer.location.real_name description: The computer real name. type: String - contextPath: JAMF.ComputerSubset.Computer.location.email_address description: The computer email address. type: String - contextPath: JAMF.ComputerSubset.Computer.location.position description: The computer position. type: String - contextPath: JAMF.ComputerSubset.Computer.location.phone description: The computer phone number. type: String - contextPath: JAMF.ComputerSubset.Computer.location.phone_number description: The computer phone number. type: String - contextPath: JAMF.ComputerSubset.Computer.location.room description: The computer room. type: String - contextPath: JAMF.ComputerSubset.Computer.id description: The computer ID. type: Number - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the purchasing subset for a specific computer according to the given arguments. name: jamf-get-computer-purchasing-subset outputs: - contextPath: JAMF.ComputerSubset.Computer.purchasing.is_purchased description: If the computer is purchased. type: Boolean - contextPath: JAMF.ComputerSubset.Computer.purchasing.is_leased description: If the computer is leased. type: Boolean - contextPath: JAMF.ComputerSubset.Computer.purchasing.po_number description: The computer PO number. type: String - contextPath: JAMF.ComputerSubset.Computer.purchasing.vendor description: The computer vendor. type: String - contextPath: JAMF.ComputerSubset.Computer.purchasing.applecare_id description: The computer AppleCare ID. type: String - contextPath: JAMF.ComputerSubset.Computer.purchasing.purchase_price description: The computer purchase price. type: String - contextPath: JAMF.ComputerSubset.Computer.purchasing.purchasing_account description: The computer purchase account. type: String - contextPath: JAMF.ComputerSubset.Computer.purchasing.life_expectancy description: The computer life expectancy. type: Number - contextPath: JAMF.ComputerSubset.Computer.purchasing.purchasing_contact description: The computer purchasing contact. type: String - contextPath: JAMF.ComputerSubset.Computer.id description: The computer ID. type: Number - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the peripherals subset for a specific computer according to the given arguments. name: jamf-get-computer-peripherals-subset deprecated: true outputs: - contextPath: JAMF.ComputerSubset.Computer.peripherals description: The computer peripherals. type: Number - contextPath: JAMF.ComputerSubset.Computer.id description: The computer ID. type: Number - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the hardware subset for a specific computer according to the given arguments. name: jamf-get-computer-hardware-subset outputs: - contextPath: JAMF.ComputerSubset.Computer.hardware.make description: The computer maker. type: String - contextPath: JAMF.ComputerSubset.Computer.hardware.model description: The computer model. type: String - contextPath: JAMF.ComputerSubset.Computer.hardware.model_identifier description: The computer model ID. type: String - contextPath: JAMF.ComputerSubset.Computer.hardware.os_name description: The computer operating system name. type: String - contextPath: JAMF.ComputerSubset.Computer.hardware.os_version description: The computer operating system version. type: String - contextPath: JAMF.ComputerSubset.Computer.hardware.os_build description: The computer operating system build. type: String - contextPath: JAMF.ComputerSubset.Computer.hardware.active_directory_status description: The computer active directory status. type: String - contextPath: JAMF.ComputerSubset.Computer.hardware.processor_type description: The computer processor type. type: String - contextPath: JAMF.ComputerSubset.Computer.hardware.processor_architecture description: The computer processor architecture. type: String - contextPath: JAMF.ComputerSubset.Computer.hardware.processor_speed description: The computer processor speed. type: Number - contextPath: JAMF.ComputerSubset.Computer.hardware.processor_speed_mhz description: The computer processor speed in MHz. type: Number - contextPath: JAMF.ComputerSubset.Computer.hardware.number_processors description: The number of processors in the computer. type: Number - contextPath: JAMF.ComputerSubset.Computer.hardware.number_cores description: The number of cores in the computer. type: Number - contextPath: JAMF.ComputerSubset.Computer.hardware.total_ram description: The amount of RAM in the computer. type: Number - contextPath: JAMF.ComputerSubset.Computer.hardware.total_ram_mb description: The amount of RAM in the computer in MB. type: Number - contextPath: JAMF.ComputerSubset.Computer.hardware.boot_rom description: The computer boot ROM. type: String - contextPath: JAMF.ComputerSubset.Computer.hardware.bus_speed description: The computer bus speed. type: Number - contextPath: JAMF.ComputerSubset.Computer.hardware.bus_speed_mhz description: The computer bus speed in MHz. type: Number - contextPath: JAMF.ComputerSubset.Computer.hardware.battery_capacity description: The computer battery capacity. type: Number - contextPath: JAMF.ComputerSubset.Computer.hardware.cache_size description: The computer cache size. type: Number - contextPath: JAMF.ComputerSubset.Computer.hardware.cache_size_kb description: The computer cache size in KB. type: Number - contextPath: JAMF.ComputerSubset.Computer.hardware.available_ram_slots description: The number of available RAM slots. type: Number - contextPath: JAMF.ComputerSubset.Computer.hardware.optical_drive description: The computer optical drive. type: String - contextPath: JAMF.ComputerSubset.Computer.hardware.nic_speed description: The computer NIC speed. type: String - contextPath: JAMF.ComputerSubset.Computer.hardware.smc_version description: The compute SMC version. type: String - contextPath: JAMF.ComputerSubset.Computer.hardware.ble_capable description: Whether the computer is BLE capable. type: Boolean - contextPath: JAMF.ComputerSubset.Computer.hardware.supports_ios_app_installs description: If the computer supports iOS app installations. type: Boolean - contextPath: JAMF.ComputerSubset.Computer.hardware.sip_status description: The computer SIP status. type: String - contextPath: JAMF.ComputerSubset.Computer.hardware.gatekeeper_status description: The computer gatekeeper status. type: String - contextPath: JAMF.ComputerSubset.Computer.hardware.xprotect_version description: The computer xprotect version. type: String - contextPath: JAMF.ComputerSubset.Computer.hardware.disk_encryption_configuration description: The computer disk encryption configuration. type: String - contextPath: JAMF.ComputerSubset.Computer.id description: The computer ID. type: Number - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the certificates subset for a specific computer according to the given arguments. name: jamf-get-computer-certificates-subset outputs: - contextPath: JAMF.ComputerSubset.Computer.certificates.common_name description: The certificat common name. type: String - contextPath: JAMF.ComputerSubset.Computer.certificates.identity description: The certificat identity. type: Boolean - contextPath: JAMF.ComputerSubset.Computer.certificates.expires_utc description: The certificat expiration date in UTC format. type: Date - contextPath: JAMF.ComputerSubset.Computer.certificates.expires_epoch description: The certificat expiration date in epoch format. type: Number - contextPath: JAMF.ComputerSubset.Computer.id description: The computer ID. type: Number - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the security subset for a specific computer according to the given arguments. name: jamf-get-computer-security-subset outputs: - contextPath: JAMF.ComputerSubset.Computer.security.activation_lock description: The computer activation lock. type: Boolean - contextPath: JAMF.ComputerSubset.Computer.security.secure_boot_level description: The computer secure boot level. type: String - contextPath: JAMF.ComputerSubset.Computer.security.external_boot_level description: The computer external boot level. type: String - contextPath: JAMF.ComputerSubset.Computer.id description: The computer ID. type: Number - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the software subset for a specific computer according to the given arguments. name: jamf-get-computer-software-subset outputs: - contextPath: JAMF.ComputerSubset.Computer.software.licensed_software.name description: The computer software's licensed software name. type: String - contextPath: JAMF.ComputerSubset.Computer.software.installed_by_installer_swu description: The computer software that was installed either by an installer, an app or a software update. type: String - contextPath: JAMF.ComputerSubset.Computer.software.available_updates.name description: The name of the available updates. type: String - contextPath: JAMF.ComputerSubset.Computer.software.available_updates.version description: The version of the available update. type: String - contextPath: JAMF.ComputerSubset.Computer.software.running_services.name description: The computer running service name. type: String - contextPath: JAMF.ComputerSubset.Computer.software.applications.name description: The computer application name. type: String - contextPath: JAMF.ComputerSubset.Computer.software.applications.path description: The computer application path. type: String - contextPath: JAMF.ComputerSubset.Computer.software.applications.version description: The computer application version. type: String - contextPath: JAMF.ComputerSubset.Computer.software.applications.bundleId description: The computer application bundle ID. type: String - contextPath: JAMF.ComputerSubset.Computer.id description: The computer ID. type: Number - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the extension attributes subset for a specific computer according to the given arguments. name: jamf-get-computer-extension-attributes-subset outputs: - contextPath: JAMF.ComputerSubset.Computer.extension_attributes.id description: The computer extension attributes ID. type: Number - contextPath: JAMF.ComputerSubset.Computer.extension_attributes.name description: The computer extension attributes name. type: String - contextPath: JAMF.ComputerSubset.Computer.extension_attributes.multi_value description: The computer extension attributes multi value. type: Boolean - contextPath: JAMF.ComputerSubset.Computer.extension_attributes.value description: The computer extension attributes value. type: String - contextPath: JAMF.ComputerSubset.Computer.id description: The computer ID. type: Number - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the groups accounts subset for a specific computer according to the given arguments. name: jamf-get-computer-groups-accounts-subset outputs: - contextPath: JAMF.ComputerSubset.Computer.groups_accounts.computer_group_memberships description: The computer group memberships. type: String - contextPath: JAMF.ComputerSubset.Computer.groups_accounts.local_accounts.uid description: The computer local account UID. type: String - contextPath: JAMF.ComputerSubset.Computer.groups_accounts.local_accounts.homeDirectory description: The computer local account home. type: String - contextPath: JAMF.ComputerSubset.Computer.groups_accounts.local_accounts.admin description: Whether the computer is the local account administrator. type: Boolean - contextPath: JAMF.ComputerSubset.Computer.id description: The computer ID. type: Number - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the iPhones subset for a specific computer according to the given arguments. name: jamf-get-computer-iphones-subset deprecated: true outputs: - contextPath: JAMF.ComputerSubset.Computer.iphones description: The commputer related iPhones. type: String - contextPath: JAMF.ComputerSubset.Computer.id description: The computer ID. type: Number - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the configuration profiles subset for a specific computer according to the given arguments. name: jamf-get-computer-configuration-profiles-subset outputs: - contextPath: JAMF.ComputerSubset.Computer.configuration_profiles.id description: The configuration profile ID. type: Number - contextPath: JAMF.ComputerSubset.Computer.configuration_profiles.removable description: If the configuration profile is removable. type: Boolean - contextPath: JAMF.ComputerSubset.Computer.id description: The computer ID. type: Number - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the specified identifier. For example, if "id" is selected as the identifier, provide the computer ID. If "macaddress" is selected, provide the computer's MAC address. name: identifier_value required: true - auto: PREDEFINED description: The section of the computer to retrieve. name: section predefined: - GENERAL - HARDWARE - OPERATING_SYSTEM - USER_AND_LOCATION - PURCHASING - DISK_ENCRYPTION - SECURITY - SOFTWARE_UPDATES - APPLICATIONS - STORAGE - CONFIGURATION_PROFILES - PRINTERS - SERVICES - LOCAL_USER_ACCOUNTS - CERTIFICATES - ATTACHMENTS - PACKAGE_RECEIPTS - LICENSED_SOFTWARE - IBEACONS - EXTENSION_ATTRIBUTES - CONTENT_CACHING - GROUP_MEMBERSHIPS required: false defaultValue: GENERAL description: Returns the requested section for a specific computer according to the given arguments. name: jamf-get-computer-subset outputs: - contextPath: JAMF.Computer.id description: The computer's ID. type: Number - contextPath: JAMF.Computer.udid description: The computer's UDID. type: String - arguments: - description: A 6-digit passcode to be used to unlock the computer after it was locked. name: passcode required: true secret: true - description: The ID of the computer that you want to lock. name: id required: true - description: A message to display on the locked screen. name: lock_message description: 'Sends the "DeviceLock" command to a computer. This command logs the user out of the computer, restarts the computer, and then locks the computer. Optional: Displays a message on the computer when it locks.' name: jamf-computer-lock outputs: - contextPath: JAMF.ComputerCommand.name description: The command name. type: String - contextPath: JAMF.ComputerCommand.command_uuid description: The command UDID. type: String - contextPath: JAMF.ComputerCommand.computer_id description: The computer ID. type: String compliantpolicies: - EndPoint Isolation - arguments: - description: A 6-digit passcode that locks the computer after being erased. name: passcode required: true secret: true - description: The ID of the computer that you want to erase. name: id required: true description: Deprecated. Sends the “EraseDevice'' command to a computer. Permanently erases all the data on the computer and sets a passcode when required by the computer hardware type. name: jamf-computer-erase outputs: - contextPath: JAMF.ComputerCommand.name description: The command name. type: String - contextPath: JAMF.ComputerCommand.command_uuid description: The command UDID. type: String - contextPath: JAMF.ComputerCommand.computer_id description: The computer ID. type: String deprecated: true - arguments: - defaultValue: '50' description: Maximum number of users to retrieve. The maximal value is 200. name: limit - defaultValue: '0' description: The number of the requested page. name: page description: Returns a list of users with their IDs and names. By default, returns the first 50 users to the context (ID + name). name: jamf-get-users outputs: - contextPath: JAMF.User.id description: The user ID. type: Number - contextPath: JAMF.User.name description: The user name. type: String - contextPath: JAMF.User.Paging.total_results description: The number of users returned in this specific search. type: Number - contextPath: JAMF.User.Paging.page_size description: The number of users to be returned on each page. type: Number - contextPath: JAMF.User.Paging.current_page description: The number of requested page. type: Number - arguments: - description: |- The user ID. To get the user ID, run the `jamf-get-users` command to get all user names and IDs. name: id required: true description: Returns a specific user with general data about the user according to the given ID. name: jamf-get-user-by-id outputs: - contextPath: JAMF.User.id description: The user ID. type: Number - contextPath: JAMF.User.name description: The user name. type: String - contextPath: JAMF.User.full_name description: The user full name. type: String - contextPath: JAMF.User.email description: The user email. type: String - contextPath: JAMF.User.email_address description: The user email address. type: String - contextPath: JAMF.User.phone_number description: The user phone number. type: String - contextPath: JAMF.User.position description: The user position. type: String - contextPath: JAMF.User.managed_apple_id description: The user managed Apple ID. type: String - contextPath: JAMF.User.enable_custom_photo_url description: Whether the user custom photo URL is enabled. type: Boolean - contextPath: JAMF.User.custom_photo_url description: The user custom photo URL. type: String - contextPath: JAMF.User.ldap_server.id description: The user LDAP server ID. type: Number - contextPath: JAMF.User.ldap_server.name description: The user LDAP server name. type: String - contextPath: JAMF.User.extension_attributes.id description: The user extension attributes ID. type: Number - contextPath: JAMF.User.extension_attributes.name description: The user extension attributes name. type: String - contextPath: JAMF.User.extension_attributes.type description: The user extension attributes type. type: String - contextPath: JAMF.User.extension_attributes.value description: The user extension attributes value. type: String - contextPath: JAMF.User.sites.id description: The user's site ID. type: Number - contextPath: JAMF.User.sites.name description: The user's site name. type: String - contextPath: JAMF.User.links.total_vpp_code_count description: The user total VPP code acount. type: Number - contextPath: JAMF.User.links.vpp_assignments.id description: The VPP assignment ID that is linked to the user. type: Number - contextPath: JAMF.User.links.vpp_assignments.name description: The VPP assignment name that is linked to the user. type: String - contextPath: JAMF.User.links.computers.id description: The computer ID that is linked to the user. type: Number - contextPath: JAMF.User.links.computers.name description: The computer name that is linked to the user. type: String - contextPath: JAMF.User.links.peripherals.id description: The peripherals ID that is linked to the user. type: Number - contextPath: JAMF.User.links.peripherals.name description: The peripherals name that is linked to the user. type: String - contextPath: JAMF.User.links.mobile_devices.id description: The mobile device ID that is linked to the user. type: String - contextPath: JAMF.User.links.mobile_devices.name description: The mobile device name that is linked to the user. type: String - contextPath: JAMF.User.user_groups.size description: The user group size. type: Number - contextPath: JAMF.User.user_groups.user_group.id description: The user group ID. type: Number - contextPath: JAMF.User.user_groups.user_group.name description: The user group name. type: String - contextPath: JAMF.User.user_groups.user_group.is_smart description: Whether the user group is smart. type: Boolean - arguments: - description: The user name. name: name required: true description: Returns a specific user with general data about the user according to the given name. name: jamf-get-user-by-name outputs: - contextPath: JAMF.User.id description: The user ID. type: Number - contextPath: JAMF.User.name description: The user name. type: String - contextPath: JAMF.User.full_name description: The user full name. type: String - contextPath: JAMF.User.email description: The user email. type: String - contextPath: JAMF.User.email_address description: The user email address. type: String - contextPath: JAMF.User.phone_number description: The user phone number. type: String - contextPath: JAMF.User.position description: The user position. type: String - contextPath: JAMF.User.managed_apple_id description: The user managed Apple ID. type: String - contextPath: JAMF.User.enable_custom_photo_url description: Whether the user custom photo URL is enabled. type: Boolean - contextPath: JAMF.User.custom_photo_url description: The user custom photo URL. type: String - contextPath: JAMF.User.ldap_server.id description: The user LDAP server ID. type: Number - contextPath: JAMF.User.ldap_server.name description: The user LDAP server name. type: String - contextPath: JAMF.User.extension_attributes.id description: The user extension attributes ID. type: Number - contextPath: JAMF.User.extension_attributes.name description: The user extension attributes name. type: String - contextPath: JAMF.User.extension_attributes.type description: The user extension attributes type. type: String - contextPath: JAMF.User.extension_attributes.value description: The user extension attributes value. type: String - contextPath: JAMF.User.sites.site.id description: The user's site ID. type: Number - contextPath: JAMF.User.sites.site.name description: The user's site name. type: String - contextPath: JAMF.User.links.total_vpp_code_count description: The user total VPP code acount. type: Number - contextPath: JAMF.User.links.vpp_assignments.id description: The VPP assignment ID that is linked to the user. type: Number - contextPath: JAMF.User.links.vpp_assignments.name description: The VPP assignment name that is linked to the user. type: String - contextPath: JAMF.User.links.computers.id description: The computer ID that is linked to the user. type: Number - contextPath: JAMF.User.links.computers.name description: The computer name that is linked to the user. type: String - contextPath: JAMF.User.links.peripherals.id description: The peripherals ID that is linked to the user. type: Number - contextPath: JAMF.User.links.peripherals.name description: The peripherals name that is linked to the user. type: String - contextPath: JAMF.User.links.mobile_devices.id description: The mobile device ID that is linked to the user. type: String - contextPath: JAMF.User.links.mobile_devices.name description: The mobile device name that is linked to the user. type: String - contextPath: JAMF.User.user_groups.size description: The user groups size. type: Number - contextPath: JAMF.User.user_groups.user_group.id description: The user group ID. type: Number - contextPath: JAMF.User.user_groups.user_group.name description: The user group name. type: String - contextPath: JAMF.User.user_groups.user_group.is_smart description: Whether the user group is smart. type: Boolean - arguments: - description: The user email. name: email required: true description: Returns a specific user with general data about the user according to the given email. name: jamf-get-user-by-email outputs: - contextPath: JAMF.User.id description: The user ID. type: Number - contextPath: JAMF.User.name description: The user name. type: String - contextPath: JAMF.User.full_name description: The user full name. type: String - contextPath: JAMF.User.email description: The user email. type: String - contextPath: JAMF.User.email_address description: The user email address. type: String - contextPath: JAMF.User.phone_number description: The user phone number. type: String - contextPath: JAMF.User.position description: The user position. type: String - contextPath: JAMF.User.managed_apple_id description: The user managed Apple ID. type: String - contextPath: JAMF.User.enable_custom_photo_url description: Whether the user custom photo URL is enabled. type: Boolean - contextPath: JAMF.User.custom_photo_url description: The user custom photo URL. type: String - contextPath: JAMF.User.ldap_server.id description: The user LDAP server ID. type: Number - contextPath: JAMF.User.ldap_server.name description: The user LDAP server name. type: String - contextPath: JAMF.User.extension_attributes.id description: The user extension attributes ID. type: Number - contextPath: JAMF.User.extension_attributes.name description: The user extension attributes name. type: String - contextPath: JAMF.User.extension_attributes.type description: The user extension attributes type. type: String - contextPath: JAMF.User.extension_attributes.value description: The user extension attributes value. type: String - contextPath: JAMF.User.sites.site.id description: The user's site ID. type: Number - contextPath: JAMF.User.sites.site.name description: The user's site name. type: String - contextPath: JAMF.User.links.total_vpp_code_count description: The user total VPP code acount. type: Number - contextPath: JAMF.User.links.vpp_assignments.id description: The VPP assignment ID that is linked to the user. type: Number - contextPath: JAMF.User.links.vpp_assignments.name description: The VPP assignment name that is linked to the user. type: String - contextPath: JAMF.User.links.computers.id description: The computer ID that is linked to the user. type: Number - contextPath: JAMF.User.links.computers.name description: The computer name that is linked to the user. type: String - contextPath: JAMF.User.links.peripherals.id description: The peripherals ID that is linked to the user. type: Number - contextPath: JAMF.User.links.peripherals.name description: The peripherals name that is linked to the user. type: String - contextPath: JAMF.User.links.mobile_devices.id description: The mobile device ID that is linked to the user. type: String - contextPath: JAMF.User.links.mobile_devices.name description: The mobile device name that is linked to the user. type: String - contextPath: JAMF.User.user_groups.size description: The user groups size. type: Number - contextPath: JAMF.User.user_groups.user_group.id description: The user group ID. type: Number - contextPath: JAMF.User.user_groups.user_group.name description: The user group name. type: String - contextPath: JAMF.User.user_groups.user_group.is_smart description: If the user group is smart. type: Boolean - arguments: - defaultValue: '50' description: Maximum number of devices to retrieve. Maximal value is 200. name: limit - defaultValue: '0' description: Number of requested page. name: page description: Returns a list of devices with basic data on each. By default, returns the first 50 devices to the context (ID + name). name: jamf-get-mobile-devices outputs: - contextPath: JAMF.MobileDevice.id description: The mobile device ID. type: Number - contextPath: JAMF.MobileDevice.name description: The mobile device name. type: String - contextPath: JAMF.MobileDevice.device_name description: The mobile device name. type: String - contextPath: JAMF.MobileDevice.udid description: The mobile device UDID. type: String - contextPath: JAMF.MobileDevice.serial_number description: The mobile device serial number. type: String - contextPath: JAMF.MobileDevice.phone_number description: The mobile device phone number. type: String - contextPath: JAMF.MobileDevice.wifi_mac_address description: The mobile device WIFI MAC address. type: String - contextPath: JAMF.MobileDevice.managed description: Whether the mobile device is managed. type: Boolean - contextPath: JAMF.MobileDevice.supervised description: Whether the mobile device is supervised. type: Boolean - contextPath: JAMF.MobileDevice.model description: The mobile device model. type: String - contextPath: JAMF.MobileDevice.model_identifier description: The mobile device model ID. type: String - contextPath: JAMF.MobileDevice.modelDisplay description: The mobile device model display. type: String - contextPath: JAMF.MobileDevice.model_display description: The mobile device model display. type: String - contextPath: JAMF.MobileDevice.username description: The mobile device username. type: String - contextPath: JAMF.MobileDevice.Paging.total_results description: The number of mobile devices returned in this specific search. type: Number - contextPath: JAMF.MobileDevice.Paging.page_size description: The number of mobile devices to be returned on each page. type: Number - contextPath: JAMF.MobileDevice.Paging.current_page description: The number of the requested page. type: Number - arguments: - description: |- Gets the “general” subset of a specific device. To get the mobile device ID, run the `jamf-get-mobile-devices` command to get all mobile devices names and IDs. name: id required: true description: 'Returns the "general" subset of a specific mobile device, e.g.: name, MAC address, IP, serial number, UDID. etc.' name: jamf-get-mobile-device-by-id outputs: - contextPath: JAMF.MobileDevice.id description: The mobile device ID. type: Number - contextPath: JAMF.MobileDevice.display_name description: The mobile device display name. type: String - contextPath: JAMF.MobileDevice.device_name description: The mobile device name. type: String - contextPath: JAMF.MobileDevice.name description: The mobile device name. type: String - contextPath: JAMF.MobileDevice.asset_tag description: The mobile device asset ID. type: String - contextPath: JAMF.MobileDevice.last_inventory_update description: The date of the mobile device last inventory update. type: String - contextPath: JAMF.MobileDevice.last_inventory_update_epoch description: The date of the mobile device last inventory update in epoch format. type: Date - contextPath: JAMF.MobileDevice.last_inventory_update_utc description: The date of the mobile device last inventory update in UTC format. type: Date - contextPath: JAMF.MobileDevice.capacity description: The mobile device capacity. type: Number - contextPath: JAMF.MobileDevice.capacity_mb description: The mobile device capacity in MB. type: Number - contextPath: JAMF.MobileDevice.available description: The mobile device available storage. type: Number - contextPath: JAMF.MobileDevice.available_mb description: The mobile device available storage in MB. type: Number - contextPath: JAMF.MobileDevice.percentage_used description: The percentage of memory used. type: Number - contextPath: JAMF.MobileDevice.os_type description: The mobile device operating system type. type: String - contextPath: JAMF.MobileDevice.os_version description: The mobile device operating system version. type: String - contextPath: JAMF.MobileDevice.os_build description: The mobile device operating system build. type: String - contextPath: JAMF.MobileDevice.serial_number description: The mobile device serial number. type: String - contextPath: JAMF.MobileDevice.udid description: The mobile device UDID. type: String - contextPath: JAMF.MobileDevice.initial_entry_date_epoch description: The mobile device initial entry date in epoch format. type: Date - contextPath: JAMF.MobileDevice.initial_entry_date_utc description: The mobile device initial entry date in UTC format. type: Date - contextPath: JAMF.MobileDevice.phone_number description: The mobile device phone number. type: String - contextPath: JAMF.MobileDevice.ip_address description: The mobile device IP address. type: String - contextPath: JAMF.MobileDevice.wifi_mac_address description: The mobile device WIFI MAC address. type: String - contextPath: JAMF.MobileDevice.bluetooth_mac_address description: The mobile device bluetooth MAC address. type: String - contextPath: JAMF.MobileDevice.modem_firmware description: The mobile device modem fireware. type: String - contextPath: JAMF.MobileDevice.model description: The mobile device model. type: String - contextPath: JAMF.MobileDevice.model_identifier description: The mobile device model ID. type: String - contextPath: JAMF.MobileDevice.model_number description: The mobile device model number. type: String - contextPath: JAMF.MobileDevice.modelDisplay description: The mobile device model display. type: String - contextPath: JAMF.MobileDevice.model_display description: The mobile device model display. type: String - contextPath: JAMF.MobileDevice.device_ownership_level description: The mobile device ownership level. type: String - contextPath: JAMF.MobileDevice.enrollment_method description: The mobile device enrollment method. type: String - contextPath: JAMF.MobileDevice.last_enrollment_epoch description: The mobile device last enrollment in epoch. type: Number - contextPath: JAMF.MobileDevice.last_enrollment_utc description: The mobile device last enrollment in UTC format. type: String - contextPath: JAMF.MobileDevice.mdm_profile_expiration_epoch description: The mobile device MDM profile expiration in epoch format. type: Number - contextPath: JAMF.MobileDevice.mdm_profile_expiration_utc description: The mobile device MDM profile expiration in UTC format. type: String - contextPath: JAMF.MobileDevice.managed description: Whether the mobile device is managed. type: Boolean - contextPath: JAMF.MobileDevice.supervised description: Whether the mobile device is supervised. type: Boolean - contextPath: JAMF.MobileDevice.exchange_activesync_device_identifier description: The mobile device exchange active sync device ID. type: String - contextPath: JAMF.MobileDevice.shared description: Whether the device is shared. type: String - contextPath: JAMF.MobileDevice.diagnostic_submission description: The mobile device diagnostic submission. type: String - contextPath: JAMF.MobileDevice.app_analytics description: The mobile device app analytics. type: String - contextPath: JAMF.MobileDevice.tethered description: The mobile device tethered status. type: String - contextPath: JAMF.MobileDevice.battery_level description: The mobile device battery level. type: Number - contextPath: JAMF.MobileDevice.ble_capable description: Whether the mobile device is BLE capable. type: Boolean - contextPath: JAMF.MobileDevice.device_locator_service_enabled description: Whether the mobile device locator service is enabled. type: Boolean - contextPath: JAMF.MobileDevice.do_not_disturb_enabled description: Whether the mobile device do not disturb is enabled. type: Boolean - contextPath: JAMF.MobileDevice.cloud_backup_enabled description: Whether the mobile device cloud backup is enabled. type: Boolean - contextPath: JAMF.MobileDevice.last_cloud_backup_date_epoch description: The mobile device last cloud update backup date in epoch format. type: Date - contextPath: JAMF.MobileDevice.last_cloud_backup_date_utc description: The mobile device last cloud update backup date in UTC format. type: Date - contextPath: JAMF.MobileDevice.location_services_enabled description: Whether the mobile device location services is enabled. type: Boolean - contextPath: JAMF.MobileDevice.itunes_store_account_is_active description: Whether the mobile device iTunes store account is enabled. type: Boolean - contextPath: JAMF.MobileDevice.last_backup_time_epoch description: The mobile device last backup time in epoch format. type: Number - contextPath: JAMF.MobileDevice.last_backup_time_utc description: The mobile device last backup time in UTC format. type: String - contextPath: JAMF.MobileDevice.site.id description: The mobile device site ID. type: Number - contextPath: JAMF.MobileDevice.site.name description: The mobile device site name. type: String - arguments: - description: 'The specific characteristics by which to match devices such as: name, udid, serial_number, mac_address, username, email. e.g: “match=john*”, “match=C52F72FACB9T”. (Supports wildcards).' name: match predefined: - '' required: true - defaultValue: '50' description: Maximum number of devices to retrieve. (Maximal value is 200). name: limit - defaultValue: '0' description: The number of the requested page. name: page description: Matches mobile devices by specific characteristics and returns general data on each one of the mobile devices. name: jamf-get-mobile-device-by-match outputs: - contextPath: JAMF.MobileDevice.id description: The mobile device ID. type: Number - contextPath: JAMF.MobileDevice.name description: The mobile device name. type: String - contextPath: JAMF.MobileDevice.udid description: The mobile device UDID. type: String - contextPath: JAMF.MobileDevice.serial_number description: The mobile device serial number. type: String - contextPath: JAMF.MobileDevice.mac_address description: The mobile device MAC address. type: String - contextPath: JAMF.MobileDevice.wifi_mac_address description: The mobile device WIFI MAC address. type: String - contextPath: JAMF.MobileDevice.username description: The mobile device username. type: String - contextPath: JAMF.MobileDevice.realname description: The mobile device real name. type: String - contextPath: JAMF.MobileDevice.email description: The mobile device user email address. type: String - contextPath: JAMF.MobileDevice.email_address description: The mobile device user email address. type: String - contextPath: JAMF.MobileDevice.room description: The mobile device room. type: String - contextPath: JAMF.MobileDevice.position description: The mobile device position. type: String - contextPath: JAMF.MobileDevice.building description: The mobile device building. type: String - contextPath: JAMF.MobileDevice.building_name description: The mobile device building name. type: String - contextPath: JAMF.MobileDevice.department description: The mobile device department. type: String - contextPath: JAMF.MobileDevice.department_name description: The mobile device department name. type: String - contextPath: JAMF.MobileDevice.Paging.total_results description: The number of mobile devices returned in this specific search. type: Number - contextPath: JAMF.MobileDevice.Paging.page_size description: The number of mobile devices to be returned on each page. type: Number - contextPath: JAMF.MobileDevice.Paging.current_page description: The number of the requested page. type: Number - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the general subset for a specific mobile device according to the given arguments. name: jamf-get-mobile-device-general-subset outputs: - contextPath: JAMF.MobileDeviceSubset.id description: The mobile device ID. type: String - contextPath: JAMF.MobileDeviceSubset.general.id description: The mobile device ID. type: Number - contextPath: JAMF.MobileDeviceSubset.general.display_name description: The mobile device display name. type: String - contextPath: JAMF.MobileDeviceSubset.general.device_name description: The mobile device name. type: String - contextPath: JAMF.MobileDeviceSubset.general.name description: The mobile device name. type: String - contextPath: JAMF.MobileDeviceSubset.general.asset_tag description: The mobile device asset ID. type: String - contextPath: JAMF.MobileDeviceSubset.general.last_inventory_update description: The date of the mobile device last inventory update. type: String - contextPath: JAMF.MobileDeviceSubset.general.last_inventory_update_epoch description: The date of the mobile device last inventory update in epoch format. type: Date - contextPath: JAMF.MobileDeviceSubset.general.last_inventory_update_utc description: The date of the mobile device last inventory update in UTC format. type: Date - contextPath: JAMF.MobileDeviceSubset.general.capacity description: The mobile device capacity. type: Number - contextPath: JAMF.MobileDeviceSubset.general.capacity_mb description: The mobile device capacity in MB. type: Number - contextPath: JAMF.MobileDeviceSubset.general.available description: The available memory in the mobile device. type: Number - contextPath: JAMF.MobileDeviceSubset.general.available_mb description: The available memory in the mobile device in MB. type: Number - contextPath: JAMF.MobileDeviceSubset.general.percentage_used description: The percentage of memory used in the mobile device. type: Number - contextPath: JAMF.MobileDeviceSubset.general.os_type description: The mobile device operating system type. type: String - contextPath: JAMF.MobileDeviceSubset.general.os_version description: The mobile device operating system version. type: String - contextPath: JAMF.MobileDeviceSubset.general.os_build description: The mobile device operating system build. type: String - contextPath: JAMF.MobileDeviceSubset.general.serial_number description: The mobile device serial number. type: String - contextPath: JAMF.MobileDeviceSubset.general.udid description: The mobile device UDID. type: String - contextPath: JAMF.MobileDeviceSubset.general.initial_entry_date_epoch description: The mobile device initial entry date in epoch format. type: Date - contextPath: JAMF.MobileDeviceSubset.general.initial_entry_date_utc description: The mobile device initial entry date in UTC format. type: Date - contextPath: JAMF.MobileDeviceSubset.general.phone_number description: The mobile device phone number. type: String - contextPath: JAMF.MobileDeviceSubset.general.ip_address description: The mobile device IP address. type: String - contextPath: JAMF.MobileDeviceSubset.general.wifi_mac_address description: The mobile device WIFI MAC address. type: String - contextPath: JAMF.MobileDeviceSubset.general.bluetooth_mac_address description: The mobile device bluetooth MAC address. type: String - contextPath: JAMF.MobileDeviceSubset.general.modem_firmware description: The mobile device modem fireware. type: String - contextPath: JAMF.MobileDeviceSubset.general.model description: The mobile device model. type: String - contextPath: JAMF.MobileDeviceSubset.general.model_identifier description: The mobile device model ID. type: String - contextPath: JAMF.MobileDeviceSubset.general.model_number description: The mobile device model number. type: String - contextPath: JAMF.MobileDeviceSubset.general.modelDisplay description: The mobile device model display. type: String - contextPath: JAMF.MobileDeviceSubset.general.model_display description: The mobile device model display. type: String - contextPath: JAMF.MobileDeviceSubset.general.device_ownership_level description: The mobile device ownership level. type: String - contextPath: JAMF.MobileDeviceSubset.general.enrollment_method description: The mobile device enrollment method. type: String - contextPath: JAMF.MobileDeviceSubset.general.last_enrollment_epoch description: The mobile device last enrollment in epoch format. type: Number - contextPath: JAMF.MobileDeviceSubset.general.last_enrollment_utc description: The mobile device last enrollment in UTC format. type: String - contextPath: JAMF.MobileDeviceSubset.general.mdm_profile_expiration_epoch description: The mobile device MDM profile expiration in epoch format. type: Number - contextPath: JAMF.MobileDeviceSubset.general.mdm_profile_expiration_utc description: The mobile device MDM profile expiration in UTC format. type: String - contextPath: JAMF.MobileDeviceSubset.general.managed description: Whether the mobile device is managed. type: Boolean - contextPath: JAMF.MobileDeviceSubset.general.supervised description: Whether the mobile device is supervised. type: Boolean - contextPath: JAMF.MobileDeviceSubset.general.exchange_activesync_device_identifier description: The mobile device exchange active sync device ID. type: String - contextPath: JAMF.MobileDeviceSubset.general.shared description: Whether the device is shared. type: String - contextPath: JAMF.MobileDeviceSubset.general.diagnostic_submission description: The mobile device diagnostic submission. type: String - contextPath: JAMF.MobileDeviceSubset.general.app_analytics description: The mobile device app analytics. type: String - contextPath: JAMF.MobileDeviceSubset.general.tethered description: The mobile device tethered status. type: String - contextPath: JAMF.MobileDeviceSubset.general.battery_level description: The mobile device battery level. type: Number - contextPath: JAMF.MobileDeviceSubset.general.ble_capable description: Whether the mobile device is BLE capable. type: Boolean - contextPath: JAMF.MobileDeviceSubset.general.device_locator_service_enabled description: Whether the mobile device locator service is enabled. type: Boolean - contextPath: JAMF.MobileDeviceSubset.general.do_not_disturb_enabled description: Whether the mobile device do not disturb is enabled. type: Boolean - contextPath: JAMF.MobileDeviceSubset.general.cloud_backup_enabled description: Whether the mobile device cloud backup is enabled. type: Boolean - contextPath: JAMF.MobileDeviceSubset.general.last_cloud_backup_date_epoch description: The mobie device last cloud update backup date in epoch format. type: Date - contextPath: JAMF.MobileDeviceSubset.general.last_cloud_backup_date_utc description: The mobie device last cloud update backup date in UTC format. type: Date - contextPath: JAMF.MobileDeviceSubset.general.location_services_enabled description: Whether the mobile device location services is enabled. type: Boolean - contextPath: JAMF.MobileDeviceSubset.general.itunes_store_account_is_active description: Whether the mobile device iTunes store account is enabled. type: Boolean - contextPath: JAMF.MobileDeviceSubset.general.last_backup_time_epoch description: The mobile device last backup time in epoch format. type: Number - contextPath: JAMF.MobileDeviceSubset.general.last_backup_time_utc description: The mobile device last backup time in UTC format. type: String - contextPath: JAMF.MobileDeviceSubset.general.site.id description: The mobile device site ID. type: Number - contextPath: JAMF.MobileDeviceSubset.general.site.name description: The mobile device site name. type: String - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the location subset for a specific mobile device according to the given arguments. name: jamf-get-mobile-device-location-subset outputs: - contextPath: JAMF.MobileDeviceSubset.id description: The mobile device ID. type: String - contextPath: JAMF.MobileDeviceSubset.location.username description: The mobile device username. type: String - contextPath: JAMF.MobileDeviceSubset.location.realname description: The mobile device real name. type: String - contextPath: JAMF.MobileDeviceSubset.location.real_name description: The mobile device real name. type: String - contextPath: JAMF.MobileDeviceSubset.location.email_address description: The mobile device email address. type: String - contextPath: JAMF.MobileDeviceSubset.location.position description: The mobile device position. type: String - contextPath: JAMF.MobileDeviceSubset.location.phone description: The mobile device phone number. type: String - contextPath: JAMF.MobileDeviceSubset.location.phone_number description: The mobile device phone number. type: String - contextPath: JAMF.MobileDeviceSubset.location.department description: The mobile device department. type: String - contextPath: JAMF.MobileDeviceSubset.location.building description: The mobile device building. type: String - contextPath: JAMF.MobileDeviceSubset.location.room description: The mobile device room. type: String - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the purchasing subset for a specific mobile device according to the given arguments. name: jamf-get-mobile-device-purchasing-subset outputs: - contextPath: JAMF.MobileDeviceSubset.id description: The mobile device ID. type: String - contextPath: JAMF.MobileDeviceSubset.purchasing.is_purchased description: Whether the mobile device is purchased. type: Boolean - contextPath: JAMF.MobileDeviceSubset.purchasing.is_leased description: Whether the mobile device is leased. type: Boolean - contextPath: JAMF.MobileDeviceSubset.purchasing.po_number description: The mobile device PO number. type: String - contextPath: JAMF.MobileDeviceSubset.purchasing.vendor description: The mobile device vendor. type: String - contextPath: JAMF.MobileDeviceSubset.purchasing.applecare_id description: The mobile device AppleCare ID. type: String - contextPath: JAMF.MobileDeviceSubset.purchasing.purchase_price description: The mobile device purchase price. type: String - contextPath: JAMF.MobileDeviceSubset.purchasing.purchasing_account description: The mobile device purchase account. type: String - contextPath: JAMF.MobileDeviceSubset.purchasing.po_date description: The mobile device purchase PO date. type: String - contextPath: JAMF.MobileDeviceSubset.purchasing.po_date_epoch description: The mobile device purchase PO date in epoch format. type: Number - contextPath: JAMF.MobileDeviceSubset.purchasing.po_date_utc description: The mobile device purchase PO date in UTC format. type: String - contextPath: JAMF.MobileDeviceSubset.purchasing.warranty_expires description: The mobile device warranty expiration date. type: String - contextPath: JAMF.MobileDeviceSubset.purchasing.warranty_expires_epoch description: The mobile device warranty expiration date in epoch format. type: Number - contextPath: JAMF.MobileDeviceSubset.purchasing.warranty_expires_utc description: The mobile device warranty expiration date in UTC format. type: String - contextPath: JAMF.MobileDeviceSubset.purchasing.lease_expires description: The mobile device lease expiration date. type: String - contextPath: JAMF.MobileDeviceSubset.purchasing.lease_expires_epoch description: The mobile device lease expiration date in epoch format. type: Number - contextPath: JAMF.MobileDeviceSubset.purchasing.lease_expires_utc description: The mobile device lease expiration date in UTC format. type: String - contextPath: JAMF.MobileDeviceSubset.purchasing.life_expectancy description: The mobile device life expectancy. type: Number - contextPath: JAMF.MobileDeviceSubset.purchasing.purchasing_contact description: The mobile device purchasing contact. type: String - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the applications subset for a specific mobile device according to the given arguments. name: jamf-get-mobile-device-applications-subset outputs: - contextPath: JAMF.MobileDeviceSubset.id description: The mobile device ID. type: String - contextPath: JAMF.MobileDeviceSubset.applications.application_name description: The mobile device application name. type: String - contextPath: JAMF.MobileDeviceSubset.applications.application_version description: The mobile device application version. type: String - contextPath: JAMF.MobileDeviceSubset.applications.application_short_version description: The mobile device application short version. type: String - contextPath: JAMF.MobileDeviceSubset.applications.identifier description: The mobile device application ID. type: String - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the security subset for a specific mobile device according to the given arguments. name: jamf-get-mobile-device-security-subset outputs: - contextPath: JAMF.MobileDeviceSubset.id description: The mobile device ID. type: String - contextPath: JAMF.MobileDeviceSubset.security.data_protection description: If the mobile device has data protection. type: Boolean - contextPath: JAMF.MobileDeviceSubset.security.block_level_encryption_capable description: If the mobile device is block level encryption capable. type: Boolean - contextPath: JAMF.MobileDeviceSubset.security.file_level_encryption_capable description: If the mobile device is file level encryption capable. type: Boolean - contextPath: JAMF.MobileDeviceSubset.security.passcode_present description: Whether the mobile device has a passcode present. type: Boolean - contextPath: JAMF.MobileDeviceSubset.security.passcode_compliant description: Whether the mobile device is passcode compliant. type: Boolean - contextPath: JAMF.MobileDeviceSubset.security.passcode_compliant_with_profile description: Whether the mobile device is passcode compliant with profile. type: Boolean - contextPath: JAMF.MobileDeviceSubset.security.passcode_lock_grace_period_enforced description: The mobile device passcode lock grace period enforced. type: String - contextPath: JAMF.MobileDeviceSubset.security.hardware_encryption description: The mobile device hardware encryption. type: Number - contextPath: JAMF.MobileDeviceSubset.security.activation_lock_enabled description: Whether the mobile device has activation lock enabled. type: Boolean - contextPath: JAMF.MobileDeviceSubset.security.jailbreak_detected description: The mobile device security jailbreak detected. type: String - contextPath: JAMF.MobileDeviceSubset.security.lost_mode_enabled description: The mobile device lost mode. type: String - contextPath: JAMF.MobileDeviceSubset.security.lost_mode_enforced description: Whether the mobile device has lost mode enforced. type: Boolean - contextPath: JAMF.MobileDeviceSubset.security.lost_mode_enable_issued_epoch description: The mobile device lost mode enable issued date in epoch. type: Date - contextPath: JAMF.MobileDeviceSubset.security.lost_mode_enable_issued_utc description: The mobile device lost mode enable issued date in UTC format. type: Date - contextPath: JAMF.MobileDeviceSubset.security.lost_mode_message description: The mobile device lost mode message. type: String - contextPath: JAMF.MobileDeviceSubset.security.lost_mode_phone description: The mobile device lost mode phone. type: String - contextPath: JAMF.MobileDeviceSubset.security.lost_mode_footnote description: The mobile device lost mode footnote. type: String - contextPath: JAMF.MobileDeviceSubset.security.lost_location_epoch description: The mobile device lost location date in epoch format. type: Date - contextPath: JAMF.MobileDeviceSubset.security.lost_location_utc description: The mobile device lost location date in UTC format. type: Date - contextPath: JAMF.MobileDeviceSubset.security.lost_location_latitude description: The mobile device security lost location latitude. type: Number - contextPath: JAMF.MobileDeviceSubset.security.lost_location_longitude description: The mobile device security lost location longitude. type: Number - contextPath: JAMF.MobileDeviceSubset.security.lost_location_altitude description: The mobile device security lost location altitude. type: Number - contextPath: JAMF.MobileDeviceSubset.security.lost_location_speed description: The mobile device security lost location speed. type: Number - contextPath: JAMF.MobileDeviceSubset.security.lost_location_course description: The mobile device security lost location course. type: Number - contextPath: JAMF.MobileDeviceSubset.security.lost_location_horizontal_accuracy description: The mobile device security lost location horizontal accuracy. type: Number - contextPath: JAMF.MobileDeviceSubset.security.lost_location_vertical_accuracy description: The mobile device security lost location vertical accuracy. type: Number - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the network subset for a specific mobile device according to the given arguments. name: jamf-get-mobile-device-network-subset outputs: - contextPath: JAMF.MobileDeviceSubset.id description: The mobile device ID. type: String - contextPath: JAMF.MobileDeviceSubset.network.home_carrier_network description: The mobile device home carrier network. type: String - contextPath: JAMF.MobileDeviceSubset.network.cellular_technology description: The mobile device cellular technology. type: String - contextPath: JAMF.MobileDeviceSubset.network.voice_roaming_enabled description: The mobile device voice roaming enabled. type: String - contextPath: JAMF.MobileDeviceSubset.network.imei description: The mobile device network IMEI. type: String - contextPath: JAMF.MobileDeviceSubset.network.iccid description: The mobile device network ICCID. type: String - contextPath: JAMF.MobileDeviceSubset.network.meid description: The mobile device network MEID. type: String - contextPath: JAMF.MobileDeviceSubset.network.current_carrier_network description: The mobile device current carrier network. type: String - contextPath: JAMF.MobileDeviceSubset.network.carrier_settings_version description: The mobile device network carrier settings version. type: String - contextPath: JAMF.MobileDeviceSubset.network.current_mobile_country_code description: The mobile device current mobile country code. type: String - contextPath: JAMF.MobileDeviceSubset.network.current_mobile_network_code description: The mobile device current mobile network code. type: String - contextPath: JAMF.MobileDeviceSubset.network.home_mobile_country_code description: The mobile device home mobile country code. type: String - contextPath: JAMF.MobileDeviceSubset.network.home_mobile_network_code description: The mobile device home mobile network code. type: String - contextPath: JAMF.MobileDeviceSubset.network.data_roaming_enabled description: Whether the mobile device has data roaming enabled. type: Boolean - contextPath: JAMF.MobileDeviceSubset.network.roaming description: Whether the mobile device has network roaming. type: Boolean - contextPath: JAMF.MobileDeviceSubset.network.phone_number description: The mobile device network phone number. type: String - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the certificates subset for a specific mobile device according to the given arguments. name: jamf-get-mobile-device-certificates-subset outputs: - contextPath: JAMF.MobileDeviceSubset.id description: The mobile device ID. type: String - contextPath: JAMF.MobileDeviceSubset.certificates.size description: The mobile device certificates size. type: String - contextPath: JAMF.MobileDeviceSubset.certificates.certificate.common_name description: The mobile device certificate common name. type: String - contextPath: JAMF.MobileDeviceSubset.certificates.certificate.identity description: Whether this is an identity certificate. type: Boolean - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the provisioning profiles subset for a specific mobile device according to the given arguments. name: jamf-get-mobile-device-provisioning-profiles-subset outputs: - contextPath: JAMF.MobileDeviceSubset.id description: The mobile device ID. type: String - contextPath: JAMF.MobileDeviceSubset.provisioning_profiles.size description: The mobile device provisioning profiles size. type: Number - contextPath: JAMF.MobileDeviceSubset.provisioning_profiles.mobile_device_provisioning_profile.display_name description: The mobile device provisioning profiles display name. type: String - contextPath: JAMF.MobileDeviceSubset.provisioning_profiles.mobile_device_provisioning_profile.expiration_date description: The mobile device provisioning profiles expiration date. type: String - contextPath: JAMF.MobileDeviceSubset.provisioning_profiles.mobile_device_provisioning_profile.expiration_date_epoch description: The mobile device provisioning profiles expiration date in epoch format. type: Number - contextPath: JAMF.MobileDeviceSubset.provisioning_profiles.mobile_device_provisioning_profile.expiration_date_utc description: The mobile device provisioning profiles expiration date in UTC format. type: String - contextPath: JAMF.MobileDeviceSubset.provisioning_profiles.mobile_device_provisioning_profile.uuid description: The mobile device provisioning profiles UUID. type: String - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the configuration profiles subset for a specific mobile device according to the given arguments. name: jamf-get-mobile-device-configuration-profiles-subset outputs: - contextPath: JAMF.MobileDeviceSubset.id description: The mobile device ID. type: String - contextPath: JAMF.MobileDeviceSubset.configuration_profiles.size description: The mobile device configuration profiles size. type: Number - contextPath: JAMF.MobileDeviceSubset.configuration_profiles.configuration_profile.display_name description: The mobile device configuration profiles display name. type: String - contextPath: JAMF.MobileDeviceSubset.configuration_profiles.configuration_profile.version description: The mobile device configuration profiles version. type: String - contextPath: JAMF.MobileDeviceSubset.configuration_profiles.configuration_profile.identifier description: The mobile device configuration profiles identifier. type: Number - contextPath: JAMF.MobileDeviceSubset.configuration_profiles.configuration_profile.uuid description: The mobile device configuration profiles UUID. type: String - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the mobile device groups subset for a specific mobile device according to the given arguments. name: jamf-get-mobile-device-groups-subset outputs: - contextPath: JAMF.MobileDeviceSubset.id description: The mobile device ID. type: String - contextPath: JAMF.MobileDeviceSubset.mobile_device_groups.id description: The mobile device group ID. type: Number - contextPath: JAMF.MobileDeviceSubset.mobile_device_groups.name description: The mobile device group name. type: String - arguments: - auto: PREDEFINED description: 'The identifier used to determine which computer is requested. Possible values: "id", "name", "udid", "serialnumber", and "macaddress".' name: identifier predefined: - id - name - udid - serialnumber - macaddress required: true - description: The value of the "identifier". For example, if you choose the "id" identifier, a computer ID should be passed. If you choose "macaddress" as the identifier, a computer’s MAC address should be passed, etc. name: identifier_value required: true description: Returns the extension attributes subset for a specific mobile device according to the given arguments. name: jamf-get-mobile-device-extension-attributes-subset outputs: - contextPath: JAMF.MobileDeviceSubset.id description: The mobile device ID. type: String - contextPath: JAMF.MobileDeviceSubset.extension_attributes.id description: The mobile device extension attribute ID. type: Number - contextPath: JAMF.MobileDeviceSubset.extension_attributes.name description: The mobile device extension attribute name. type: String - contextPath: JAMF.MobileDeviceSubset.extension_attributes.type description: The mobile device extension attribute type. type: String - contextPath: JAMF.MobileDeviceSubset.extension_attributes.multi_value description: The mobile device extension attribute multi value. type: Boolean - contextPath: JAMF.MobileDeviceSubset.extension_attributes.value description: The mobile device extension attribute value. type: String - arguments: - description: The application’s name (supports wildcards). name: application required: true - description: The application’s version (supports wildcards). Applicable only when “application” parameter value is set. name: version - defaultValue: '50' description: Maximum number of devices to retrieve. (Maximal value is 200). name: limit - defaultValue: '0' description: The number of the requested page. name: page description: Returns a list of computers with basic information on each. name: jamf-get-computers-by-application outputs: - contextPath: JAMF.ComputersByApp.Computer.id description: The computer ID. type: Number - contextPath: JAMF.ComputersByApp.Computer.name description: The computer name. type: String - contextPath: JAMF.ComputersByApp.Computer.udid description: The computer UDID. type: String - contextPath: JAMF.ComputersByApp.Computer.serial_number description: The computer serial number. type: String - contextPath: JAMF.ComputersByApp.Computer.mac_address description: The computer MAC address. type: String - contextPath: JAMF.ComputersByApp.Application description: The application the user serched for. type: String - contextPath: JAMF.ComputersByApp.Paging.total_results description: The number of computers returned in this specific search. type: Number - contextPath: JAMF.ComputersByApp.Paging.page_size description: The number of computers to be returned on each page. type: Number - contextPath: JAMF.ComputersByApp.Paging.current_page description: The number of the requested page. type: Number - arguments: - description: The mobile device’s ID. name: id required: true - description: A message that is displayed on the device’s lock screen. name: lost_mode_message description: |- This is a beta command - couldn't be tested due to technical limitations. Enables “lost mode” on a specific device. Lost Mode is a feature that allows you to lock a mobile device and track the device's location. The device reports the GPS coordinates of the point where the device received the command. This feature adds additional protection to mobile devices and their data in the event that a device is lost or stolen. name: jamf-mobile-device-lost-mode outputs: - contextPath: JAMF.MobileDeviceCommands.name description: The mobile device command name. type: String - contextPath: JAMF.MobileDeviceCommands.status description: The mobile device command status. type: String - contextPath: JAMF.MobileDeviceCommands.management_id description: The mobile device command management ID. type: String - contextPath: JAMF.MobileDeviceCommands.id description: The mobile device command ID. type: String - arguments: - description: The device’s ID. name: id required: true - auto: PREDEFINED defaultValue: 'False' description: Whether to retain cellular data plans (iOS 11 or later). name: preserve_data_plan predefined: - 'True' - 'False' - auto: PREDEFINED defaultValue: 'False' description: Whether to clear activation lock on the device. name: clear_activation_code predefined: - 'True' - 'False' description: |- This is a beta command - couldn't be tested due to technical limitations. Permanently erases all data on the device and deactivates the device. name: jamf-mobile-device-erase outputs: - contextPath: JAMF.MobileDeviceCommands.name description: The mobile device command name. type: String - contextPath: JAMF.MobileDeviceCommands.status description: The mobile device command status. type: String - contextPath: JAMF.MobileDeviceCommands.management_id description: The mobile device command managment ID. type: String - contextPath: JAMF.MobileDeviceCommands.id description: The mobile device command ID. type: String - arguments: - description: The endpoint ID. isArray: true name: id - default: true description: The endpoint IP address. isArray: true name: ip - description: The endpoint hostname. isArray: true name: hostname description: Returns information about an endpoint. name: endpoint outputs: - contextPath: Endpoint.Hostname description: The endpoint's hostname. type: String - contextPath: Endpoint.OS description: The endpoint's operating system. type: String - contextPath: Endpoint.IPAddress description: The endpoint's IP address. type: String - contextPath: Endpoint.ID description: The endpoint's ID. type: String - contextPath: Endpoint.Status description: The endpoint's status. type: String - contextPath: Endpoint.IsIsolated description: The endpoint's isolation status. type: String - contextPath: Endpoint.MACAddress description: The endpoint's MAC address. type: String - contextPath: Endpoint.Vendor description: The integration name of the endpoint vendor. type: String - arguments: - description: The ID of the mobile device. name: id required: true name: jamf-get-mobile-configuration-profiles-by-id description: Returns the configuration profiles subset for a specific mobile device according to the given arguments. outputs: - contextPath: JAMF.Mobile.ProfileConfiguration.general.id description: The ID of the configuration profile. type: Number - contextPath: JAMF.Mobile.ProfileConfiguration.general.name description: The name of the configuration profile. type: String - contextPath: JAMF.Mobile.ProfileConfiguration.general.description description: The mobile device configuration description. type: String - contextPath: JAMF.Mobile.ProfileConfiguration.general.level description: Level of the configuration profile (System or User). type: String - contextPath: JAMF.Mobile.ProfileConfiguration.general.site description: Site of the configuration profile. type: String - contextPath: JAMF.Mobile.ProfileConfiguration.general.category description: Category of the configuration profile. type: String - contextPath: JAMF.Mobile.ProfileConfiguration.general.uuid description: Unique identifier of the mobile profile configuration. type: String - contextPath: JAMF.Mobile.ProfileConfiguration.general.deployment_method description: Install Automatically or Make Available in Self Service. type: String - contextPath: JAMF.Mobile.ProfileConfiguration.general.payloads description: Payloads of the configuration profile for Mobile device. type: String - contextPath: JAMF.Mobile.ProfileConfiguration.scope description: Scope object of the configuration profile. type: String - contextPath: JAMF.Mobile.ProfileConfiguration.self_service description: Self-service object of the configuration profile. type: String - arguments: - description: The ID of the mobile device. name: id required: true name: jamf-get-computer-configuration-profiles-by-id description: Returns the configuration profiles subset for a specific mobile device according to the given arguments. outputs: - contextPath: JAMF.OSX.ProfileConfiguration.general.id description: The ID of the configuration profile. type: Number - contextPath: JAMF.OSX.ProfileConfiguration.general.name description: The name of the configuration profile. type: String - contextPath: JAMF.OSX.ProfileConfiguration.general.description description: The mobile device configuration description. - contextPath: JAMF.OSX.ProfileConfiguration.general.level description: Level of the configuration profile (System or User). type: String - contextPath: JAMF.OSX.ProfileConfiguration.general.site description: Site of the configuration profile. type: String - contextPath: JAMF.OSX.ProfileConfiguration.general.category description: Category of the configuration profile. type: String - contextPath: JAMF.OSX.ProfileConfiguration.general.uuid description: Unique identifier of the mobile profile configuration. type: String - contextPath: JAMF.OSX.ProfileConfiguration.general.distribution_method description: Install Automatically or Make Available in Self Service. type: String - contextPath: JAMF.OSX.ProfileConfiguration.general.payloads description: Payloads of the configuration profile for OSX device. type: String - contextPath: JAMF.OSX.ProfileConfiguration.scope description: Scope object of the configuration profile. type: String - contextPath: JAMF.OSX.ProfileConfiguration.self_service description: Self-service object of the configuration profile. type: String dockerimage: demisto/btfl-soup:1.0.1.10120494 runonce: false script: '-' subtype: python3 type: python tests: - Jamf_v2_test fromversion: 5.5.0