Class: Jamf::OAPISchemas::EnrollmentSettingsV2

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::EnrollmentSettingsV2

Defined in:

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

Overview

OAPI Object Model and Enums for: EnrollmentSettingsV2

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::CertificateIdentityV2
- Jamf::OAPISchemas::CertificateIdentityV2
- 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.

- '/v2/enrollment:GET' needs permissions:
  - Read User-Initiated Enrollment
- '/v2/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 installSingleProfile
  #   @return [Boolean]
  installSingleProfile: {
    class: :boolean
  },

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

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

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

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

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

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

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

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

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

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

  # managementPassword is no longer in use. Input value for managementPassword will be ignored.
  # @!attribute managementPassword
  #   @return [String]
  managementPassword: {
    class: :string,
    format: 'password',
    writeonly: true
  },

  # managementPasswordSet is no longer in use. Input value for managementPasswordSet will be ignored.
  # @!attribute [r] managementPasswordSet
  #   @return [Boolean]
  managementPasswordSet: {
    class: :boolean,
    readonly: true
  },

  # passwordType is no longer in use. Input value for passwordType will be ignored.
  # @!attribute passwordType
  #   @return [String]
  passwordType: {
    class: :string,
    enum: PASSWORD_TYPE_OPTIONS
  },

  # randomPasswordLength is no longer in use. Input value for randomPasswordLength will be ignored.
  # @!attribute randomPasswordLength
  #   @return [Integer]
  randomPasswordLength: {
    class: :integer,
    format: 'int32'
  },

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

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

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

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

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

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

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

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

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

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

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

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

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

}

Instance Attribute Summary

• #accountDrivenUserEnrollmentEnabled ⇒ Boolean
• #allowSshOnlyManagementAccount ⇒ Boolean
• #createManagementAccount ⇒ Boolean
• #developerCertificateIdentity ⇒ Jamf::OAPISchemas::CertificateIdentityV2
• #developerCertificateIdentityDetails ⇒ Jamf::OAPISchemas::CertificateDetails
• #ensureSshRunning ⇒ Boolean
• #flushExtensionAttributes ⇒ Boolean
• #flushLocationHistoryInformation ⇒ Boolean
• #flushLocationInformation ⇒ Boolean
• #flushMdmCommandsOnReenroll ⇒ String
• #flushPolicyHistory ⇒ Boolean
• #hideManagementAccount ⇒ Boolean
• #installSingleProfile ⇒ Boolean
• #iosEnterpriseEnrollmentEnabled ⇒ Boolean
• #iosPersonalEnrollmentEnabled ⇒ Boolean
• #launchSelfService ⇒ Boolean
• #macOsEnterpriseEnrollmentEnabled ⇒ Boolean
• #managementPassword ⇒ String
• #managementPasswordSet ⇒ Boolean readonly
• #managementUsername ⇒ String
• #mdmSigningCertificate ⇒ Jamf::OAPISchemas::CertificateIdentityV2
• #mdmSigningCertificateDetails ⇒ Jamf::OAPISchemas::CertificateDetails
• #passwordType ⇒ String
• #personalDeviceEnrollmentType ⇒ String
• #randomPasswordLength ⇒ Integer
• #restrictReenrollment ⇒ Boolean
• #signingMdmProfileEnabled ⇒ Boolean
• #signQuickAdd ⇒ Boolean

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#accountDrivenUserEnrollmentEnabled ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 266

#allowSshOnlyManagementAccount ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 205

#createManagementAccount ⇒ Boolean

Returns:

• (Boolean)

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

#developerCertificateIdentity ⇒ Jamf::OAPISchemas::CertificateIdentityV2

Returns:

• (Jamf::OAPISchemas::CertificateIdentityV2)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 229

#developerCertificateIdentityDetails ⇒ Jamf::OAPISchemas::CertificateDetails

Returns:

• (Jamf::OAPISchemas::CertificateDetails)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 235

#ensureSshRunning ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 211

#flushExtensionAttributes ⇒ Boolean

Returns:

• (Boolean)

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

#flushLocationHistoryInformation ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 122

#flushLocationInformation ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 116

#flushMdmCommandsOnReenroll ⇒ String

Returns:

• (String)

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

#flushPolicyHistory ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 128

#hideManagementAccount ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 199

#installSingleProfile ⇒ Boolean

Returns:

• (Boolean)

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

#iosEnterpriseEnrollmentEnabled ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 247

#iosPersonalEnrollmentEnabled ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 253

#launchSelfService ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 217

#macOsEnterpriseEnrollmentEnabled ⇒ Boolean

Returns:

• (Boolean)

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

#managementPassword ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 160

#managementPasswordSet ⇒ Boolean (readonly)

Returns:

• (Boolean)

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

#managementUsername ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 153

#mdmSigningCertificate ⇒ Jamf::OAPISchemas::CertificateIdentityV2

Returns:

• (Jamf::OAPISchemas::CertificateIdentityV2)

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

#mdmSigningCertificateDetails ⇒ Jamf::OAPISchemas::CertificateDetails

Returns:

• (Jamf::OAPISchemas::CertificateDetails)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 241

#passwordType ⇒ String

Returns:

• (String)

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

#personalDeviceEnrollmentType ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 259

#randomPasswordLength ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 185

#restrictReenrollment ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 110

#signingMdmProfileEnabled ⇒ Boolean

Returns:

• (Boolean)

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

#signQuickAdd ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_settings_v2.rb', line 223