Class: Jamf::OAPISchemas::Account

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::Account

Defined in:

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

Overview

OAPI Object Model and Enums for: Account

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.

- Jamf::OAPISchemas::AccountPreferences

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

- '/user:GET' needs permissions:
  - Read Accounts

Constant Summary

ACCESS_LEVEL_OPTIONS =

Enums used by this class or others

[
  'FullAccess',
  'SiteAccess',
  'GroupBasedAccess'
]

PRIVILEGE_SET_OPTIONS =

[
  'ADMINISTRATOR',
  'AUDITOR',
  'ENROLLMENT',
  'CUSTOM'
]

OAPI_PROPERTIES =

{

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

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

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

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

  # @!attribute preferences
  #   @return [Jamf::OAPISchemas::AccountPreferences]
  preferences: {
    class: Jamf::OAPISchemas::AccountPreferences
  },

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

  # @!attribute accessLevel
  #   @return [String]
  accessLevel: {
    class: :string,
    enum: ACCESS_LEVEL_OPTIONS
  },

  # @!attribute privilegeSet
  #   @return [String]
  privilegeSet: {
    class: :string,
    enum: PRIVILEGE_SET_OPTIONS
  },

  # @!attribute privilegesBySite
  #   @return [Hash{Symbol: Array<String> }]
  privilegesBySite: {
    class: :hash
  },

  # @!attribute groupIds
  #   @return [Array<Integer>]
  groupIds: {
    class: :integer,
    multi: true
  },

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

}

Instance Attribute Summary

• #accessLevel ⇒ String
• #currentSiteId ⇒ Integer
• #email ⇒ String
• #groupIds ⇒ Array<Integer>
• #id ⇒ Integer
• #isMultiSiteAdmin ⇒ Boolean
• #preferences ⇒ Jamf::OAPISchemas::AccountPreferences
• #privilegesBySite ⇒ Hash{Symbol: Array<String> }
• #privilegeSet ⇒ String
• #realName ⇒ String
• #username ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#accessLevel ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account.rb', line 120

#currentSiteId ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account.rb', line 147

#email ⇒ String

Returns:

• (String)

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

#groupIds ⇒ Array<Integer>

Returns:

• (Array<Integer>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account.rb', line 140

#id ⇒ Integer

Returns:

• (Integer)

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

#isMultiSiteAdmin ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account.rb', line 114

#preferences ⇒ Jamf::OAPISchemas::AccountPreferences

Returns:

• (Jamf::OAPISchemas::AccountPreferences)

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

#privilegesBySite ⇒ Hash{Symbol: Array<String> }

Returns:

• (Hash{Symbol: Array<String> })

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account.rb', line 134

#privilegeSet ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account.rb', line 127

#realName ⇒ String

Returns:

• (String)

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

#username ⇒ String

Returns:

• (String)

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