Class: Comet::AdminSecurityOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/admin_security_options.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AdminSecurityOptions

Returns a new instance of AdminSecurityOptions.



47
48
49
 
# File 'lib/comet/models/admin_security_options.rb', line 47

def initialize
  clear
end

Instance Attribute Details

#allow_password_and_totplogin ⇒ Object

Returns the value of attribute allow_password_and_totplogin.



27
28
29
 
# File 'lib/comet/models/admin_security_options.rb', line 27

def allow_password_and_totplogin
  @allow_password_and_totplogin
end

#allow_password_and_u2flogin ⇒ Object

Returns the value of attribute allow_password_and_u2flogin.



30
31
32
 
# File 'lib/comet/models/admin_security_options.rb', line 30

def allow_password_and_u2flogin
  @allow_password_and_u2flogin
end

#allow_password_login ⇒ Object

Returns the value of attribute allow_password_login.



24
25
26
 
# File 'lib/comet/models/admin_security_options.rb', line 24

def 
  @allow_password_login
end

#ipwhitelist ⇒ Object

Returns the value of attribute ipwhitelist.



42
43
44
 
# File 'lib/comet/models/admin_security_options.rb', line 42

def ipwhitelist
  @ipwhitelist
end

#password ⇒ Object

Returns the value of attribute password.



21
22
23
 
# File 'lib/comet/models/admin_security_options.rb', line 21

def password
  @password
end

#password_format ⇒ Object

Returns the value of attribute password_format.



18
19
20
 
# File 'lib/comet/models/admin_security_options.rb', line 18

def password_format
  @password_format
end

#totpkey ⇒ Object

Returns the value of attribute totpkey.



39
40
41
 
# File 'lib/comet/models/admin_security_options.rb', line 39

def totpkey
  @totpkey
end

#totpkey_encryption_format ⇒ Object

Returns the value of attribute totpkey_encryption_format.



36
37
38
 
# File 'lib/comet/models/admin_security_options.rb', line 36

def totpkey_encryption_format
  @totpkey_encryption_format
end

#u2fregistrations ⇒ Object

Returns the value of attribute u2fregistrations.



33
34
35
 
# File 'lib/comet/models/admin_security_options.rb', line 33

def u2fregistrations
  @u2fregistrations
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



45
46
47
 
# File 'lib/comet/models/admin_security_options.rb', line 45

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



51
52
53
54
55
56
57
58
59
 
# 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) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# 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) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format



62
63
64
65
66
 
# 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 ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



143
144
145
 
# File 'lib/comet/models/admin_security_options.rb', line 143

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# 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 = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



148
149
150
 
# File 'lib/comet/models/admin_security_options.rb', line 148

def to_json(options = {})
  to_hash.to_json(options)
end