Class: PureCloud::OAuthClient

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OAuthClient

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
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/o_auth_client.rb', line 155

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

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

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

  
  if attributes.has_key?(:'registeredRedirectUri')
    
    if (value = attributes[:'registeredRedirectUri']).is_a?(Array)
      self.registered_redirect_uri = value
    end
    
    
  
  end

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

  
  if attributes.has_key?(:'roleIds')
    
    if (value = attributes[:'roleIds']).is_a?(Array)
      self.role_ids = value
    end
    
    
  
  end

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

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

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

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

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

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

  
  if attributes.has_key?(:'roleDivisions')
    
    if (value = attributes[:'roleDivisions']).is_a?(Array)
      self.role_divisions = value
    end
    
    
  
  end

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

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

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

  
end

Instance Attribute Details

#access_token_validity_seconds ⇒ Object

The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied.



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 28

def access_token_validity_seconds
  @access_token_validity_seconds
end

#authorized_grant_type ⇒ Object

The OAuth Grant/Client type supported by this client. Code Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured. Implicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured. SAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint. Client Credential grant type - Used to created access tokens that are tied only to the client.



54
55
56
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 54

def authorized_grant_type
  @authorized_grant_type
end

#created_by ⇒ Object

User that created this client



48
49
50
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 48

def created_by
  @created_by
end

#date_created ⇒ Object

Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



42
43
44
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 42

def date_created
  @date_created
end

#date_modified ⇒ Object

Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



45
46
47
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 45

def date_modified
  @date_modified
end

#date_to_delete ⇒ Object

The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



66
67
68
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 66

def date_to_delete
  @date_to_delete
end

#description ⇒ Object

Returns the value of attribute description.



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 30

def description
  @description
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 22

def id
  @id
end

#modified_by ⇒ Object

User that last modified this client



51
52
53
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 51

def modified_by
  @modified_by
end

#name ⇒ Object

The name of the OAuth client.



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 25

def name
  @name
end

#registered_redirect_uri ⇒ Object

List of allowed callbacks for this client. For example: myap.example.com/auth/callback



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 33

def registered_redirect_uri
  @registered_redirect_uri
end

#role_divisions ⇒ Object

Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant



60
61
62
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 60

def role_divisions
  @role_divisions
end

#role_ids ⇒ Object

Deprecated. Use roleDivisions instead.



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 39

def role_ids
  @role_ids
end

#scope ⇒ Object

The scope requested by this client. Scopes only apply to clients not using the client_credential grant



57
58
59
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 57

def scope
  @scope
end

#secret ⇒ Object

System created secret assigned to this client. Secrets are required for code authorization and client credential grants.



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 36

def secret
  @secret
end

#self_uri ⇒ Object

The URI for this object



69
70
71
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 69

def self_uri
  @self_uri
end

#state ⇒ Object

The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted.



63
64
65
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 63

def state
  @state
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
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
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 72

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'access_token_validity_seconds' => :'accessTokenValiditySeconds',
    
    :'description' => :'description',
    
    :'registered_redirect_uri' => :'registeredRedirectUri',
    
    :'secret' => :'secret',
    
    :'role_ids' => :'roleIds',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'created_by' => :'createdBy',
    
    :'modified_by' => :'modifiedBy',
    
    :'authorized_grant_type' => :'authorizedGrantType',
    
    :'scope' => :'scope',
    
    :'role_divisions' => :'roleDivisions',
    
    :'state' => :'state',
    
    :'date_to_delete' => :'dateToDelete',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
145
146
147
148
149
150
151
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 113

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'access_token_validity_seconds' => :'Integer',
    
    :'description' => :'String',
    
    :'registered_redirect_uri' => :'Array<String>',
    
    :'secret' => :'String',
    
    :'role_ids' => :'Array<String>',
    
    :'date_created' => :'DateTime',
    
    :'date_modified' => :'DateTime',
    
    :'created_by' => :'DomainEntityRef',
    
    :'modified_by' => :'DomainEntityRef',
    
    :'authorized_grant_type' => :'String',
    
    :'scope' => :'Array<String>',
    
    :'role_divisions' => :'Array<RoleDivision>',
    
    :'state' => :'String',
    
    :'date_to_delete' => :'DateTime',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 534

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      access_token_validity_seconds == o.access_token_validity_seconds &&
      description == o.description &&
      registered_redirect_uri == o.registered_redirect_uri &&
      secret == o.secret &&
      role_ids == o.role_ids &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      created_by == o.created_by &&
      modified_by == o.modified_by &&
      authorized_grant_type == o.authorized_grant_type &&
      scope == o.scope &&
      role_divisions == o.role_divisions &&
      state == o.state &&
      date_to_delete == o.date_to_delete &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 588

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



648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 648

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



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 569

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


558
559
560
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 558

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



564
565
566
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 564

def hash
  [id, name, access_token_validity_seconds, description, registered_redirect_uri, secret, role_ids, date_created, date_modified, created_by, modified_by, authorized_grant_type, scope, role_divisions, state, date_to_delete, self_uri].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



327
328
329
330
331
332
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 327

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))



631
632
633
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 631

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



636
637
638
639
640
641
642
643
644
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 636

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 



626
627
628
 
# File 'lib/purecloudplatformclientv2/models/o_auth_client.rb', line 626

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



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

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

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if @authorized_grant_type.nil?
    return false
  end

  
  
  allowed_values = ["CODE", "TOKEN", "SAML2BEARER", "PASSWORD", "CLIENT_CREDENTIALS"]
  if @authorized_grant_type && !allowed_values.include?(@authorized_grant_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["active", "disabled", "inactive"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end