Class: Jamf::OAPISchemas::AccountSettingsRequest

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::AccountSettingsRequest

Defined in:

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

Overview

OAPI Object Model and Enums for: AccountSettingsRequest

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.

Constant Summary

USER_ACCOUNT_TYPE_OPTIONS =

Enums used by this class or others

[
  'ADMINISTRATOR',
  'STANDARD',
  'SKIP'
]

OAPI_PROPERTIES =

{

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

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

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

  # @!attribute adminUsername
  #   @return [String]
  adminUsername: {
    class: :string,
    min_length: 0
  },

  # @!attribute adminPassword
  #   @return [String]
  adminPassword: {
    class: :string,
    writeonly: true,
    min_length: 0
  },

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

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

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

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

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

  # Values accepted are only CUSTOM and DEVICE_OWNER
  # @!attribute prefillType
  #   @return [String]
  prefillType: {
    class: :string
  },

  # @!attribute prefillAccountFullName
  #   @return [String]
  prefillAccountFullName: {
    class: :string,
    min_length: 0
  },

  # @!attribute prefillAccountUserName
  #   @return [String]
  prefillAccountUserName: {
    class: :string,
    min_length: 0
  },

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

}

Instance Attribute Summary

• #adminPassword ⇒ String
• #adminUsername ⇒ String
• #hiddenAdminAccount ⇒ Boolean
• #id ⇒ String
• #localAdminAccountEnabled ⇒ Boolean
• #localUserManaged ⇒ Boolean
• #payloadConfigured ⇒ Boolean
• #prefillAccountFullName ⇒ String
• #prefillAccountUserName ⇒ String
• #prefillPrimaryAccountInfoFeatureEnabled ⇒ Boolean
• #prefillType ⇒ String
• #preventPrefillInfoFromModification ⇒ Boolean
• #userAccountType ⇒ String
• #versionLock ⇒ Integer

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#adminPassword ⇒ String

Returns:

• (String)

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

#adminUsername ⇒ String

Returns:

• (String)

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

#hiddenAdminAccount ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account_settings_request.rb', line 110

#id ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account_settings_request.rb', line 75

#localAdminAccountEnabled ⇒ Boolean

Returns:

• (Boolean)

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

#localUserManaged ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account_settings_request.rb', line 116

#payloadConfigured ⇒ Boolean

Returns:

• (Boolean)

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

#prefillAccountFullName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account_settings_request.rb', line 148

#prefillAccountUserName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account_settings_request.rb', line 155

#prefillPrimaryAccountInfoFeatureEnabled ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account_settings_request.rb', line 135

#prefillType ⇒ String

Returns:

• (String)

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

#preventPrefillInfoFromModification ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account_settings_request.rb', line 162

#userAccountType ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account_settings_request.rb', line 122

#versionLock ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account_settings_request.rb', line 129