Class: ClerkHttpClient::SchemasSAMLConnection

Inherits:
Object
  • Object
show all
Defined in:
lib/clerk-http-client/models/schemas_saml_connection.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SchemasSAMLConnection

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
195
196
197
198
199
200
201
202
203
204
205
206
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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
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
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 165

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#acs_url ⇒ Object

Returns the value of attribute acs_url.



36
37
38
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 36

def acs_url
  @acs_url
end

#active ⇒ Object

Returns the value of attribute active.



46
47
48
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 46

def active
  @active
end

#allow_idp_initiated ⇒ Object

Returns the value of attribute allow_idp_initiated.



56
57
58
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 56

def allow_idp_initiated
  @allow_idp_initiated
end

#allow_subdomains ⇒ Object

Returns the value of attribute allow_subdomains.



54
55
56
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 54

def allow_subdomains
  @allow_subdomains
end

#attribute_mapping ⇒ Object

Returns the value of attribute attribute_mapping.



44
45
46
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 44

def attribute_mapping
  @attribute_mapping
end

#created_at ⇒ Object

Unix timestamp of creation.



61
62
63
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 61

def created_at
  @created_at
end

#disable_additional_identifications ⇒ Object

Returns the value of attribute disable_additional_identifications.



58
59
60
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 58

def disable_additional_identifications
  @disable_additional_identifications
end

#domain ⇒ Object

Returns the value of attribute domain.



24
25
26
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 24

def domain
  @domain
end

#id ⇒ Object

Returns the value of attribute id.



20
21
22
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 20

def id
  @id
end

#idp_certificate ⇒ Object

Returns the value of attribute idp_certificate.



30
31
32
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 30

def idp_certificate
  @idp_certificate
end

#idp_entity_id ⇒ Object

Returns the value of attribute idp_entity_id.



26
27
28
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 26

def idp_entity_id
  @idp_entity_id
end

#idp_metadata ⇒ Object

Returns the value of attribute idp_metadata.



34
35
36
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 34

def idp_metadata
  @idp_metadata
end

#idp_metadata_url ⇒ Object

Returns the value of attribute idp_metadata_url.



32
33
34
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 32

def idp_metadata_url
  @idp_metadata_url
end

#idp_sso_url ⇒ Object

Returns the value of attribute idp_sso_url.



28
29
30
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 28

def idp_sso_url
  @idp_sso_url
end

#name ⇒ Object

Returns the value of attribute name.



22
23
24
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 22

def name
  @name
end

#object ⇒ Object

Returns the value of attribute object.



18
19
20
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 18

def object
  @object
end

#organization_id ⇒ Object

Returns the value of attribute organization_id.



42
43
44
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 42

def organization_id
  @organization_id
end

#provider ⇒ Object

Returns the value of attribute provider.



48
49
50
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 48

def provider
  @provider
end

#sp_entity_id ⇒ Object

Returns the value of attribute sp_entity_id.



38
39
40
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 38

def sp_entity_id
  @sp_entity_id
end

#sp_metadata_url ⇒ Object

Returns the value of attribute sp_metadata_url.



40
41
42
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 40

def sp_metadata_url
  @sp_metadata_url
end

#sync_user_attributes ⇒ Object

Returns the value of attribute sync_user_attributes.



52
53
54
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 52

def sync_user_attributes
  @sync_user_attributes
end

#updated_at ⇒ Object

Unix timestamp of last update.



64
65
66
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 64

def updated_at
  @updated_at
end

#user_count ⇒ Object

Returns the value of attribute user_count.



50
51
52
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 50

def user_count
  @user_count
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 464

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = ClerkHttpClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



118
119
120
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 118

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 89

def self.attribute_map
  {
    :'object' => :'object',
    :'id' => :'id',
    :'name' => :'name',
    :'domain' => :'domain',
    :'idp_entity_id' => :'idp_entity_id',
    :'idp_sso_url' => :'idp_sso_url',
    :'idp_certificate' => :'idp_certificate',
    :'idp_metadata_url' => :'idp_metadata_url',
    :'idp_metadata' => :'idp_metadata',
    :'acs_url' => :'acs_url',
    :'sp_entity_id' => :'sp_entity_id',
    :'sp_metadata_url' => :'sp_metadata_url',
    :'organization_id' => :'organization_id',
    :'attribute_mapping' => :'attribute_mapping',
    :'active' => :'active',
    :'provider' => :'provider',
    :'user_count' => :'user_count',
    :'sync_user_attributes' => :'sync_user_attributes',
    :'allow_subdomains' => :'allow_subdomains',
    :'allow_idp_initiated' => :'allow_idp_initiated',
    :'disable_additional_identifications' => :'disable_additional_identifications',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
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



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 440

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



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 152

def self.openapi_nullable
  Set.new([
    :'idp_entity_id',
    :'idp_sso_url',
    :'idp_certificate',
    :'idp_metadata_url',
    :'idp_metadata',
    :'organization_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 123

def self.openapi_types
  {
    :'object' => :'String',
    :'id' => :'String',
    :'name' => :'String',
    :'domain' => :'String',
    :'idp_entity_id' => :'String',
    :'idp_sso_url' => :'String',
    :'idp_certificate' => :'String',
    :'idp_metadata_url' => :'String',
    :'idp_metadata' => :'String',
    :'acs_url' => :'String',
    :'sp_entity_id' => :'String',
    :'sp_metadata_url' => :'String',
    :'organization_id' => :'String',
    :'attribute_mapping' => :'SchemasSAMLConnectionAttributeMapping',
    :'active' => :'Boolean',
    :'provider' => :'String',
    :'user_count' => :'Integer',
    :'sync_user_attributes' => :'Boolean',
    :'allow_subdomains' => :'Boolean',
    :'allow_idp_initiated' => :'Boolean',
    :'disable_additional_identifications' => :'Boolean',
    :'created_at' => :'Integer',
    :'updated_at' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 397

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      object == o.object &&
      id == o.id &&
      name == o.name &&
      domain == o.domain &&
      idp_entity_id == o.idp_entity_id &&
      idp_sso_url == o.idp_sso_url &&
      idp_certificate == o.idp_certificate &&
      idp_metadata_url == o.idp_metadata_url &&
      idp_metadata == o.idp_metadata &&
      acs_url == o.acs_url &&
      sp_entity_id == o.sp_entity_id &&
      sp_metadata_url == o.sp_metadata_url &&
      organization_id == o.organization_id &&
      attribute_mapping == o.attribute_mapping &&
      active == o.active &&
      provider == o.provider &&
      user_count == o.user_count &&
      sync_user_attributes == o.sync_user_attributes &&
      allow_subdomains == o.allow_subdomains &&
      allow_idp_initiated == o.allow_idp_initiated &&
      disable_additional_identifications == o.disable_additional_identifications &&
      created_at == o.created_at &&
      updated_at == o.updated_at
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 535

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


427
428
429
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 427

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



433
434
435
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 433

def hash
  [object, id, name, domain, idp_entity_id, idp_sso_url, idp_certificate, idp_metadata_url, idp_metadata, acs_url, sp_entity_id, sp_metadata_url, organization_id, attribute_mapping, active, provider, user_count, sync_user_attributes, allow_subdomains, allow_idp_initiated, disable_additional_identifications, created_at, updated_at].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



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
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 305

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

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

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

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

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



511
512
513
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 511

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 517

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



505
506
507
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 505

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/clerk-http-client/models/schemas_saml_connection.rb', line 365

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["saml_connection"])
  return false unless object_validator.valid?(@object)
  return false if @id.nil?
  return false if @name.nil?
  return false if @domain.nil?
  return false if @acs_url.nil?
  return false if @sp_entity_id.nil?
  return false if @sp_metadata_url.nil?
  return false if @active.nil?
  return false if @provider.nil?
  return false if @user_count.nil?
  return false if @sync_user_attributes.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  true
end