Class: ClerkHttpClient::UpdateSAMLConnectionRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateSAMLConnectionRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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/clerk-http-client/models/update_saml_connection_request.rb', line 126

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

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

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

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

  if attributes.key?(:'idp_certificate')
    self.idp_certificate = attributes[:'idp_certificate']
  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?(:'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']
  end

  if attributes.key?(:'sync_user_attributes')
    self.sync_user_attributes = attributes[:'sync_user_attributes']
  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
end

Instance Attribute Details

#active ⇒ Object

Activate or de-activate the SAML Connection



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

def active
  @active
end

#allow_idp_initiated ⇒ Object

Enable or deactivate IdP-initiated flows



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

def allow_idp_initiated
  @allow_idp_initiated
end

#allow_subdomains ⇒ Object

Allow users with an email address subdomain to use this connection in order to authenticate



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

def allow_subdomains
  @allow_subdomains
end

#attribute_mapping ⇒ Object

Returns the value of attribute attribute_mapping.



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

def attribute_mapping
  @attribute_mapping
end

#disable_additional_identifications ⇒ Object

Enable or deactivate additional identifications



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

def disable_additional_identifications
  @disable_additional_identifications
end

#domain ⇒ Object

The domain to use for the new SAML Connection



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

def domain
  @domain
end

#idp_certificate ⇒ Object

The x509 certificated as provided by the IdP



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

def idp_certificate
  @idp_certificate
end

#idp_entity_id ⇒ Object

The entity id as provided by the IdP



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

def idp_entity_id
  @idp_entity_id
end

#idp_metadata ⇒ Object

The XML content of the IdP metadata file. If present, it takes priority over the corresponding individual properties



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

def idp_metadata
  @idp_metadata
end

#idp_metadata_url ⇒ Object

The URL which serves the IdP metadata. If present, it takes priority over the corresponding individual properties and replaces them



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

def idp_metadata_url
  @idp_metadata_url
end

#idp_sso_url ⇒ Object

The SSO url as provided by the IdP



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

def idp_sso_url
  @idp_sso_url
end

#name ⇒ Object

The name of the new SAML Connection



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

def name
  @name
end

#organization_id ⇒ Object

The ID of the organization to which users of this SAML Connection will be added



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

def organization_id
  @organization_id
end

#sync_user_attributes ⇒ Object

Controls whether to update the user’s attributes in each sign-in



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

def sync_user_attributes
  @sync_user_attributes
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



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

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



80
81
82
 
# File 'lib/clerk-http-client/models/update_saml_connection_request.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/clerk-http-client/models/update_saml_connection_request.rb', line 60

def self.attribute_map
  {
    :'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',
    :'organization_id' => :'organization_id',
    :'attribute_mapping' => :'attribute_mapping',
    :'active' => :'active',
    :'sync_user_attributes' => :'sync_user_attributes',
    :'allow_subdomains' => :'allow_subdomains',
    :'allow_idp_initiated' => :'allow_idp_initiated',
    :'disable_additional_identifications' => :'disable_additional_identifications'
  }
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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/clerk-http-client/models/update_saml_connection_request.rb', line 247

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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/clerk-http-client/models/update_saml_connection_request.rb', line 105

def self.openapi_nullable
  Set.new([
    :'name',
    :'domain',
    :'idp_entity_id',
    :'idp_sso_url',
    :'idp_certificate',
    :'idp_metadata_url',
    :'idp_metadata',
    :'organization_id',
    :'attribute_mapping',
    :'active',
    :'sync_user_attributes',
    :'allow_subdomains',
    :'allow_idp_initiated',
    :'disable_additional_identifications'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/clerk-http-client/models/update_saml_connection_request.rb', line 85

def self.openapi_types
  {
    :'name' => :'String',
    :'domain' => :'String',
    :'idp_entity_id' => :'String',
    :'idp_sso_url' => :'String',
    :'idp_certificate' => :'String',
    :'idp_metadata_url' => :'String',
    :'idp_metadata' => :'String',
    :'organization_id' => :'String',
    :'attribute_mapping' => :'UpdateSAMLConnectionRequestAttributeMapping',
    :'active' => :'Boolean',
    :'sync_user_attributes' => :'Boolean',
    :'allow_subdomains' => :'Boolean',
    :'allow_idp_initiated' => :'Boolean',
    :'disable_additional_identifications' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/clerk-http-client/models/update_saml_connection_request.rb', line 213

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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 &&
      organization_id == o.organization_id &&
      attribute_mapping == o.attribute_mapping &&
      active == o.active &&
      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
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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/clerk-http-client/models/update_saml_connection_request.rb', line 342

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


234
235
236
 
# File 'lib/clerk-http-client/models/update_saml_connection_request.rb', line 234

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



240
241
242
 
# File 'lib/clerk-http-client/models/update_saml_connection_request.rb', line 240

def hash
  [name, domain, idp_entity_id, idp_sso_url, idp_certificate, idp_metadata_url, idp_metadata, organization_id, attribute_mapping, active, sync_user_attributes, allow_subdomains, allow_idp_initiated, disable_additional_identifications].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



198
199
200
201
202
 
# File 'lib/clerk-http-client/models/update_saml_connection_request.rb', line 198

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



318
319
320
 
# File 'lib/clerk-http-client/models/update_saml_connection_request.rb', line 318

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



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/clerk-http-client/models/update_saml_connection_request.rb', line 324

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



312
313
314
 
# File 'lib/clerk-http-client/models/update_saml_connection_request.rb', line 312

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



206
207
208
209
 
# File 'lib/clerk-http-client/models/update_saml_connection_request.rb', line 206

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end