Class: JSS::DiskEncryptionConfiguration

Inherits:
APIObject show all
Includes:
Updatable
Defined in:
lib/jss/api_object/disk_encryption_configurations.rb

Overview

Disk Encryption Configuration object inside JSS

More Detailed Description if needed

Constant Summary collapse

KEY_TYPE =
Note:

Currently “Individual and Institutional” configuration type is unsupported through the API

{
    individual: 'Individual',
    institutional: 'Institutional',
    individual_and_institutional: 'Individual and Institutional'
}.freeze
ENABLED_USERS_TYPE =
Note:

as of 10.13 Management Account cannot be used due to the lack of a secure token.

{
    management: "Management Account",
    current: "Current or Next User"
}.freeze
RSRC_BASE =

The base for REST resources of this class

'diskencryptionconfigurations'.freeze
RSRC_LIST_KEY =

the hash key used for the JSON list output of all objects in the JSS

:disk_encryption_configurations
RSRC_OBJECT_KEY =

The hash key used for the JSON object output It's also used in various error messages

:disk_encryption_configuration

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args = {}) ⇒ DiskEncryptionConfiguration

Returns a new instance of DiskEncryptionConfiguration.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/jss/api_object/disk_encryption_configurations.rb', line 58

def initialize(args = {})
    super

    if self.in_jss?
        @key_type = @init_data[:key_type]
        @file_vault_enabled_users = @init_data[:file_vault_enabled_users]
        @institutional_recovery_key = @init_data[:institutional_recovery_key]
    else
        raise JSS::InvalidDataError, "Currently the ability to create a Disk Encryption Configuration is not possible through ruby-jss."
    end

    

end

Instance Attribute Details

#file_vault_enabled_users ⇒ Object

Returns the value of attribute file_vault_enabled_users.



51
52
53
 
# File 'lib/jss/api_object/disk_encryption_configurations.rb', line 51

def file_vault_enabled_users
  @file_vault_enabled_users
end

#institutional_recovery_key ⇒ Object (readonly)

Returns the value of attribute institutional_recovery_key.



52
53
54
 
# File 'lib/jss/api_object/disk_encryption_configurations.rb', line 52

def institutional_recovery_key
  @institutional_recovery_key
end

#key_type ⇒ Object (readonly)

Attributes



50
51
52
 
# File 'lib/jss/api_object/disk_encryption_configurations.rb', line 50

def key_type
  @key_type
end

#need_to_update ⇒ Boolean (readonly) Originally defined in module Updatable

Returns do we have unsaved changes?.

Returns:

  • (Boolean) —

    do we have unsaved changes?

Instance Method Details

#name=(newname) ⇒ void Originally defined in module Updatable

This method returns an undefined value.

Change the name of this item Remember to #update to push changes to the server.

Parameters:

  • newname (String) —

    the new name

Raises:

#update ⇒ Boolean Originally defined in module Updatable

Save changes to the JSS

Returns:

  • (Boolean) —

    success

Raises: