Class: Jamf::OAPISchemas::DeviceEnrollmentInstance

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::DeviceEnrollmentInstance

Defined in:

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

Overview

OAPI Object Model and Enums for: DeviceEnrollmentInstance

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

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/device-enrollments/{id}:GET' needs permissions:
  - Read Device Enrollment Program Instances
- '/v1/device-enrollments/{id}:PUT' needs permissions:
  - Update Device Enrollment Program Instances
- '/v1/device-enrollments/{id}/upload-token:PUT' needs permissions:
  - Update Device Enrollment Program Instances

Direct Known Subclasses

DeviceEnrollment

Constant Summary

OAPI_PROPERTIES =

{

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

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

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

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

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

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

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

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

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

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

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

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

}

Instance Attribute Summary

• #adminId ⇒ String readonly
• #id ⇒ String readonly
• #name ⇒ String
• #orgAddress ⇒ String readonly
• #orgEmail ⇒ String readonly
• #orgName ⇒ String readonly
• #orgPhone ⇒ String readonly
• #serverName ⇒ String readonly
• #serverUuid ⇒ String readonly
• #siteId ⇒ String
• #supervisionIdentityId ⇒ String
• #tokenExpirationDate ⇒ String readonly

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#adminId ⇒ String (readonly)

Returns:

• (String)

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

#id ⇒ String (readonly)

Returns:

• (String)

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

#name ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_instance.rb', line 83

#orgAddress ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_instance.rb', line 144

#orgEmail ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_instance.rb', line 130

#orgName ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_instance.rb', line 123

#orgPhone ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_instance.rb', line 137

#serverName ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_instance.rb', line 102

#serverUuid ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_instance.rb', line 109

#siteId ⇒ String

Returns:

• (String)

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

#supervisionIdentityId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_instance.rb', line 90

#tokenExpirationDate ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/device_enrollment_instance.rb', line 151