Class: Authentik::Api::PatchedRadiusProviderRequest

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

Overview

RadiusProvider Serializer

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 = {}) ⇒ PatchedRadiusProviderRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/authentik/api/models/patched_radius_provider_request.rb', line 87

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Authentik::Api::PatchedRadiusProviderRequest` 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::PatchedRadiusProviderRequest`. 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']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#authentication_flow ⇒ Object

Flow used for authentication when the associated application is accessed by an un-authenticated user.



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

def authentication_flow
  @authentication_flow
end

#authorization_flow ⇒ Object

Flow used when authorizing this provider.



19
20
21
 
# File 'lib/authentik/api/models/patched_radius_provider_request.rb', line 19

def authorization_flow
  @authorization_flow
end

#certificate ⇒ Object

Returns the value of attribute certificate.



35
36
37
 
# File 'lib/authentik/api/models/patched_radius_provider_request.rb', line 35

def certificate
  @certificate
end

#client_networks ⇒ Object

List of CIDRs (comma-separated) that clients can connect from. A more specific CIDR will match before a looser one. Clients connecting from a non-specified CIDR will be dropped.



27
28
29
 
# File 'lib/authentik/api/models/patched_radius_provider_request.rb', line 27

def client_networks
  @client_networks
end

#invalidation_flow ⇒ Object

Flow used ending the session from a provider.



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

def invalidation_flow
  @invalidation_flow
end

#mfa_support ⇒ Object

When enabled, code-based multi-factor authentication can be used by appending a semicolon and the TOTP code to the password. This should only be enabled if all users that will bind to this provider have a TOTP device configured, as otherwise a password may incorrectly be rejected if it contains a semicolon.



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

def mfa_support
  @mfa_support
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#property_mappings ⇒ Object

Returns the value of attribute property_mappings.



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

def property_mappings
  @property_mappings
end

#shared_secret ⇒ Object

Shared secret between clients and server to hash packets.



30
31
32
 
# File 'lib/authentik/api/models/patched_radius_provider_request.rb', line 30

def shared_secret
  @shared_secret
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



53
54
55
 
# File 'lib/authentik/api/models/patched_radius_provider_request.rb', line 53

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/authentik/api/models/patched_radius_provider_request.rb', line 58

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/authentik/api/models/patched_radius_provider_request.rb', line 38

def self.attribute_map
  {
    :'name' => :'name',
    :'authentication_flow' => :'authentication_flow',
    :'authorization_flow' => :'authorization_flow',
    :'invalidation_flow' => :'invalidation_flow',
    :'property_mappings' => :'property_mappings',
    :'client_networks' => :'client_networks',
    :'shared_secret' => :'shared_secret',
    :'mfa_support' => :'mfa_support',
    :'certificate' => :'certificate'
  }
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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/authentik/api/models/patched_radius_provider_request.rb', line 243

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



78
79
80
81
82
83
 
# File 'lib/authentik/api/models/patched_radius_provider_request.rb', line 78

def self.openapi_nullable
  Set.new([
    :'authentication_flow',
    :'certificate'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/authentik/api/models/patched_radius_provider_request.rb', line 63

def self.openapi_types
  {
    :'name' => :'String',
    :'authentication_flow' => :'String',
    :'authorization_flow' => :'String',
    :'invalidation_flow' => :'String',
    :'property_mappings' => :'Array<String>',
    :'client_networks' => :'String',
    :'shared_secret' => :'String',
    :'mfa_support' => :'Boolean',
    :'certificate' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/authentik/api/models/patched_radius_provider_request.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      authentication_flow == o.authentication_flow &&
      authorization_flow == o.authorization_flow &&
      invalidation_flow == o.invalidation_flow &&
      property_mappings == o.property_mappings &&
      client_networks == o.client_networks &&
      shared_secret == o.shared_secret &&
      mfa_support == o.mfa_support &&
      certificate == o.certificate
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


230
231
232
 
# File 'lib/authentik/api/models/patched_radius_provider_request.rb', line 230

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



236
237
238
 
# File 'lib/authentik/api/models/patched_radius_provider_request.rb', line 236

def hash
  [name, authentication_flow, authorization_flow, invalidation_flow, property_mappings, client_networks, shared_secret, mfa_support, certificate].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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/authentik/api/models/patched_radius_provider_request.rb', line 142

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@name.nil? && @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 !@client_networks.nil? && @client_networks.to_s.length < 1
    invalid_properties.push('invalid value for "client_networks", the character length must be greater than or equal to 1.')
  end

  if !@shared_secret.nil? && @shared_secret.to_s.length < 1
    invalid_properties.push('invalid value for "shared_secret", the character length must be greater than or equal to 1.')
  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



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/authentik/api/models/patched_radius_provider_request.rb', line 265

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



162
163
164
165
166
167
168
 
# File 'lib/authentik/api/models/patched_radius_provider_request.rb', line 162

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