Class: Jamf::OAPISchemas::VppAdminAccount

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::VppAdminAccount

Defined in:

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

Overview

OAPI Object Model and Enums for: VppAdminAccount

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

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

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

- '/vpp/admin-accounts:GET' needs permissions:
  - Read Volume Purchasing Administrator Accounts

Constant Summary

OAPI_PROPERTIES =

{

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

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

  # @!attribute licenseCount
  #   @return [Integer]
  licenseCount: {
    class: :integer
  },

  # @!attribute usedLicenseCount
  #   @return [Integer]
  usedLicenseCount: {
    class: :integer
  },

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

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

  # @!attribute site
  #   @return [Jamf::OAPISchemas::Site]
  site: {
    class: Jamf::OAPISchemas::Site
  }

}

Instance Attribute Summary

• #expirationDate ⇒ String
• #id ⇒ Integer
• #licenseCount ⇒ Integer
• #location ⇒ String
• #name ⇒ String
• #site ⇒ Jamf::OAPISchemas::Site
• #usedLicenseCount ⇒ Integer

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#expirationDate ⇒ String

Returns:

• (String)

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

#id ⇒ Integer

Returns:

• (Integer)

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

#licenseCount ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/vpp_admin_account.rb', line 84

#location ⇒ String

Returns:

• (String)

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

#name ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/vpp_admin_account.rb', line 78

#site ⇒ Jamf::OAPISchemas::Site

Returns:

• (Jamf::OAPISchemas::Site)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/vpp_admin_account.rb', line 108

#usedLicenseCount ⇒ Integer

Returns:

• (Integer)

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