Class: Jamf::OAPISchemas::ComputerLocalUserAccount

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::ComputerLocalUserAccount

Defined in:

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

Overview

OAPI Object Model and Enums for: ComputerLocalUserAccount

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

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.

Constant Summary

USER_ACCOUNT_TYPE_OPTIONS =

Enums used by this class or others

[
  'LOCAL',
  'MOBILE',
  'UNKNOWN'
]

AZURE_ACTIVE_DIRECTORY_ID_OPTIONS =

[
  'ACTIVATED',
  'DEACTIVATED',
  'UNRESPONSIVE',
  'UNKNOWN'
]

OAPI_PROPERTIES =

{

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

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

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

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

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

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

  # Home directory size in MB.
  # @!attribute [r] homeDirectorySizeMb
  #   @return [Integer]
  homeDirectorySizeMb: {
    class: :integer,
    format: 'int64',
    readonly: true
  },

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

  # @!attribute userAccountType
  #   @return [String]
  userAccountType: {
    class: :string,
    enum: USER_ACCOUNT_TYPE_OPTIONS
  },

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

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

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

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

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

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

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

  # @!attribute azureActiveDirectoryId
  #   @return [String]
  azureActiveDirectoryId: {
    class: :string,
    enum: AZURE_ACTIVE_DIRECTORY_ID_OPTIONS
  }

}

Instance Attribute Summary

• #admin ⇒ Boolean
• #azureActiveDirectoryId ⇒ String
• #computerAzureActiveDirectoryId ⇒ String
• #fileVault2Enabled ⇒ Boolean
• #fullName ⇒ String
• #homeDirectory ⇒ String
• #homeDirectorySizeMb ⇒ Integer readonly
• #passwordHistoryDepth ⇒ Integer
• #passwordMaxAge ⇒ Integer
• #passwordMinComplexCharacters ⇒ Integer
• #passwordMinLength ⇒ Integer
• #passwordRequireAlphanumeric ⇒ Boolean
• #uid ⇒ String
• #userAccountType ⇒ String
• #userAzureActiveDirectoryId ⇒ String
• #userGuid ⇒ String readonly
• #username ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#admin ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_local_user_account.rb', line 107

#azureActiveDirectoryId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_local_user_account.rb', line 183

#computerAzureActiveDirectoryId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_local_user_account.rb', line 171

#fileVault2Enabled ⇒ Boolean

Returns:

• (Boolean)

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

#fullName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_local_user_account.rb', line 101

#homeDirectory ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_local_user_account.rb', line 113

#homeDirectorySizeMb ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_local_user_account.rb', line 119

#passwordHistoryDepth ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_local_user_account.rb', line 159

#passwordMaxAge ⇒ Integer

Returns:

• (Integer)

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

#passwordMinComplexCharacters ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_local_user_account.rb', line 153

#passwordMinLength ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_local_user_account.rb', line 141

#passwordRequireAlphanumeric ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_local_user_account.rb', line 165

#uid ⇒ String

Returns:

• (String)

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

#userAccountType ⇒ String

Returns:

• (String)

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

#userAzureActiveDirectoryId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_local_user_account.rb', line 177

#userGuid ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_local_user_account.rb', line 88

#username ⇒ String

Returns:

• (String)

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