Class: Jamf::OAPISchemas::ComputerInventoryFileVault

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::ComputerInventoryFileVault

Defined in:

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

Overview

OAPI Object Model and Enums for: ComputerInventoryFileVault

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

Sub Objects: Other object models used by this model’s attributes.

- Jamf::OAPISchemas::ComputerPartitionEncryption

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

- '/v1/computers-inventory/{id}/filevault:GET' needs permissions:
  - View Disk Encryption Recovery Key

Constant Summary

INDIVIDUAL_RECOVERY_KEY_VALIDITY_STATUS_OPTIONS =

Enums used by this class or others

[
  'VALID',
  'INVALID',
  'UNKNOWN',
  'NOT_APPLICABLE'
]

OAPI_PROPERTIES =

{

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

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

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

  # @!attribute bootPartitionEncryptionDetails
  #   @return [Jamf::OAPISchemas::ComputerPartitionEncryption]
  bootPartitionEncryptionDetails: {
    class: Jamf::OAPISchemas::ComputerPartitionEncryption
  },

  # @!attribute individualRecoveryKeyValidityStatus
  #   @return [String]
  individualRecoveryKeyValidityStatus: {
    class: :string,
    enum: INDIVIDUAL_RECOVERY_KEY_VALIDITY_STATUS_OPTIONS
  },

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

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

}

Instance Attribute Summary

• #bootPartitionEncryptionDetails ⇒ Jamf::OAPISchemas::ComputerPartitionEncryption
• #computerId ⇒ String readonly
• #diskEncryptionConfigurationName ⇒ String
• #individualRecoveryKeyValidityStatus ⇒ String
• #institutionalRecoveryKeyPresent ⇒ Boolean
• #name ⇒ String
• #personalRecoveryKey ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#bootPartitionEncryptionDetails ⇒ Jamf::OAPISchemas::ComputerPartitionEncryption

Returns:

• (Jamf::OAPISchemas::ComputerPartitionEncryption)

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

#computerId ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_inventory_file_vault.rb', line 77

#diskEncryptionConfigurationName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_inventory_file_vault.rb', line 115

#individualRecoveryKeyValidityStatus ⇒ String

Returns:

• (String)

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

#institutionalRecoveryKeyPresent ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_inventory_file_vault.rb', line 109

#name ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_inventory_file_vault.rb', line 84

#personalRecoveryKey ⇒ String

Returns:

• (String)

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