Class: Jamf::OAPISchemas::InitializeV1

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

Overview

OAPI Object Model and Enums for: InitializeV1

Description of this class from the OAPI Schema:

Initial Jamf Pro setup data

This class was automatically genereated from the api/schema URL path on a Jamf Pro server version 10.46.0-t1681398190

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.

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

- '/v1/system/initialize:POST' needs permissions:
  - Unknown

Constant Summary collapse

OAPI_PROPERTIES = 
{

  # @!attribute activationCode
  #   @return [String]
  activationCode: {
    class: :string,
    required: true,
    min_length: 39,
    max_length: 39
  },

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

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

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

  # @!attribute password
  #   @return [String]
  password: {
    class: :string,
    required: true,
    format: 'password',
    writeonly: true,
    min_length: 1
  },

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

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

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#activationCode ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/initialize_v1.rb', line 71

#email ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/initialize_v1.rb', line 113

#eulaAccepted ⇒ Boolean

Returns:

  • (Boolean) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/initialize_v1.rb', line 88

#institutionName ⇒ String

Returns:




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

#jssUrl ⇒ String

Returns:




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

#password ⇒ String

Returns:




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

#username ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/initialize_v1.rb', line 95