Class: Jamf::OAPISchemas::DeviceEnrollmentPrestageV2

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::DeviceEnrollmentPrestageV2

Defined in:

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

Overview

OAPI Object Model and Enums for: DeviceEnrollmentPrestageV2

This class was automatically genereated from the api/schema URL path on a Jamf Pro server version 10.36.1-t1645562643

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::LocationInformationV2
- Jamf::OAPISchemas::PrestagePurchasingInformationV2

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

Constant Summary

OAPI_PROPERTIES =

{

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

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

  # @!attribute mdmRemovable
  #   @return [Boolean]
  mdmRemovable: {
    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 defaultPrestage
  #   @return [Boolean]
  defaultPrestage: {
    class: :boolean,
    required: true
  },

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

}

Instance Attribute Summary

• #anchorCertificates ⇒ Array<String>
• #authenticationPrompt ⇒ String
• #autoAdvanceSetup ⇒ Boolean
• #defaultPrestage ⇒ Boolean
• #department ⇒ String
• #deviceEnrollmentProgramInstanceId ⇒ String
• #displayName ⇒ String
• #enableDeviceBasedActivationLock ⇒ Boolean
• #enrollmentCustomizationId ⇒ String
• #enrollmentSiteId ⇒ String
• #keepExistingLocationInformation ⇒ Boolean
• #keepExistingSiteMembership ⇒ Boolean
• #language ⇒ String
• #locationInformation ⇒ Jamf::OAPISchemas::LocationInformationV2
• #mandatory ⇒ Boolean
• #mdmRemovable ⇒ Boolean
• #preventActivationLock ⇒ Boolean
• #purchasingInformation ⇒ Jamf::OAPISchemas::PrestagePurchasingInformationV2
• #region ⇒ String
• #requireAuthentication ⇒ Boolean
• #skipSetupItems ⇒ Hash{Symbol: Boolean }
• #supportEmailAddress ⇒ String
• #supportPhoneNumber ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#anchorCertificates ⇒ Array<String>

Returns:

• (Array<String>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 196

#authenticationPrompt ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 148

#autoAdvanceSetup ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 222

#defaultPrestage ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 113

#department ⇒ String

Returns:

• (String)

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

#deviceEnrollmentProgramInstanceId ⇒ String

Returns:

• (String)

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

#displayName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 71

#enableDeviceBasedActivationLock ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 162

#enrollmentCustomizationId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 204

#enrollmentSiteId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 120

#keepExistingLocationInformation ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 134

#keepExistingSiteMembership ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 127

#language ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 210

#locationInformation ⇒ Jamf::OAPISchemas::LocationInformationV2

Returns:

• (Jamf::OAPISchemas::LocationInformationV2)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 182

#mandatory ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 78

#mdmRemovable ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 85

#preventActivationLock ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 155

#purchasingInformation ⇒ Jamf::OAPISchemas::PrestagePurchasingInformationV2

Returns:

• (Jamf::OAPISchemas::PrestagePurchasingInformationV2)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 189

#region ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 216

#requireAuthentication ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 141

#skipSetupItems ⇒ Hash{Symbol: Boolean }

Returns:

• (Hash{Symbol: Boolean })

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_prestage_v2.rb', line 176

#supportEmailAddress ⇒ String

Returns:

• (String)

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

#supportPhoneNumber ⇒ String

Returns:

• (String)

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