Class: Jamf::OAPISchemas::DeviceComplianceInformation

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::DeviceComplianceInformation

Defined in:

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

Overview

OAPI Object Model and Enums for: DeviceComplianceInformation

Description of this class from the OAPI Schema:

Device compliance information record

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::ComplianceVendorDeviceInformation

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

- '/v1/conditional-access/device-compliance-information/computer/{deviceId}:GET' needs permissions:
  - Read Device Compliance Information
- '/v1/conditional-access/device-compliance-information/mobile/{deviceId}:GET' needs permissions:
  - Read Device Compliance Information

Constant Summary

COMPLIANCE_STATE_OPTIONS =

Enums used by this class or others

[
  'UNKNOWN',
  'NON_COMPLIANT',
  'COMPLIANT'
]

OAPI_PROPERTIES =

{

  # ID of the device
  # @!attribute deviceId
  #   @return [String]
  deviceId: {
    class: :string
  },

  # If device is applicable for compliance calculation
  # @!attribute applicable
  #   @return [Boolean]
  applicable: {
    class: :boolean
  },

  # Device compliance state. Possible values are:
  # * `UNKNOWN` for unknow compliance state, this usually means that the compliance state is being calculated,
  # * `NON_COMPLIANT` for non compliant state,
  # * `COMPLIANT` for compliant state
  # @!attribute complianceState
  #   @return [String]
  complianceState: {
    class: :string,
    enum: COMPLIANCE_STATE_OPTIONS
  },

  # Name of the compliance vendor
  # @!attribute complianceVendor
  #   @return [String]
  complianceVendor: {
    class: :string
  },

  # @!attribute complianceVendorDeviceInformation
  #   @return [Jamf::OAPISchemas::ComplianceVendorDeviceInformation]
  complianceVendorDeviceInformation: {
    class: Jamf::OAPISchemas::ComplianceVendorDeviceInformation
  }

}

Instance Attribute Summary

• #applicable ⇒ Boolean
• #complianceState ⇒ String
• #complianceVendor ⇒ String
• #complianceVendorDeviceInformation ⇒ Jamf::OAPISchemas::ComplianceVendorDeviceInformation
• #deviceId ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#applicable ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_compliance_information.rb', line 86

#complianceState ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_compliance_information.rb', line 93

#complianceVendor ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_compliance_information.rb', line 104

#complianceVendorDeviceInformation ⇒ Jamf::OAPISchemas::ComplianceVendorDeviceInformation

Returns:

• (Jamf::OAPISchemas::ComplianceVendorDeviceInformation)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_compliance_information.rb', line 111

#deviceId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_compliance_information.rb', line 79