Class: Jamf::Account

Inherits:
JSONObject show all
Defined in:
lib/jamf/api/resources/collection_resources/account.rb

Overview

An administrator account in the JSS

ISSUES FOR JAMF:

  • Seems like there needs to be some cleanup/coordination with the endpoints GET/auth, POST/auth/current, and GET/user Things are currently wonky enough that I can’t really move forward with this class.

Constant Summary collapse

ACCESS_LEVEL_FULL =

Constants

'FullAccess'.freeze
ACCESS_LEVEL_SITE = 
'SiteAccess'.freeze,
ACCESS_LEVEL_GROUP = 'GroupBasedAccess'.freeze
ACCESS_LEVELS = 
[
  ACCESS_LEVEL_FULL,
  ACCESS_LEVEL_SITE,
  ACCESS_LEVEL_GROUP
].freeze
PRIVILEGE_SET_ADMIN = 
'ADMINISTRATOR'.freeze
PRIVILEGE_SET_AUDITOR = 
'AUDITOR'.freeze
PRIVILEGE_SET_ENROLL = 
'ENROLLMENT'.freeze
PRIVILEGE_SET_CUSTOM = 
'CUSTOM'.freeze
PRIVILEGE_SETS = 
[
  PRIVILEGE_SET_ADMIN,
  PRIVILEGE_SET_AUDITOR,
  PRIVILEGE_SET_ENROLL,
  PRIVILEGE_SET_CUSTOM
].freeze
OBJECT_MODEL =

Object Model / Attributes See APIObject class documentation for details of how the OBJECT_MODEL hash works.

{
  # @!attribute [r] id
  #   @return [Integer]
  id: {
    class: :integer,
    readonly: true
  },

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

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

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

  # @!attribute [r]  preferences
  #   @return [String]
  preferences: {
    class: Jamf::AccountPreferences,
    readonly: true
  },

  # @!attribute [r] isMultiSiteAdmin
  #   @return [Boolean]
  isMultiSiteAdmin: {
    class: :boolean,
    readonly: true
  },

  # @!attribute [r] accessLevel
  #   @return [String]
  accessLevel: {
    class: :string,
    readonly: true,
    enum: Jamf::Account::ACCESS_LEVELS
  },

  # @!attribute [r] accessLevel
  #   @return [String]
  privilegeSet: {
    class: :string,
    readonly: true,
    enum: Jamf::Account::PRIVILEGE_SETS
  },

}.freeze

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::JSONObject

Instance Attribute Details

#accessLevel ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/resources/collection_resources/account.rb', line 114

#email ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/resources/collection_resources/account.rb', line 93

#id ⇒ Integer (readonly)

Returns:

  • (Integer) 



# File 'lib/jamf/api/resources/collection_resources/account.rb', line 72

#isMultiSiteAdmin ⇒ Boolean (readonly)

Returns:

  • (Boolean) 



# File 'lib/jamf/api/resources/collection_resources/account.rb', line 107

#preferences ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/resources/collection_resources/account.rb', line 100

#realName ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/resources/collection_resources/account.rb', line 86

#username ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/resources/collection_resources/account.rb', line 79