Class: Jamf::OAPISchemas::DeviceEnrollmentPrestage

Inherits:
Jamf::OAPIObject show all
Defined in:
lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage.rb

Overview

OAPI Object Model and Enums for: DeviceEnrollmentPrestage

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::LocationInformation
- Jamf::OAPISchemas::PrestagePurchasingInformation

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

Constant Summary collapse

OAPI_PROPERTIES =
{

  # @!attribute displayName
  #   @return [String]
  displayName: {
    class: :string,
    required: true
  },

  # @!attribute isMandatory
  #   @return [Boolean]
  isMandatory: {
    class: :boolean,
    required: true
  },

  # @!attribute isMdmRemovable
  #   @return [Boolean]
  isMdmRemovable: {
    class: :boolean,
    required: true
  },

  # @!attribute supportPhoneNumber
  #   @return [String]
  supportPhoneNumber: {
    class: :string,
    required: true
  },

  # @!attribute supportEmailAddress
  #   @return [String]
  supportEmailAddress: {
    class: :string,
    required: true
  },

  # @!attribute department
  #   @return [String]
  department: {
    class: :string,
    required: true
  },

  # @!attribute isDefaultPrestage
  #   @return [Boolean]
  isDefaultPrestage: {
    class: :boolean,
    required: true
  },

  # @!attribute enrollmentSiteId
  #   @return [Integer]
  enrollmentSiteId: {
    class: :integer,
    required: true
  },

  # @!attribute isKeepExistingSiteMembership
  #   @return [Boolean]
  isKeepExistingSiteMembership: {
    class: :boolean,
    required: true
  },

  # @!attribute isKeepExistingLocationInformation
  #   @return [Boolean]
  isKeepExistingLocationInformation: {
    class: :boolean,
    required: true
  },

  # @!attribute isRequireAuthentication
  #   @return [Boolean]
  isRequireAuthentication: {
    class: :boolean,
    required: true
  },

  # @!attribute authenticationPrompt
  #   @return [String]
  authenticationPrompt: {
    class: :string,
    required: true
  },

  # @!attribute isPreventActivationLock
  #   @return [Boolean]
  isPreventActivationLock: {
    class: :boolean,
    required: true
  },

  # @!attribute isEnableDeviceBasedActivationLock
  #   @return [Boolean]
  isEnableDeviceBasedActivationLock: {
    class: :boolean,
    required: true
  },

  # @!attribute deviceEnrollmentProgramInstanceId
  #   @return [Integer]
  deviceEnrollmentProgramInstanceId: {
    class: :integer,
    required: true
  },

  # @!attribute skipSetupItems
  #   @return [Hash{Symbol: Boolean }]
  skipSetupItems: {
    class: :hash
  },

  # @!attribute locationInformation
  #   @return [Jamf::OAPISchemas::LocationInformation]
  locationInformation: {
    class: Jamf::OAPISchemas::LocationInformation,
    required: true
  },

  # @!attribute purchasingInformation
  #   @return [Jamf::OAPISchemas::PrestagePurchasingInformation]
  purchasingInformation: {
    class: Jamf::OAPISchemas::PrestagePurchasingInformation,
    required: true
  },

  # The Base64 encoded PEM Certificate
  # @!attribute anchorCertificates
  #   @return [Array<String>]
  anchorCertificates: {
    class: :string,
    multi: true
  },

  # @!attribute enrollmentCustomizationId
  #   @return [Integer]
  enrollmentCustomizationId: {
    class: :integer
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#anchorCertificatesArray<String>

Returns:



# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage.rb', line 195

#authenticationPromptString

Returns:



# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage.rb', line 147

#departmentString

Returns:



# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage.rb', line 105

#deviceEnrollmentProgramInstanceIdInteger

Returns:

  • (Integer)


# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage.rb', line 168

#displayNameString

Returns:



# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage.rb', line 70

#enrollmentCustomizationIdInteger

Returns:

  • (Integer)


# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage.rb', line 203

#enrollmentSiteIdInteger

Returns:

  • (Integer)


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

#isDefaultPrestageBoolean

Returns:

  • (Boolean)


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

#isEnableDeviceBasedActivationLockBoolean

Returns:

  • (Boolean)


# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage.rb', line 161

#isKeepExistingLocationInformationBoolean

Returns:

  • (Boolean)


# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage.rb', line 133

#isKeepExistingSiteMembershipBoolean

Returns:

  • (Boolean)


# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage.rb', line 126

#isMandatoryBoolean

Returns:

  • (Boolean)


# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage.rb', line 77

#isMdmRemovableBoolean

Returns:

  • (Boolean)


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

#isPreventActivationLockBoolean

Returns:

  • (Boolean)


# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage.rb', line 154

#isRequireAuthenticationBoolean

Returns:

  • (Boolean)


# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage.rb', line 140

#locationInformationJamf::OAPISchemas::LocationInformation



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

#purchasingInformationJamf::OAPISchemas::PrestagePurchasingInformation



# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage.rb', line 188

#skipSetupItemsHash{Symbol: Boolean }

Returns:

  • (Hash{Symbol: Boolean })


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

#supportEmailAddressString

Returns:



# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage.rb', line 98

#supportPhoneNumberString

Returns:



# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage.rb', line 91