Class: Jamf::OAPISchemas::EnrollmentCustomizationV2

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::EnrollmentCustomizationV2

Defined in:

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

Overview

OAPI Object Model and Enums for: EnrollmentCustomizationV2

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.

- Jamf::OAPISchemas::EnrollmentCustomizationSearchResultsV2

Sub Objects: Other object models used by this model’s attributes.

- Jamf::OAPISchemas::EnrollmentCustomizationBrandingSettings

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

- '/v2/enrollment-customizations:POST' needs permissions:
  - Create Enrollment Customizations
- '/v2/enrollment-customizations/{id}:GET' needs permissions:
  - Read Enrollment Customizations
- '/v2/enrollment-customizations/{id}:PUT' needs permissions:
  - Update Enrollment Customizations

Constant Summary

OAPI_PROPERTIES =

{

  # @!attribute [r] id
  #   @return [String]
  id: {
    class: :j_id,
    identifier: :primary,
    readonly: true
  },

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

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

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

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

}

Instance Attribute Summary

• #description ⇒ String
• #displayName ⇒ String
• #enrollmentCustomizationBrandingSettings ⇒ Jamf::OAPISchemas::EnrollmentCustomizationBrandingSettings
• #id ⇒ String readonly
• #siteId ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#description ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_customization_v2.rb', line 96

#displayName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_customization_v2.rb', line 89

#enrollmentCustomizationBrandingSettings ⇒ Jamf::OAPISchemas::EnrollmentCustomizationBrandingSettings

Returns:

• (Jamf::OAPISchemas::EnrollmentCustomizationBrandingSettings)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_customization_v2.rb', line 103

#id ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_customization_v2.rb', line 74

#siteId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_customization_v2.rb', line 82