Class: Jamf::OAPISchemas::EnrollmentSettings

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::EnrollmentSettings

Defined in:

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

Overview

OAPI Object Model and Enums for: EnrollmentSettings

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::MdmSigningCertificate
- Jamf::OAPISchemas::CertificateIdentityV1
- Jamf::OAPISchemas::CertificateDetails
- Jamf::OAPISchemas::CertificateDetails

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

- '/v1/enrollment:GET' needs permissions:
  - Read User-Initiated Enrollment
- '/v1/enrollment:PUT' needs permissions:
  - Update User-Initiated Enrollment

Constant Summary

FLUSH_MDM_COMMANDS_ON_REENROLL_OPTIONS =

Enums used by this class or others

[
  'DELETE_NOTHING',
  'DELETE_ERRORS',
  'DELETE_EVERYTHING_EXCEPT_ACKNOWLEDGED',
  'DELETE_EVERYTHING'
]

PASSWORD_TYPE_OPTIONS =

[
  'STATIC',
  'RANDOM'
]

PERSONAL_DEVICE_ENROLLMENT_TYPE_OPTIONS =

[
  'USERENROLLMENT',
  'PERSONALDEVICEPROFILES'
]

OAPI_PROPERTIES =

{

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

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

  # @!attribute mdmSigningCertificate
  #   @return [Jamf::OAPISchemas::MdmSigningCertificate]
  mdmSigningCertificate: {
    class: Jamf::OAPISchemas::MdmSigningCertificate
  },

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

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

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

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

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

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

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

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

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

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

  # @!attribute randomPasswordLength
  #   @return [Integer]
  randomPasswordLength: {
    class: :integer,
    format: 'int32'
  },

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

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

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

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

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

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

  # @!attribute developerCertificateIdentity
  #   @return [Jamf::OAPISchemas::CertificateIdentityV1]
  developerCertificateIdentity: {
    class: Jamf::OAPISchemas::CertificateIdentityV1
  },

  # @!attribute developerCertificateIdentityDetails
  #   @return [Jamf::OAPISchemas::CertificateDetails]
  developerCertificateIdentityDetails: {
    class: Jamf::OAPISchemas::CertificateDetails
  },

  # @!attribute mdmSigningCertificateDetails
  #   @return [Jamf::OAPISchemas::CertificateDetails]
  mdmSigningCertificateDetails: {
    class: Jamf::OAPISchemas::CertificateDetails
  },

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

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

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

}

Instance Attribute Summary

• #developerCertificateIdentity ⇒ Jamf::OAPISchemas::CertificateIdentityV1
• #developerCertificateIdentityDetails ⇒ Jamf::OAPISchemas::CertificateDetails
• #flushMdmCommandsOnReenroll ⇒ String
• #isAllowSshOnlyManagementAccount ⇒ Boolean
• #isCreateManagementAccount ⇒ Boolean
• #isEnabledMacosEnterpriseEnrollment ⇒ Boolean
• #isEnableIosEnterpriseEnrollment ⇒ Boolean
• #isEnableIosPersonalEnrollment ⇒ Boolean
• #isEnsureSshRunning ⇒ Boolean
• #isFlushExtensionAttributes ⇒ Boolean
• #isFlushLocationHistoryInformation ⇒ Boolean
• #isFlushLocationInformation ⇒ Boolean
• #isFlushPolicyHistory ⇒ Boolean
• #isHideManagementAccount ⇒ Boolean
• #isInstallSingleProfile ⇒ Boolean
• #isLaunchSelfService ⇒ Boolean
• #isRestrictReenrollment ⇒ Boolean
• #isSigningMdmProfileEnabled ⇒ Boolean
• #isSignQuickAdd ⇒ Boolean
• #managementPassword ⇒ String
• #managementUsername ⇒ String
• #mdmSigningCertificate ⇒ Jamf::OAPISchemas::MdmSigningCertificate
• #mdmSigningCertificateDetails ⇒ Jamf::OAPISchemas::CertificateDetails
• #passwordType ⇒ String
• #personalDeviceEnrollmentType ⇒ String
• #randomPasswordLength ⇒ Integer

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#developerCertificateIdentity ⇒ Jamf::OAPISchemas::CertificateIdentityV1

Returns:

• (Jamf::OAPISchemas::CertificateIdentityV1)

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

#developerCertificateIdentityDetails ⇒ Jamf::OAPISchemas::CertificateDetails

Returns:

• (Jamf::OAPISchemas::CertificateDetails)

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

#flushMdmCommandsOnReenroll ⇒ String

Returns:

• (String)

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

#isAllowSshOnlyManagementAccount ⇒ Boolean

Returns:

• (Boolean)

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

#isCreateManagementAccount ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings.rb', line 184

#isEnabledMacosEnterpriseEnrollment ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings.rb', line 149

#isEnableIosEnterpriseEnrollment ⇒ Boolean

Returns:

• (Boolean)

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

#isEnableIosPersonalEnrollment ⇒ Boolean

Returns:

• (Boolean)

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

#isEnsureSshRunning ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings.rb', line 202

#isFlushExtensionAttributes ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings.rb', line 135

#isFlushLocationHistoryInformation ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings.rb', line 123

#isFlushLocationInformation ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings.rb', line 117

#isFlushPolicyHistory ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings.rb', line 129

#isHideManagementAccount ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings.rb', line 190

#isInstallSingleProfile ⇒ Boolean

Returns:

• (Boolean)

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

#isLaunchSelfService ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings.rb', line 208

#isRestrictReenrollment ⇒ Boolean

Returns:

• (Boolean)

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

#isSigningMdmProfileEnabled ⇒ Boolean

Returns:

• (Boolean)

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

#isSignQuickAdd ⇒ Boolean

Returns:

• (Boolean)

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

#managementPassword ⇒ String

Returns:

• (String)

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

#managementUsername ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings.rb', line 156

#mdmSigningCertificate ⇒ Jamf::OAPISchemas::MdmSigningCertificate

Returns:

• (Jamf::OAPISchemas::MdmSigningCertificate)

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

#mdmSigningCertificateDetails ⇒ Jamf::OAPISchemas::CertificateDetails

Returns:

• (Jamf::OAPISchemas::CertificateDetails)

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

#passwordType ⇒ String

Returns:

• (String)

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

#personalDeviceEnrollmentType ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings.rb', line 250

#randomPasswordLength ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings.rb', line 177