class Comet::AdminSecurityOptions

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

def clear

def clear
  @password_format = 0
  @password = ''
  @u2fregistrations = []
  @web_authn_registrations = []
  @totpkey_encryption_format = 0
  @totpkey = ''
  @ipwhitelist = ''
  @unknown_json_fields = {}
end

def from_hash(obj)

Parameters:
  • obj (Hash) -- The complete object as a Ruby hash
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 'AllowPasswordAndWebAuthnLogin'
      @allow_password_and_web_authn_login = 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 'WebAuthnRegistrations'
      if v.nil?
        @web_authn_registrations = []
      else
        @web_authn_registrations = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @web_authn_registrations[i1] = Comet::AdminWebAuthnRegistration.new
          @web_authn_registrations[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

def from_json(json_string)

Parameters:
  • json_string (String) -- The complete object in JSON format
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

def initialize

def initialize
  clear
end

def to_h

Returns:
  • (Hash) - The complete object as a Ruby hash
def to_h
  to_hash
end

def to_hash

Returns:
  • (Hash) - The complete object as a Ruby hash
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
  ret['AllowPasswordAndWebAuthnLogin'] = @allow_password_and_web_authn_login
  unless @u2fregistrations.nil?
    ret['U2FRegistrations'] = @u2fregistrations
  end
  unless @web_authn_registrations.nil?
    ret['WebAuthnRegistrations'] = @web_authn_registrations
  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

def to_json(options = {})

Returns:
  • (String) - The complete object as a JSON string
def to_json(options = {})
  to_hash.to_json(options)
end