Class: TalonOne::SamlConnection

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/saml_connection.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SamlConnection

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
139
140
141
142
143
144
 
# File 'lib/talon_one/models/saml_connection.rb', line 91

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'created')
    self.created = attributes[:'created']
  end

  if attributes.has_key?(:'accountId')
    self. = attributes[:'accountId']
  end

  if attributes.has_key?(:'assertionConsumerServiceURL')
    self.assertion_consumer_service_url = attributes[:'assertionConsumerServiceURL']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

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

  if attributes.has_key?(:'issuer')
    self.issuer = attributes[:'issuer']
  end

  if attributes.has_key?(:'signOnURL')
    self.sign_on_url = attributes[:'signOnURL']
  end

  if attributes.has_key?(:'signOutURL')
    self.sign_out_url = attributes[:'signOutURL']
  end

  if attributes.has_key?(:'metadataURL')
    self.metadata_url = attributes[:'metadataURL']
  end

  if attributes.has_key?(:'x509certificate')
    self.x509certificate = attributes[:'x509certificate']
  end

  if attributes.has_key?(:'audience')
    self.audience = attributes[:'audience']
  end
end

Instance Attribute Details

#account_id ⇒ Object

The ID of the account that owns this SAML Service.



24
25
26
 
# File 'lib/talon_one/models/saml_connection.rb', line 24

def 
  @account_id
end

#assertion_consumer_service_url ⇒ Object

The location where the SAML assertion is sent with a HTTP POST.



27
28
29
 
# File 'lib/talon_one/models/saml_connection.rb', line 27

def assertion_consumer_service_url
  @assertion_consumer_service_url
end

#audience ⇒ Object

The application-defined unique identifier that is the intended audience of the SAML assertion. This is most often the SP Entity ID of your application. When not specified, the ACS URL will be used.



51
52
53
 
# File 'lib/talon_one/models/saml_connection.rb', line 51

def audience
  @audience
end

#created ⇒ Object

Unix timestamp indicating when the session was first created.



21
22
23
 
# File 'lib/talon_one/models/saml_connection.rb', line 21

def created
  @created
end

#enabled ⇒ Object

Determines if this SAML connection active.



33
34
35
 
# File 'lib/talon_one/models/saml_connection.rb', line 33

def enabled
  @enabled
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/talon_one/models/saml_connection.rb', line 18

def id
  @id
end

#issuer ⇒ Object

Identity Provider Entity ID.



36
37
38
 
# File 'lib/talon_one/models/saml_connection.rb', line 36

def issuer
  @issuer
end

#metadata_url ⇒ Object

Metadata URL.



45
46
47
 
# File 'lib/talon_one/models/saml_connection.rb', line 45

def metadata_url
  @metadata_url
end

#name ⇒ Object

ID of the SAML service.



30
31
32
 
# File 'lib/talon_one/models/saml_connection.rb', line 30

def name
  @name
end

#sign_on_url ⇒ Object

Single Sign-On URL.



39
40
41
 
# File 'lib/talon_one/models/saml_connection.rb', line 39

def sign_on_url
  @sign_on_url
end

#sign_out_url ⇒ Object

Single Sign-Out URL.



42
43
44
 
# File 'lib/talon_one/models/saml_connection.rb', line 42

def sign_out_url
  @sign_out_url
end

#x509certificate ⇒ Object

X.509 Certificate.



48
49
50
 
# File 'lib/talon_one/models/saml_connection.rb', line 48

def x509certificate
  @x509certificate
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/talon_one/models/saml_connection.rb', line 54

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'account_id' => :'accountId',
    :'assertion_consumer_service_url' => :'assertionConsumerServiceURL',
    :'name' => :'name',
    :'enabled' => :'enabled',
    :'issuer' => :'issuer',
    :'sign_on_url' => :'signOnURL',
    :'sign_out_url' => :'signOutURL',
    :'metadata_url' => :'metadataURL',
    :'x509certificate' => :'x509certificate',
    :'audience' => :'audience'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/talon_one/models/saml_connection.rb', line 72

def self.swagger_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'account_id' => :'Integer',
    :'assertion_consumer_service_url' => :'String',
    :'name' => :'String',
    :'enabled' => :'BOOLEAN',
    :'issuer' => :'String',
    :'sign_on_url' => :'String',
    :'sign_out_url' => :'String',
    :'metadata_url' => :'String',
    :'x509certificate' => :'String',
    :'audience' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/talon_one/models/saml_connection.rb', line 287

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
       == o. &&
      assertion_consumer_service_url == o.assertion_consumer_service_url &&
      name == o.name &&
      enabled == o.enabled &&
      issuer == o.issuer &&
      sign_on_url == o.sign_on_url &&
      sign_out_url == o.sign_out_url &&
      metadata_url == o.metadata_url &&
      x509certificate == o.x509certificate &&
      audience == o.audience
end

#_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



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
 
# File 'lib/talon_one/models/saml_connection.rb', line 340

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = TalonOne.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/talon_one/models/saml_connection.rb', line 406

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

#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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/talon_one/models/saml_connection.rb', line 319

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


306
307
308
 
# File 'lib/talon_one/models/saml_connection.rb', line 306

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



312
313
314
 
# File 'lib/talon_one/models/saml_connection.rb', line 312

def hash
  [id, created, , assertion_consumer_service_url, name, enabled, issuer, sign_on_url, sign_out_url, metadata_url, x509certificate, audience].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



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
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/talon_one/models/saml_connection.rb', line 148

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

  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 great than or equal to 1.')
  end

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

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

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

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

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

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

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

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



386
387
388
 
# File 'lib/talon_one/models/saml_connection.rb', line 386

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



392
393
394
395
396
397
398
399
400
 
# File 'lib/talon_one/models/saml_connection.rb', line 392

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



380
381
382
 
# File 'lib/talon_one/models/saml_connection.rb', line 380

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/talon_one/models/saml_connection.rb', line 211

def valid?
  return false if @id.nil?
  return false if @created.nil?
  return false if @account_id.nil?
  return false if @assertion_consumer_service_url.nil?
  return false if @name.nil?
  return false if @name.to_s.length < 1
  return false if @enabled.nil?
  return false if @issuer.nil?
  return false if @issuer.to_s.length < 1
  return false if @sign_on_url.nil?
  return false if @sign_on_url.to_s.length < 1
  return false if @x509certificate.nil?
  return false if @x509certificate.to_s.length < 1
  return false if @audience.nil?
  true
end