Class: Jamf::OAPISchemas::ProtectSettingsResponse

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::ProtectSettingsResponse

Defined in:

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

Overview

OAPI Object Model and Enums for: ProtectSettingsResponse

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.

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

- '/v1/jamf-protect:GET' needs permissions:
  - Read Jamf Protect Settings
  - Read Jamf Protect Deployments
- '/v1/jamf-protect:PUT' needs permissions:
  - Update Jamf Protect Settings
- '/v1/jamf-protect/register:POST' needs permissions:
  - Update Jamf Protect Settings

Constant Summary

SYNC_STATUS_OPTIONS =

Enums used by this class or others

[
  'IN_PROGRESS',
  'COMPLETED',
  'ERROR',
  'UNKNOWN'
]

OAPI_PROPERTIES =

{

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

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

  # display name used when creating the API Client in the Jamf Protect web console
  # @!attribute apiClientName
  #   @return [String]
  apiClientName: {
    class: :string
  },

  # ID used when making requests to identify this particular Protect registration.
  # @!attribute registrationId
  #   @return [String]
  registrationId: {
    class: :string
  },

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

  # @!attribute lastSyncTime
  #   @return [String]
  lastSyncTime: {
    class: Jamf::Timestamp
  },

  # @!attribute syncStatus
  #   @return [String]
  syncStatus: {
    class: :string,
    enum: SYNC_STATUS_OPTIONS
  },

  # determines whether the Jamf Protect agent will be automatically installed on client computers
  # @!attribute autoInstall
  #   @return [Boolean]
  autoInstall: {
    class: :boolean
  }

}

Instance Attribute Summary

• #apiClientId ⇒ String
• #apiClientName ⇒ String
• #autoInstall ⇒ Boolean
• #id ⇒ String
• #lastSyncTime ⇒ String
• #protectUrl ⇒ String
• #registrationId ⇒ String
• #syncStatus ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#apiClientId ⇒ String

Returns:

• (String)

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

#apiClientName ⇒ String

Returns:

• (String)

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

#autoInstall ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/protect_settings_response.rb', line 128

#id ⇒ String

Returns:

• (String)

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

#lastSyncTime ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/protect_settings_response.rb', line 115

#protectUrl ⇒ String

Returns:

• (String)

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

#registrationId ⇒ String

Returns:

• (String)

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

#syncStatus ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/protect_settings_response.rb', line 121