Class: Jamf::OAPISchemas::OnboardingItem

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

Overview

OAPI Object Model and Enums for: OnboardingItem

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::OnboardingConfiguration

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

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

SELF_SERVICE_ENTITY_TYPE_OPTIONS =

Enums used by this class or others

[
  'OS_X_POLICY',
  'OS_X_CONFIG_PROFILE',
  'OS_X_MAC_APP',
  'OS_X_APP_INSTALLER',
  'OS_X_EBOOK',
  'OS_X_PATCH_POLICY',
  'UNKNOWN'
]
OAPI_PROPERTIES = 
{

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

  # The id of the Jamf Pro object that should be added to the onboarding workflow for end users.
  # Use this in conjunction with the selfServiceEntityType. For example, if the policy with id 132
  # should be added to onboarding, then entityId should be 132 and selfServiceEntityType should be 
  # OS_X_POLICY.
  # @!attribute entityId
  #   @return [String]
  entityId: {
    class: :string,
    required: true
  },

  # @!attribute [r] entityName
  #   @return [String]
  entityName: {
    class: :string,
    readonly: true
  },

  # @!attribute [r] scopeDescription
  #   @return [String]
  scopeDescription: {
    class: :string,
    readonly: true
  },

  # @!attribute [r] siteDescription
  #   @return [String]
  siteDescription: {
    class: :string,
    readonly: true
  },

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

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

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#entityId ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/onboarding_item.rb', line 87

#entityName ⇒ String (readonly)

Returns:




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

#id ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/onboarding_item.rb', line 79

#priority ⇒ Integer

Returns:

  • (Integer) 



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

#scopeDescription ⇒ String (readonly)

Returns:




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

#selfServiceEntityType ⇒ String

Returns:




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

#siteDescription ⇒ String (readonly)

Returns:




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