Class: Authentik::Api::LDAPSource

Inherits:
ApiModelBase show all
Defined in:
lib/authentik/api/models/ldap_source.rb

Overview

LDAP Source 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 = {}) ⇒ LDAPSource

Initializes the object

Parameters:

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

    Model attributes in the form of hash



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/authentik/api/models/ldap_source.rb', line 271

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'connectivity')
    if (value = attributes[:'connectivity']).is_a?(Hash)
      self.connectivity = value
    end
  else
    self.connectivity = nil
  end

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

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

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

Instance Attribute Details

#additional_group_dn ⇒ Object

Prepended to Base DN for Group-queries.



84
85
86
 
# File 'lib/authentik/api/models/ldap_source.rb', line 84

def additional_group_dn
  @additional_group_dn
end

#additional_user_dn ⇒ Object

Prepended to Base DN for User-queries.



81
82
83
 
# File 'lib/authentik/api/models/ldap_source.rb', line 81

def additional_user_dn
  @additional_user_dn
end

#authentication_flow ⇒ Object

Flow to use when authenticating existing users.



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

def authentication_flow
  @authentication_flow
end

#base_dn ⇒ Object

Returns the value of attribute base_dn.



78
79
80
 
# File 'lib/authentik/api/models/ldap_source.rb', line 78

def base_dn
  @base_dn
end

#bind_cn ⇒ Object

Returns the value of attribute bind_cn.



72
73
74
 
# File 'lib/authentik/api/models/ldap_source.rb', line 72

def bind_cn
  @bind_cn
end

#client_certificate ⇒ Object

Client certificate to authenticate against the LDAP Server’s Certificate.



70
71
72
 
# File 'lib/authentik/api/models/ldap_source.rb', line 70

def client_certificate
  @client_certificate
end

#component ⇒ Object

Get object component so that we know how to edit the object



37
38
39
 
# File 'lib/authentik/api/models/ldap_source.rb', line 37

def component
  @component
end

#connectivity ⇒ Object

Get cached source connectivity



114
115
116
 
# File 'lib/authentik/api/models/ldap_source.rb', line 114

def connectivity
  @connectivity
end

#delete_not_found_objects ⇒ Object

Delete authentik users and groups which were previously supplied by this source, but are now missing from it.



120
121
122
 
# File 'lib/authentik/api/models/ldap_source.rb', line 120

def delete_not_found_objects
  @delete_not_found_objects
end

#enabled ⇒ Object

Returns the value of attribute enabled.



21
22
23
 
# File 'lib/authentik/api/models/ldap_source.rb', line 21

def enabled
  @enabled
end

#enrollment_flow ⇒ Object

Flow to use when enrolling new users.



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

def enrollment_flow
  @enrollment_flow
end

#group_membership_field ⇒ Object

Field which contains members of a group.



93
94
95
 
# File 'lib/authentik/api/models/ldap_source.rb', line 93

def group_membership_field
  @group_membership_field
end

#group_object_filter ⇒ Object

Consider Objects matching this filter to be Groups.



90
91
92
 
# File 'lib/authentik/api/models/ldap_source.rb', line 90

def group_object_filter
  @group_object_filter
end

#group_property_mappings ⇒ Object

Returns the value of attribute group_property_mappings.



34
35
36
 
# File 'lib/authentik/api/models/ldap_source.rb', line 34

def group_property_mappings
  @group_property_mappings
end

#icon ⇒ Object

Returns the value of attribute icon.



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

def icon
  @icon
end

#icon_themed_urls ⇒ Object

Returns the value of attribute icon_themed_urls.



62
63
64
 
# File 'lib/authentik/api/models/ldap_source.rb', line 62

def icon_themed_urls
  @icon_themed_urls
end

#icon_url ⇒ Object

Returns the value of attribute icon_url.



60
61
62
 
# File 'lib/authentik/api/models/ldap_source.rb', line 60

def icon_url
  @icon_url
end

#lookup_groups_from_user ⇒ Object

Lookup group membership based on a user attribute instead of a group attribute. This allows nested group resolution on systems like FreeIPA and Active Directory



117
118
119
 
# File 'lib/authentik/api/models/ldap_source.rb', line 117

def lookup_groups_from_user
  @lookup_groups_from_user
end

#managed ⇒ Object

Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.



54
55
56
 
# File 'lib/authentik/api/models/ldap_source.rb', line 54

def managed
  @managed
end

#meta_model_name ⇒ Object

Return internal model name



46
47
48
 
# File 'lib/authentik/api/models/ldap_source.rb', line 46

def meta_model_name
  @meta_model_name
end

#name ⇒ Object

Source’s display Name.



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

def name
  @name
end

#object_uniqueness_field ⇒ Object

Field which contains a unique Identifier.



99
100
101
 
# File 'lib/authentik/api/models/ldap_source.rb', line 99

def object_uniqueness_field
  @object_uniqueness_field
end

#password_login_update_internal_password ⇒ Object

Update internal authentik password when login succeeds with LDAP



102
103
104
 
# File 'lib/authentik/api/models/ldap_source.rb', line 102

def 
  @password_login_update_internal_password
end

#peer_certificate ⇒ Object

Optionally verify the LDAP Server’s Certificate against the CA Chain in this keypair.



67
68
69
 
# File 'lib/authentik/api/models/ldap_source.rb', line 67

def peer_certificate
  @peer_certificate
end

#pk ⇒ Object

Returns the value of attribute pk.



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

def pk
  @pk
end

#policy_engine_mode ⇒ Object

Returns the value of attribute policy_engine_mode.



48
49
50
 
# File 'lib/authentik/api/models/ldap_source.rb', line 48

def policy_engine_mode
  @policy_engine_mode
end

When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.



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

def promoted
  @promoted
end

#server_uri ⇒ Object

Returns the value of attribute server_uri.



64
65
66
 
# File 'lib/authentik/api/models/ldap_source.rb', line 64

def server_uri
  @server_uri
end

#slug ⇒ Object

Internal source name, used in URLs.



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

def slug
  @slug
end

#sni ⇒ Object

Returns the value of attribute sni.



76
77
78
 
# File 'lib/authentik/api/models/ldap_source.rb', line 76

def sni
  @sni
end

#start_tls ⇒ Object

Returns the value of attribute start_tls.



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

def start_tls
  @start_tls
end

#sync_groups ⇒ Object

Returns the value of attribute sync_groups.



109
110
111
 
# File 'lib/authentik/api/models/ldap_source.rb', line 109

def sync_groups
  @sync_groups
end

#sync_outgoing_trigger_mode ⇒ Object

When to trigger sync for outgoing providers



123
124
125
 
# File 'lib/authentik/api/models/ldap_source.rb', line 123

def sync_outgoing_trigger_mode
  @sync_outgoing_trigger_mode
end

#sync_parent_group ⇒ Object

Returns the value of attribute sync_parent_group.



111
112
113
 
# File 'lib/authentik/api/models/ldap_source.rb', line 111

def sync_parent_group
  @sync_parent_group
end

#sync_users ⇒ Object

Returns the value of attribute sync_users.



104
105
106
 
# File 'lib/authentik/api/models/ldap_source.rb', line 104

def sync_users
  @sync_users
end

#sync_users_password ⇒ Object

When a user changes their password, sync it back to LDAP. This can only be enabled on a single LDAP source.



107
108
109
 
# File 'lib/authentik/api/models/ldap_source.rb', line 107

def sync_users_password
  @sync_users_password
end

#user_matching_mode ⇒ Object

How the source determines if an existing user should be authenticated or a new user enrolled.



51
52
53
 
# File 'lib/authentik/api/models/ldap_source.rb', line 51

def user_matching_mode
  @user_matching_mode
end

#user_membership_attribute ⇒ Object

Attribute which matches the value of ‘group_membership_field`.



96
97
98
 
# File 'lib/authentik/api/models/ldap_source.rb', line 96

def user_membership_attribute
  @user_membership_attribute
end

#user_object_filter ⇒ Object

Consider Objects matching this filter to be Users.



87
88
89
 
# File 'lib/authentik/api/models/ldap_source.rb', line 87

def user_object_filter
  @user_object_filter
end

#user_path_template ⇒ Object

Returns the value of attribute user_path_template.



56
57
58
 
# File 'lib/authentik/api/models/ldap_source.rb', line 56

def user_path_template
  @user_path_template
end

#user_property_mappings ⇒ Object

Returns the value of attribute user_property_mappings.



32
33
34
 
# File 'lib/authentik/api/models/ldap_source.rb', line 32

def user_property_mappings
  @user_property_mappings
end

#verbose_name ⇒ Object

Return object’s verbose_name



40
41
42
 
# File 'lib/authentik/api/models/ldap_source.rb', line 40

def verbose_name
  @verbose_name
end

#verbose_name_plural ⇒ Object

Return object’s plural verbose_name



43
44
45
 
# File 'lib/authentik/api/models/ldap_source.rb', line 43

def verbose_name_plural
  @verbose_name_plural
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



197
198
199
 
# File 'lib/authentik/api/models/ldap_source.rb', line 197

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



202
203
204
 
# File 'lib/authentik/api/models/ldap_source.rb', line 202

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/authentik/api/models/ldap_source.rb', line 148

def self.attribute_map
  {
    :'pk' => :'pk',
    :'name' => :'name',
    :'slug' => :'slug',
    :'enabled' => :'enabled',
    :'promoted' => :'promoted',
    :'authentication_flow' => :'authentication_flow',
    :'enrollment_flow' => :'enrollment_flow',
    :'user_property_mappings' => :'user_property_mappings',
    :'group_property_mappings' => :'group_property_mappings',
    :'component' => :'component',
    :'verbose_name' => :'verbose_name',
    :'verbose_name_plural' => :'verbose_name_plural',
    :'meta_model_name' => :'meta_model_name',
    :'policy_engine_mode' => :'policy_engine_mode',
    :'user_matching_mode' => :'user_matching_mode',
    :'managed' => :'managed',
    :'user_path_template' => :'user_path_template',
    :'icon' => :'icon',
    :'icon_url' => :'icon_url',
    :'icon_themed_urls' => :'icon_themed_urls',
    :'server_uri' => :'server_uri',
    :'peer_certificate' => :'peer_certificate',
    :'client_certificate' => :'client_certificate',
    :'bind_cn' => :'bind_cn',
    :'start_tls' => :'start_tls',
    :'sni' => :'sni',
    :'base_dn' => :'base_dn',
    :'additional_user_dn' => :'additional_user_dn',
    :'additional_group_dn' => :'additional_group_dn',
    :'user_object_filter' => :'user_object_filter',
    :'group_object_filter' => :'group_object_filter',
    :'group_membership_field' => :'group_membership_field',
    :'user_membership_attribute' => :'user_membership_attribute',
    :'object_uniqueness_field' => :'object_uniqueness_field',
    :'password_login_update_internal_password' => :'password_login_update_internal_password',
    :'sync_users' => :'sync_users',
    :'sync_users_password' => :'sync_users_password',
    :'sync_groups' => :'sync_groups',
    :'sync_parent_group' => :'sync_parent_group',
    :'connectivity' => :'connectivity',
    :'lookup_groups_from_user' => :'lookup_groups_from_user',
    :'delete_not_found_objects' => :'delete_not_found_objects',
    :'sync_outgoing_trigger_mode' => :'sync_outgoing_trigger_mode'
  }
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



731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
 
# File 'lib/authentik/api/models/ldap_source.rb', line 731

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



256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/authentik/api/models/ldap_source.rb', line 256

def self.openapi_nullable
  Set.new([
    :'authentication_flow',
    :'enrollment_flow',
    :'managed',
    :'icon_themed_urls',
    :'peer_certificate',
    :'client_certificate',
    :'sync_parent_group',
    :'connectivity',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/authentik/api/models/ldap_source.rb', line 207

def self.openapi_types
  {
    :'pk' => :'String',
    :'name' => :'String',
    :'slug' => :'String',
    :'enabled' => :'Boolean',
    :'promoted' => :'Boolean',
    :'authentication_flow' => :'String',
    :'enrollment_flow' => :'String',
    :'user_property_mappings' => :'Array<String>',
    :'group_property_mappings' => :'Array<String>',
    :'component' => :'String',
    :'verbose_name' => :'String',
    :'verbose_name_plural' => :'String',
    :'meta_model_name' => :'String',
    :'policy_engine_mode' => :'PolicyEngineMode',
    :'user_matching_mode' => :'UserMatchingModeEnum',
    :'managed' => :'String',
    :'user_path_template' => :'String',
    :'icon' => :'String',
    :'icon_url' => :'String',
    :'icon_themed_urls' => :'ThemedUrls',
    :'server_uri' => :'String',
    :'peer_certificate' => :'String',
    :'client_certificate' => :'String',
    :'bind_cn' => :'String',
    :'start_tls' => :'Boolean',
    :'sni' => :'Boolean',
    :'base_dn' => :'String',
    :'additional_user_dn' => :'String',
    :'additional_group_dn' => :'String',
    :'user_object_filter' => :'String',
    :'group_object_filter' => :'String',
    :'group_membership_field' => :'String',
    :'user_membership_attribute' => :'String',
    :'object_uniqueness_field' => :'String',
    :'password_login_update_internal_password' => :'Boolean',
    :'sync_users' => :'Boolean',
    :'sync_users_password' => :'Boolean',
    :'sync_groups' => :'Boolean',
    :'sync_parent_group' => :'String',
    :'connectivity' => :'Hash<String, Hash<String, String>>',
    :'lookup_groups_from_user' => :'Boolean',
    :'delete_not_found_objects' => :'Boolean',
    :'sync_outgoing_trigger_mode' => :'SyncOutgoingTriggerModeEnum'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/authentik/api/models/ldap_source.rb', line 668

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pk == o.pk &&
      name == o.name &&
      slug == o.slug &&
      enabled == o.enabled &&
      promoted == o.promoted &&
      authentication_flow == o.authentication_flow &&
      enrollment_flow == o.enrollment_flow &&
      user_property_mappings == o.user_property_mappings &&
      group_property_mappings == o.group_property_mappings &&
      component == o.component &&
      verbose_name == o.verbose_name &&
      verbose_name_plural == o.verbose_name_plural &&
      meta_model_name == o.meta_model_name &&
      policy_engine_mode == o.policy_engine_mode &&
      user_matching_mode == o.user_matching_mode &&
      managed == o.managed &&
      user_path_template == o.user_path_template &&
      icon == o.icon &&
      icon_url == o.icon_url &&
      icon_themed_urls == o.icon_themed_urls &&
      server_uri == o.server_uri &&
      peer_certificate == o.peer_certificate &&
      client_certificate == o.client_certificate &&
      bind_cn == o.bind_cn &&
      start_tls == o.start_tls &&
      sni == o.sni &&
      base_dn == o.base_dn &&
      additional_user_dn == o.additional_user_dn &&
      additional_group_dn == o.additional_group_dn &&
      user_object_filter == o.user_object_filter &&
      group_object_filter == o.group_object_filter &&
      group_membership_field == o.group_membership_field &&
      user_membership_attribute == o.user_membership_attribute &&
      object_uniqueness_field == o.object_uniqueness_field &&
       == o. &&
      sync_users == o.sync_users &&
      sync_users_password == o.sync_users_password &&
      sync_groups == o.sync_groups &&
      sync_parent_group == o.sync_parent_group &&
      connectivity == o.connectivity &&
      lookup_groups_from_user == o.lookup_groups_from_user &&
      delete_not_found_objects == o.delete_not_found_objects &&
      sync_outgoing_trigger_mode == o.sync_outgoing_trigger_mode
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


718
719
720
 
# File 'lib/authentik/api/models/ldap_source.rb', line 718

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



724
725
726
 
# File 'lib/authentik/api/models/ldap_source.rb', line 724

def hash
  [pk, name, slug, enabled, promoted, authentication_flow, enrollment_flow, user_property_mappings, group_property_mappings, component, verbose_name, verbose_name_plural, meta_model_name, policy_engine_mode, user_matching_mode, managed, user_path_template, icon, icon_url, icon_themed_urls, server_uri, peer_certificate, client_certificate, bind_cn, start_tls, sni, base_dn, additional_user_dn, additional_group_dn, user_object_filter, group_object_filter, group_membership_field, user_membership_attribute, object_uniqueness_field, , sync_users, sync_users_password, sync_groups, sync_parent_group, connectivity, lookup_groups_from_user, delete_not_found_objects, sync_outgoing_trigger_mode].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



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/authentik/api/models/ldap_source.rb', line 492

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

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @slug.nil?
    invalid_properties.push('invalid value for "slug", slug cannot be nil.')
  end

  pattern = Regexp.new(/^[-a-zA-Z0-9_]+$/)
  if @slug !~ pattern
    invalid_properties.push("invalid value for \"slug\", must conform to the pattern #{pattern}.")
  end

  if @component.nil?
    invalid_properties.push('invalid value for "component", component cannot be nil.')
  end

  if @verbose_name.nil?
    invalid_properties.push('invalid value for "verbose_name", verbose_name cannot be nil.')
  end

  if @verbose_name_plural.nil?
    invalid_properties.push('invalid value for "verbose_name_plural", verbose_name_plural cannot be nil.')
  end

  if @meta_model_name.nil?
    invalid_properties.push('invalid value for "meta_model_name", meta_model_name cannot be nil.')
  end

  if @icon_url.nil?
    invalid_properties.push('invalid value for "icon_url", icon_url cannot be nil.')
  end

  if @server_uri.nil?
    invalid_properties.push('invalid value for "server_uri", server_uri cannot be nil.')
  end

  if @base_dn.nil?
    invalid_properties.push('invalid value for "base_dn", base_dn cannot be nil.')
  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



753
754
755
756
757
758
759
760
761
762
763
764
765
 
# File 'lib/authentik/api/models/ldap_source.rb', line 753

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



545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/authentik/api/models/ldap_source.rb', line 545

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @pk.nil?
  return false if @name.nil?
  return false if @slug.nil?
  return false if @slug !~ Regexp.new(/^[-a-zA-Z0-9_]+$/)
  return false if @component.nil?
  return false if @verbose_name.nil?
  return false if @verbose_name_plural.nil?
  return false if @meta_model_name.nil?
  return false if @icon_url.nil?
  return false if @server_uri.nil?
  return false if @base_dn.nil?
  true
end