Class: Jamf::OAPISchemas::MobileDeviceDetailsV2

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::MobileDeviceDetailsV2

Defined in:

lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb

Overview

OAPI Object Model and Enums for: MobileDeviceDetailsV2

This class was automatically generated from the api/schema URL path on a Jamf Pro server version 11.6.1-t1718634702

This class may be used directly, e.g instances of other classes may use instances of this class as one of their own properties/attributes.

It may also be used as a superclass when implementing Jamf Pro API Resources in ruby-jss. The subclasses include appropriate mixins, and should expand on the basic functionality provided here.

Container Objects: Other object models that use this model as the value in one of their attributes.

Sub Objects: Other object models used by this model’s attributes.

- Jamf::OAPISchemas::V1Site
- Jamf::OAPISchemas::ExtensionAttributeV2
- Jamf::OAPISchemas::LocationV2
- Jamf::OAPISchemas::DetailsV2
- Jamf::OAPISchemas::TvOsDetails
- Jamf::OAPISchemas::WatchOsDetailsV2
- Jamf::OAPISchemas::DetailsV2

Endpoints and Privileges: API endpoints and HTTP operations that use this object model, and the Jamf Pro privileges needed to access them.

- '/v2/mobile-devices/{id}:PATCH' needs permissions:
  - Update Mobile Devices

Constant Summary

TYPE_OPTIONS =

Enums used by this class or others

[
  'ios',
  'tvos',
  'watchos',
  'visionos',
  'unknown'
]

OAPI_PROPERTIES =

{

  # @!attribute [r] id
  #   @return [String]
  id: {
    class: :j_id,
    identifier: :primary,
    readonly: true
  },

  # Mobile device name.
  # @!attribute name
  #   @return [String]
  name: {
    class: :string
  },

  # Enforce the mobile device name. Device must be supervised. If set to true, Jamf Pro will revert the Mobile Device Name to the ���name��� value each time the device checks in.
  # @!attribute enforceName
  #   @return [Boolean]
  enforceName: {
    class: :boolean
  },

  # @!attribute assetTag
  #   @return [String]
  assetTag: {
    class: :string
  },

  # @!attribute lastInventoryUpdateTimestamp
  #   @return [Jamf::Timestamp]
  lastInventoryUpdateTimestamp: {
    class: Jamf::Timestamp,
    format: 'date-time'
  },

  # @!attribute osVersion
  #   @return [String]
  osVersion: {
    class: :string
  },

  # @!attribute osBuild
  #   @return [String]
  osBuild: {
    class: :string
  },

  # Collected for iOS 16 and iPadOS 16.1 or later
  # @!attribute osSupplementalBuildVersion
  #   @return [String]
  osSupplementalBuildVersion: {
    class: :string
  },

  # Collected for iOS 16 and iPadOS 16.1 or later
  # @!attribute osRapidSecurityResponse
  #   @return [String]
  osRapidSecurityResponse: {
    class: :string
  },

  # @!attribute softwareUpdateDeviceId
  #   @return [String]
  softwareUpdateDeviceId: {
    class: :string
  },

  # @!attribute serialNumber
  #   @return [String]
  serialNumber: {
    class: :string
  },

  # @!attribute udid
  #   @return [String]
  udid: {
    class: :string
  },

  # @!attribute ipAddress
  #   @return [String]
  ipAddress: {
    class: :string
  },

  # @!attribute wifiMacAddress
  #   @return [String]
  wifiMacAddress: {
    class: :string
  },

  # @!attribute bluetoothMacAddress
  #   @return [String]
  bluetoothMacAddress: {
    class: :string
  },

  # @!attribute managed
  #   @return [Boolean]
  managed: {
    class: :boolean
  },

  # @!attribute timeZone
  #   @return [String]
  timeZone: {
    class: :string
  },

  # @!attribute initialEntryTimestamp
  #   @return [Jamf::Timestamp]
  initialEntryTimestamp: {
    class: Jamf::Timestamp,
    format: 'date-time'
  },

  # @!attribute lastEnrollmentTimestamp
  #   @return [Jamf::Timestamp]
  lastEnrollmentTimestamp: {
    class: Jamf::Timestamp,
    format: 'date-time'
  },

  # @!attribute mdmProfileExpirationTimestamp
  #   @return [Jamf::Timestamp]
  mdmProfileExpirationTimestamp: {
    class: Jamf::Timestamp,
    format: 'date-time'
  },

  # @!attribute deviceOwnershipLevel
  #   @return [String]
  deviceOwnershipLevel: {
    class: :string
  },

  # @!attribute enrollmentMethod
  #   @return [String]
  enrollmentMethod: {
    class: :string
  },

  # @!attribute enrollmentSessionTokenValid
  #   @return [Boolean]
  enrollmentSessionTokenValid: {
    class: :boolean
  },

  # @!attribute declarativeDeviceManagementEnabled
  #   @return [Boolean]
  declarativeDeviceManagementEnabled: {
    class: :boolean
  },

  # @!attribute site
  #   @return [Jamf::OAPISchemas::V1Site]
  site: {
    class: Jamf::OAPISchemas::V1Site
  },

  # @!attribute extensionAttributes
  #   @return [Array<Jamf::OAPISchemas::ExtensionAttributeV2>]
  extensionAttributes: {
    class: Jamf::OAPISchemas::ExtensionAttributeV2,
    multi: true
  },

  # @!attribute location
  #   @return [Jamf::OAPISchemas::LocationV2]
  location: {
    class: Jamf::OAPISchemas::LocationV2
  },

  # Based on the value of this either iOS, tvOS, watch or visionOS objects will be populated.
  # @!attribute type
  #   @return [String]
  type: {
    class: :string,
    enum: TYPE_OPTIONS
  },

  # @!attribute ios
  #   @return [Jamf::OAPISchemas::DetailsV2]
  ios: {
    class: Jamf::OAPISchemas::DetailsV2
  },

  # @!attribute tvos
  #   @return [Jamf::OAPISchemas::TvOsDetails]
  tvos: {
    class: Jamf::OAPISchemas::TvOsDetails
  },

  # @!attribute watchos
  #   @return [Jamf::OAPISchemas::WatchOsDetailsV2]
  watchos: {
    class: Jamf::OAPISchemas::WatchOsDetailsV2
  },

  # @!attribute visionos
  #   @return [Jamf::OAPISchemas::DetailsV2]
  visionos: {
    class: Jamf::OAPISchemas::DetailsV2
  }

}

Instance Attribute Summary

• #assetTag ⇒ String
• #bluetoothMacAddress ⇒ String
• #declarativeDeviceManagementEnabled ⇒ Boolean
• #deviceOwnershipLevel ⇒ String
• #enforceName ⇒ Boolean
• #enrollmentMethod ⇒ String
• #enrollmentSessionTokenValid ⇒ Boolean
• #extensionAttributes ⇒ Array<Jamf::OAPISchemas::ExtensionAttributeV2>
• #id ⇒ String readonly
• #initialEntryTimestamp ⇒ Jamf::Timestamp
• #ios ⇒ Jamf::OAPISchemas::DetailsV2
• #ipAddress ⇒ String
• #lastEnrollmentTimestamp ⇒ Jamf::Timestamp
• #lastInventoryUpdateTimestamp ⇒ Jamf::Timestamp
• #location ⇒ Jamf::OAPISchemas::LocationV2
• #managed ⇒ Boolean
• #mdmProfileExpirationTimestamp ⇒ Jamf::Timestamp
• #name ⇒ String
• #osBuild ⇒ String
• #osRapidSecurityResponse ⇒ String
• #osSupplementalBuildVersion ⇒ String
• #osVersion ⇒ String
• #serialNumber ⇒ String
• #site ⇒ Jamf::OAPISchemas::V1Site
• #softwareUpdateDeviceId ⇒ String
• #timeZone ⇒ String
• #tvos ⇒ Jamf::OAPISchemas::TvOsDetails
• #type ⇒ String
• #udid ⇒ String
• #visionos ⇒ Jamf::OAPISchemas::DetailsV2
• #watchos ⇒ Jamf::OAPISchemas::WatchOsDetailsV2
• #wifiMacAddress ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#assetTag ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 106

#bluetoothMacAddress ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 175

#declarativeDeviceManagementEnabled ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 232

#deviceOwnershipLevel ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 214

#enforceName ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 99

#enrollmentMethod ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 220

#enrollmentSessionTokenValid ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 226

#extensionAttributes ⇒ Array<Jamf::OAPISchemas::ExtensionAttributeV2>

Returns:

• (Array<Jamf::OAPISchemas::ExtensionAttributeV2>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 244

#id ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 84

#initialEntryTimestamp ⇒ Jamf::Timestamp

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 193

#ios ⇒ Jamf::OAPISchemas::DetailsV2

Returns:

• (Jamf::OAPISchemas::DetailsV2)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 265

#ipAddress ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 163

#lastEnrollmentTimestamp ⇒ Jamf::Timestamp

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 200

#lastInventoryUpdateTimestamp ⇒ Jamf::Timestamp

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 112

#location ⇒ Jamf::OAPISchemas::LocationV2

Returns:

• (Jamf::OAPISchemas::LocationV2)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 251

#managed ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 181

#mdmProfileExpirationTimestamp ⇒ Jamf::Timestamp

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 207

#name ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 92

#osBuild ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 125

#osRapidSecurityResponse ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 138

#osSupplementalBuildVersion ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 131

#osVersion ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 119

#serialNumber ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 151

#site ⇒ Jamf::OAPISchemas::V1Site

Returns:

• (Jamf::OAPISchemas::V1Site)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 238

#softwareUpdateDeviceId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 145

#timeZone ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 187

#tvos ⇒ Jamf::OAPISchemas::TvOsDetails

Returns:

• (Jamf::OAPISchemas::TvOsDetails)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 271

#type ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 257

#udid ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 157

#visionos ⇒ Jamf::OAPISchemas::DetailsV2

Returns:

• (Jamf::OAPISchemas::DetailsV2)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 283

#watchos ⇒ Jamf::OAPISchemas::WatchOsDetailsV2

Returns:

• (Jamf::OAPISchemas::WatchOsDetailsV2)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 277

#wifiMacAddress ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/mobile_device_details_v2.rb', line 169