Class: Jamf::OAPISchemas::OnboardingConfiguration

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

Overview

OAPI Object Model and Enums for: OnboardingConfiguration

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

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

- '/v1/onboarding:GET' needs permissions:
  - Read Onboarding Configuration
- '/v1/onboarding:PUT' needs permissions:
  - Update Onboarding Configuration

Constant Summary collapse

OAPI_PROPERTIES = 
{

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

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

  # @!attribute onboardingItems
  #   @return [Array<Jamf::OAPISchemas::OnboardingItem>]
  onboardingItems: {
    class: Jamf::OAPISchemas::OnboardingItem,
    required: true,
    multi: true
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#enabled ⇒ Boolean

Returns:

  • (Boolean) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/onboarding_configuration.rb', line 80

#id ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/onboarding_configuration.rb', line 72

#onboardingItems ⇒ Array<Jamf::OAPISchemas::OnboardingItem>

Returns:




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