Class: PureCloud::ScimServiceProviderConfigAuthenticationScheme

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb

Overview

Defines an authentication scheme in the SCIM service provider’s configuration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScimServiceProviderConfigAuthenticationScheme

Initializes the object

Parameters:

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

    Model attributes in the form of hash



80
81
82
83
84
85
86
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
139
140
141
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 80

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

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

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

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

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

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

  
end

Instance Attribute Details

#description ⇒ Object

The description of the authentication scheme.



26
27
28
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 26

def description
  @description
end

#documentation_uri ⇒ Object

The HTTP-addressable URL that points to the authentication scheme’s usage documentation.



32
33
34
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 32

def documentation_uri
  @documentation_uri
end

#name ⇒ Object

The name of the authentication scheme, for example, HTTP Basic.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 23

def name
  @name
end

#primary ⇒ Object

Indicates whether this authentication scheme is the primary method of authentication.



38
39
40
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 38

def primary
  @primary
end

#spec_uri ⇒ Object

The HTTP-addressable URL that points to the authentication scheme’s specification.



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 29

def spec_uri
  @spec_uri
end

#type ⇒ Object

The type of authentication scheme.



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 35

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 41

def self.attribute_map
  {
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'spec_uri' => :'specUri',
    
    :'documentation_uri' => :'documentationUri',
    
    :'type' => :'type',
    
    :'primary' => :'primary'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 60

def self.swagger_types
  {
    
    :'name' => :'String',
    
    :'description' => :'String',
    
    :'spec_uri' => :'String',
    
    :'documentation_uri' => :'String',
    
    :'type' => :'String',
    
    :'primary' => :'BOOLEAN'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



244
245
246
247
248
249
250
251
252
253
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 244

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      spec_uri == o.spec_uri &&
      documentation_uri == o.documentation_uri &&
      type == o.type &&
      primary == o.primary
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 287

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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 347

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

build the object from hash



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 268

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


257
258
259
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 257

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



263
264
265
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 263

def hash
  [name, description, spec_uri, documentation_uri, type, primary].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



145
146
147
148
149
150
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 145

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



330
331
332
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 330

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



335
336
337
338
339
340
341
342
343
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 335

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 ⇒ Object 



325
326
327
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 325

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



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
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb', line 154

def valid?
  
  
  if @name.nil?
    return false
  end

  
  
  
  
  
  if @description.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  if @type.nil?
    return false
  end

  
  
  allowed_values = ["oauth", "oauth2", "oauthbearertoken", "httpbasic", "httpdigest"]
  if @type && !allowed_values.include?(@type)
    return false
  end
  
  
  
  
  
  
  
end