class Comet::AdminSecurityOptions

AdminSecurityOptions is a typed class wrapper around the underlying Comet Server API data structure.

Attributes

allow_password_and_totplogin[RW]
allow_password_and_u2flogin[RW]

@type [Boolean] allow_password_and_u2flogin

allow_password_login[RW]

@type [Boolean] allow_password_login

ipwhitelist[RW]

@type [String] ipwhitelist

password[RW]

@type [String] password

password_format[RW]

@type [Number] password_format

totpkey[RW]

@type [String] totpkey

totpkey_encryption_format[RW]

@type [Number] totpkey_encryption_format

u2fregistrations[RW]

@type [Array<Comet::AdminU2FRegistration>] u2fregistrations

unknown_json_fields[RW]

@type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations

Public Class Methods

new() click to toggle source
# File lib/comet/models/admin_security_options.rb, line 47
def initialize
  clear
end

Public Instance Methods

clear() click to toggle source
# File lib/comet/models/admin_security_options.rb, line 51
def clear
  @password_format = 0
  @password = ''
  @u2fregistrations = []
  @totpkey_encryption_format = 0
  @totpkey = ''
  @ipwhitelist = ''
  @unknown_json_fields = {}
end
from_hash(obj) click to toggle source

@param [Hash] obj The complete object as a Ruby hash

# File lib/comet/models/admin_security_options.rb, line 69
def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'PasswordFormat'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @password_format = v
    when 'Password'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @password = v
    when 'AllowPasswordLogin'
      @allow_password_login = v
    when 'AllowPasswordAndTOTPLogin'
      @allow_password_and_totplogin = v
    when 'AllowPasswordAndU2FLogin'
      @allow_password_and_u2flogin = v
    when 'U2FRegistrations'
      if v.nil?
        @u2fregistrations = []
      else
        @u2fregistrations = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @u2fregistrations[i1] = Comet::AdminU2FRegistration.new
          @u2fregistrations[i1].from_hash(v1)
        end
      end
    when 'TOTPKeyEncryptionFormat'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @totpkey_encryption_format = v
    when 'TOTPKey'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @totpkey = v
    when 'IPWhitelist'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @ipwhitelist = v
    else
      @unknown_json_fields[k] = v
    end
  end
end
from_json(json_string) click to toggle source

@param [String] json_string The complete object in JSON format

# File lib/comet/models/admin_security_options.rb, line 62
def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end
to_h() click to toggle source

@return [Hash] The complete object as a Ruby hash

# File lib/comet/models/admin_security_options.rb, line 143
def to_h
  to_hash
end
to_hash() click to toggle source

@return [Hash] The complete object as a Ruby hash

# File lib/comet/models/admin_security_options.rb, line 117
def to_hash
  ret = {}
  ret['PasswordFormat'] = @password_format
  ret['Password'] = @password
  ret['AllowPasswordLogin'] = @allow_password_login
  ret['AllowPasswordAndTOTPLogin'] = @allow_password_and_totplogin
  ret['AllowPasswordAndU2FLogin'] = @allow_password_and_u2flogin
  unless @u2fregistrations.nil?
    ret['U2FRegistrations'] = @u2fregistrations
  end
  unless @totpkey_encryption_format.nil?
    ret['TOTPKeyEncryptionFormat'] = @totpkey_encryption_format
  end
  unless @totpkey.nil?
    ret['TOTPKey'] = @totpkey
  end
  unless @ipwhitelist.nil?
    ret['IPWhitelist'] = @ipwhitelist
  end
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end
to_json(options = {}) click to toggle source

@return [String] The complete object as a JSON string

# File lib/comet/models/admin_security_options.rb, line 148
def to_json(options = {})
  to_hash.to_json(options)
end