Class: Authentik::Api::AuthenticatorWebAuthnStageRequest

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/authentik/api/models/authenticator_web_authn_stage_request.rb

Overview

AuthenticatorWebAuthnStage Serializer

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ AuthenticatorWebAuthnStageRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 109

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Authentik::Api::AuthenticatorWebAuthnStageRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Authentik::Api::AuthenticatorWebAuthnStageRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'configure_flow')
    self.configure_flow = attributes[:'configure_flow']
  end

  if attributes.key?(:'friendly_name')
    self.friendly_name = attributes[:'friendly_name']
  end

  if attributes.key?(:'user_verification')
    self.user_verification = attributes[:'user_verification']
  end

  if attributes.key?(:'authenticator_attachment')
    self.authenticator_attachment = attributes[:'authenticator_attachment']
  end

  if attributes.key?(:'resident_key_requirement')
    self.resident_key_requirement = attributes[:'resident_key_requirement']
  end

  if attributes.key?(:'hints')
    if (value = attributes[:'hints']).is_a?(Array)
      self.hints = value
    end
  end

  if attributes.key?(:'device_type_restrictions')
    if (value = attributes[:'device_type_restrictions']).is_a?(Array)
      self.device_type_restrictions = value
    end
  end

  if attributes.key?(:'prevent_duplicate_devices')
    self.prevent_duplicate_devices = attributes[:'prevent_duplicate_devices']
  end

  if attributes.key?(:'max_attempts')
    self.max_attempts = attributes[:'max_attempts']
  end
end

Instance Attribute Details

#authenticator_attachment ⇒ Object

Returns the value of attribute authenticator_attachment.



22
23
24
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 22

def authenticator_attachment
  @authenticator_attachment
end

#configure_flow ⇒ Object

Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage.



16
17
18
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 16

def configure_flow
  @configure_flow
end

#device_type_restrictions ⇒ Object

Returns the value of attribute device_type_restrictions.



28
29
30
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 28

def device_type_restrictions
  @device_type_restrictions
end

#friendly_name ⇒ Object

Returns the value of attribute friendly_name.



18
19
20
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 18

def friendly_name
  @friendly_name
end

#hints ⇒ Object

Returns the value of attribute hints.



26
27
28
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 26

def hints
  @hints
end

#max_attempts ⇒ Object

Returns the value of attribute max_attempts.



33
34
35
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 33

def max_attempts
  @max_attempts
end

#name ⇒ Object

Returns the value of attribute name.



13
14
15
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 13

def name
  @name
end

#prevent_duplicate_devices ⇒ Object

When enabled, a given device can only be registered once.



31
32
33
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 31

def prevent_duplicate_devices
  @prevent_duplicate_devices
end

#resident_key_requirement ⇒ Object

Returns the value of attribute resident_key_requirement.



24
25
26
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 24

def resident_key_requirement
  @resident_key_requirement
end

#user_verification ⇒ Object

Returns the value of attribute user_verification.



20
21
22
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 20

def user_verification
  @user_verification
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



74
75
76
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 74

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 79

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 58

def self.attribute_map
  {
    :'name' => :'name',
    :'configure_flow' => :'configure_flow',
    :'friendly_name' => :'friendly_name',
    :'user_verification' => :'user_verification',
    :'authenticator_attachment' => :'authenticator_attachment',
    :'resident_key_requirement' => :'resident_key_requirement',
    :'hints' => :'hints',
    :'device_type_restrictions' => :'device_type_restrictions',
    :'prevent_duplicate_devices' => :'prevent_duplicate_devices',
    :'max_attempts' => :'max_attempts'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 269

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
104
105
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 100

def self.openapi_nullable
  Set.new([
    :'configure_flow',
    :'authenticator_attachment',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 84

def self.openapi_types
  {
    :'name' => :'String',
    :'configure_flow' => :'String',
    :'friendly_name' => :'String',
    :'user_verification' => :'UserVerificationEnum',
    :'authenticator_attachment' => :'AuthenticatorAttachmentEnum',
    :'resident_key_requirement' => :'UserVerificationEnum',
    :'hints' => :'Array<WebAuthnHintEnum>',
    :'device_type_restrictions' => :'Array<String>',
    :'prevent_duplicate_devices' => :'Boolean',
    :'max_attempts' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      configure_flow == o.configure_flow &&
      friendly_name == o.friendly_name &&
      user_verification == o.user_verification &&
      authenticator_attachment == o.authenticator_attachment &&
      resident_key_requirement == o.resident_key_requirement &&
      hints == o.hints &&
      device_type_restrictions == o.device_type_restrictions &&
      prevent_duplicate_devices == o.prevent_duplicate_devices &&
      max_attempts == o.max_attempts
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


256
257
258
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 256

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



262
263
264
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 262

def hash
  [name, configure_flow, friendly_name, user_verification, authenticator_attachment, resident_key_requirement, hints, device_type_restrictions, prevent_duplicate_devices, max_attempts].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 172

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
  end

  if !@max_attempts.nil? && @max_attempts > 2147483647
    invalid_properties.push('invalid value for "max_attempts", must be smaller than or equal to 2147483647.')
  end

  if !@max_attempts.nil? && @max_attempts < 0
    invalid_properties.push('invalid value for "max_attempts", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 291

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



196
197
198
199
200
201
202
203
 
# File 'lib/authentik/api/models/authenticator_web_authn_stage_request.rb', line 196

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length < 1
  return false if !@max_attempts.nil? && @max_attempts > 2147483647
  return false if !@max_attempts.nil? && @max_attempts < 0
  true
end