Class: PureCloud::OAuthApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/api/o_auth_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OAuthApi

Returns a new instance of OAuthApi.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 23

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_oauth_client(client_id, opts = {}) ⇒ nil

Delete OAuth Client

Parameters:

  • client_id —

    Client ID

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

    the optional parameters

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 32

def delete_oauth_client(client_id, opts = {})
  delete_oauth_client_with_http_info(client_id, opts)
  return nil
end

#delete_oauth_client_with_http_info(client_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete OAuth Client

Parameters:

  • client_id —

    Client ID

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 42

def delete_oauth_client_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi.delete_oauth_client ..."
  end
  
  
  # verify the required parameter 'client_id' is set
  fail ArgumentError, "Missing the required parameter 'client_id' when calling OAuthApi.delete_oauth_client" if client_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/oauth/clients/{clientId}".sub('{format}','json').sub('{' + 'clientId' + '}', client_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#delete_oauth_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_oauth_authorization(client_id, opts = {}) ⇒ OAuthAuthorization

Get a client that is authorized by the resource owner

Parameters:

  • client_id —

    The ID of client

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

    the optional parameters

Returns:



96
97
98
99
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 96

def get_oauth_authorization(client_id, opts = {})
  data, _status_code, _headers = get_oauth_authorization_with_http_info(client_id, opts)
  return data
end

#get_oauth_authorization_with_http_info(client_id, opts = {}) ⇒ Array<(OAuthAuthorization, Fixnum, Hash)>

Get a client that is authorized by the resource owner

Parameters:

  • client_id —

    The ID of client

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

    the optional parameters

Returns:

  • (Array<(OAuthAuthorization, Fixnum, Hash)>) —

    OAuthAuthorization data, response status code and response headers



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
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 106

def get_oauth_authorization_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi.get_oauth_authorization ..."
  end
  
  
  # verify the required parameter 'client_id' is set
  fail ArgumentError, "Missing the required parameter 'client_id' when calling OAuthApi.get_oauth_authorization" if client_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/oauth/authorizations/{clientId}".sub('{format}','json').sub('{' + 'clientId' + '}', client_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthAuthorization')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#get_oauth_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_oauth_authorizations(opts = {}) ⇒ OAuthAuthorizationListing

List clients that are authorized by the resource owner

Parameters:

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

    the optional parameters

Returns:



160
161
162
163
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 160

def get_oauth_authorizations(opts = {})
  data, _status_code, _headers = get_oauth_authorizations_with_http_info(opts)
  return data
end

#get_oauth_authorizations_with_http_info(opts = {}) ⇒ Array<(OAuthAuthorizationListing, Fixnum, Hash)>

List clients that are authorized by the resource owner

Parameters:

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

    the optional parameters

Returns:

  • (Array<(OAuthAuthorizationListing, Fixnum, Hash)>) —

    OAuthAuthorizationListing data, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 169

def get_oauth_authorizations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi.get_oauth_authorizations ..."
  end
  
  # resource path
  local_var_path = "/api/v2/oauth/authorizations".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthAuthorizationListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#get_oauth_authorizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_oauth_client(client_id, opts = {}) ⇒ OAuthClient

Get OAuth Client

Parameters:

  • client_id —

    Client ID

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

    the optional parameters

Returns:



216
217
218
219
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 216

def get_oauth_client(client_id, opts = {})
  data, _status_code, _headers = get_oauth_client_with_http_info(client_id, opts)
  return data
end

#get_oauth_client_usage_query_result(execution_id, client_id, opts = {}) ⇒ ApiUsageQueryResult

Get the results of a usage query

Parameters:

  • execution_id —

    ID of the query execution

  • client_id —

    Client ID

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

    the optional parameters

Returns:



282
283
284
285
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 282

def get_oauth_client_usage_query_result(execution_id, client_id, opts = {})
  data, _status_code, _headers = get_oauth_client_usage_query_result_with_http_info(execution_id, client_id, opts)
  return data
end

#get_oauth_client_usage_query_result_with_http_info(execution_id, client_id, opts = {}) ⇒ Array<(ApiUsageQueryResult, Fixnum, Hash)>

Get the results of a usage query

Parameters:

  • execution_id —

    ID of the query execution

  • client_id —

    Client ID

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

    the optional parameters

Returns:

  • (Array<(ApiUsageQueryResult, Fixnum, Hash)>) —

    ApiUsageQueryResult data, response status code and response headers



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
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
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 293

def get_oauth_client_usage_query_result_with_http_info(execution_id, client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi.get_oauth_client_usage_query_result ..."
  end
  
  
  # verify the required parameter 'execution_id' is set
  fail ArgumentError, "Missing the required parameter 'execution_id' when calling OAuthApi.get_oauth_client_usage_query_result" if execution_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'client_id' is set
  fail ArgumentError, "Missing the required parameter 'client_id' when calling OAuthApi.get_oauth_client_usage_query_result" if client_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}".sub('{format}','json').sub('{' + 'executionId' + '}', execution_id.to_s).sub('{' + 'clientId' + '}', client_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiUsageQueryResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#get_oauth_client_usage_query_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_oauth_client_usage_summary(client_id, opts = {}) ⇒ UsageExecutionResult

Get a summary of OAuth client API usage After calling this method, you will then need to poll for the query results based on the returned execution Id

Parameters:

  • client_id —

    Client ID

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

    the optional parameters

Options Hash (opts):

  • :days (String) —

    Previous number of days to query (default to 7)

Returns:



357
358
359
360
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 357

def get_oauth_client_usage_summary(client_id, opts = {})
  data, _status_code, _headers = get_oauth_client_usage_summary_with_http_info(client_id, opts)
  return data
end

#get_oauth_client_usage_summary_with_http_info(client_id, opts = {}) ⇒ Array<(UsageExecutionResult, Fixnum, Hash)>

Get a summary of OAuth client API usage After calling this method, you will then need to poll for the query results based on the returned execution Id

Parameters:

  • client_id —

    Client ID

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

    the optional parameters

Options Hash (opts):

  • :days (String) —

    Previous number of days to query

Returns:

  • (Array<(UsageExecutionResult, Fixnum, Hash)>) —

    UsageExecutionResult data, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 368

def get_oauth_client_usage_summary_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi.get_oauth_client_usage_summary ..."
  end
  
  
  # verify the required parameter 'client_id' is set
  fail ArgumentError, "Missing the required parameter 'client_id' when calling OAuthApi.get_oauth_client_usage_summary" if client_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/oauth/clients/{clientId}/usage/summary".sub('{format}','json').sub('{' + 'clientId' + '}', client_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'days'] = opts[:'days'] if opts[:'days']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UsageExecutionResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#get_oauth_client_usage_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_oauth_client_with_http_info(client_id, opts = {}) ⇒ Array<(OAuthClient, Fixnum, Hash)>

Get OAuth Client

Parameters:

  • client_id —

    Client ID

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

    the optional parameters

Returns:

  • (Array<(OAuthClient, Fixnum, Hash)>) —

    OAuthClient data, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 226

def get_oauth_client_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi.get_oauth_client ..."
  end
  
  
  # verify the required parameter 'client_id' is set
  fail ArgumentError, "Missing the required parameter 'client_id' when calling OAuthApi.get_oauth_client" if client_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/oauth/clients/{clientId}".sub('{format}','json').sub('{' + 'clientId' + '}', client_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthClient')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#get_oauth_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_oauth_clients(opts = {}) ⇒ OAuthClientEntityListing

The list of OAuth clients

Parameters:

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

    the optional parameters

Returns:



429
430
431
432
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 429

def get_oauth_clients(opts = {})
  data, _status_code, _headers = get_oauth_clients_with_http_info(opts)
  return data
end

#get_oauth_clients_with_http_info(opts = {}) ⇒ Array<(OAuthClientEntityListing, Fixnum, Hash)>

The list of OAuth clients

Parameters:

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

    the optional parameters

Returns:

  • (Array<(OAuthClientEntityListing, Fixnum, Hash)>) —

    OAuthClientEntityListing data, response status code and response headers



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 438

def get_oauth_clients_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi.get_oauth_clients ..."
  end
  
  # resource path
  local_var_path = "/api/v2/oauth/clients".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthClientEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#get_oauth_clients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_oauth_scope(scope_id, opts = {}) ⇒ OAuthScope

An OAuth scope

Parameters:

  • scope_id —

    Scope ID

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    The language with which to display the scope description. (default to en-us)

Returns:



486
487
488
489
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 486

def get_oauth_scope(scope_id, opts = {})
  data, _status_code, _headers = get_oauth_scope_with_http_info(scope_id, opts)
  return data
end

#get_oauth_scope_with_http_info(scope_id, opts = {}) ⇒ Array<(OAuthScope, Fixnum, Hash)>

An OAuth scope

Parameters:

  • scope_id —

    Scope ID

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    The language with which to display the scope description.

Returns:

  • (Array<(OAuthScope, Fixnum, Hash)>) —

    OAuthScope data, response status code and response headers



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 497

def get_oauth_scope_with_http_info(scope_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi.get_oauth_scope ..."
  end
  
  
  # verify the required parameter 'scope_id' is set
  fail ArgumentError, "Missing the required parameter 'scope_id' when calling OAuthApi.get_oauth_scope" if scope_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/oauth/scopes/{scopeId}".sub('{format}','json').sub('{' + 'scopeId' + '}', scope_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'Accept-Language'] = opts[:'accept_language'] if opts[:'accept_language']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthScope')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#get_oauth_scope\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_oauth_scopes(opts = {}) ⇒ OAuthScopeListing

The list of OAuth scopes

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    The language with which to display the scope descriptions. (default to en-us)

Returns:



559
560
561
562
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 559

def get_oauth_scopes(opts = {})
  data, _status_code, _headers = get_oauth_scopes_with_http_info(opts)
  return data
end

#get_oauth_scopes_with_http_info(opts = {}) ⇒ Array<(OAuthScopeListing, Fixnum, Hash)>

The list of OAuth scopes

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    The language with which to display the scope descriptions.

Returns:

  • (Array<(OAuthScopeListing, Fixnum, Hash)>) —

    OAuthScopeListing data, response status code and response headers



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
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
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 569

def get_oauth_scopes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi.get_oauth_scopes ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/oauth/scopes".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'Accept-Language'] = opts[:'accept_language'] if opts[:'accept_language']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthScopeListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#get_oauth_scopes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_oauth_client_secret(client_id, opts = {}) ⇒ OAuthClient

Regenerate Client Secret This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.

Parameters:

  • client_id —

    Client ID

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

    the optional parameters

Returns:



623
624
625
626
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 623

def post_oauth_client_secret(client_id, opts = {})
  data, _status_code, _headers = post_oauth_client_secret_with_http_info(client_id, opts)
  return data
end

#post_oauth_client_secret_with_http_info(client_id, opts = {}) ⇒ Array<(OAuthClient, Fixnum, Hash)>

Regenerate Client Secret This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.

Parameters:

  • client_id —

    Client ID

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

    the optional parameters

Returns:

  • (Array<(OAuthClient, Fixnum, Hash)>) —

    OAuthClient data, response status code and response headers



633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 633

def post_oauth_client_secret_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi.post_oauth_client_secret ..."
  end
  
  
  # verify the required parameter 'client_id' is set
  fail ArgumentError, "Missing the required parameter 'client_id' when calling OAuthApi.post_oauth_client_secret" if client_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/oauth/clients/{clientId}/secret".sub('{format}','json').sub('{' + 'clientId' + '}', client_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthClient')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#post_oauth_client_secret\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_oauth_client_usage_query(client_id, body, opts = {}) ⇒ UsageExecutionResult

Query for OAuth client API usage After calling this method, you will then need to poll for the query results based on the returned execution Id

Parameters:

  • client_id —

    Client ID

  • body —

    Query

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

    the optional parameters

Returns:



689
690
691
692
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 689

def post_oauth_client_usage_query(client_id, body, opts = {})
  data, _status_code, _headers = post_oauth_client_usage_query_with_http_info(client_id, body, opts)
  return data
end

#post_oauth_client_usage_query_with_http_info(client_id, body, opts = {}) ⇒ Array<(UsageExecutionResult, Fixnum, Hash)>

Query for OAuth client API usage After calling this method, you will then need to poll for the query results based on the returned execution Id

Parameters:

  • client_id —

    Client ID

  • body —

    Query

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

    the optional parameters

Returns:

  • (Array<(UsageExecutionResult, Fixnum, Hash)>) —

    UsageExecutionResult data, response status code and response headers



700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 700

def post_oauth_client_usage_query_with_http_info(client_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi.post_oauth_client_usage_query ..."
  end
  
  
  # verify the required parameter 'client_id' is set
  fail ArgumentError, "Missing the required parameter 'client_id' when calling OAuthApi.post_oauth_client_usage_query" if client_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OAuthApi.post_oauth_client_usage_query" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/oauth/clients/{clientId}/usage/query".sub('{format}','json').sub('{' + 'clientId' + '}', client_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UsageExecutionResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#post_oauth_client_usage_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_oauth_clients(body, opts = {}) ⇒ OAuthClient

Create OAuth client The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. The preferred authorizedGrantTypes is ‘CODE’ which requires applications to send a client ID and client secret. This is typically a web server. If the client is unable to secure the client secret then the ‘TOKEN’ grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. If a client is to be used outside of the context of a user then the ‘CLIENT-CREDENTIALS’ grant may be used. In this case the client must be granted roles via the ‘roleIds’ field.

Parameters:

  • body —

    Client

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

    the optional parameters

Returns:



763
764
765
766
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 763

def post_oauth_clients(body, opts = {})
  data, _status_code, _headers = post_oauth_clients_with_http_info(body, opts)
  return data
end

#post_oauth_clients_with_http_info(body, opts = {}) ⇒ Array<(OAuthClient, Fixnum, Hash)>

Create OAuth client The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. The preferred authorizedGrantTypes is &#39;CODE&#39; which requires applications to send a client ID and client secret. This is typically a web server. If the client is unable to secure the client secret then the &#39;TOKEN&#39; grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. If a client is to be used outside of the context of a user then the &#39;CLIENT-CREDENTIALS&#39; grant may be used. In this case the client must be granted roles via the &#39;roleIds&#39; field.

Parameters:

  • body —

    Client

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

    the optional parameters

Returns:

  • (Array<(OAuthClient, Fixnum, Hash)>) —

    OAuthClient data, response status code and response headers



773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 773

def post_oauth_clients_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi.post_oauth_clients ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OAuthApi.post_oauth_clients" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/oauth/clients".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthClient')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#post_oauth_clients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_oauth_client(client_id, body, opts = {}) ⇒ OAuthClient

Update OAuth Client

Parameters:

  • client_id —

    Client ID

  • body —

    Client

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

    the optional parameters

Returns:



829
830
831
832
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 829

def put_oauth_client(client_id, body, opts = {})
  data, _status_code, _headers = put_oauth_client_with_http_info(client_id, body, opts)
  return data
end

#put_oauth_client_with_http_info(client_id, body, opts = {}) ⇒ Array<(OAuthClient, Fixnum, Hash)>

Update OAuth Client

Parameters:

  • client_id —

    Client ID

  • body —

    Client

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

    the optional parameters

Returns:

  • (Array<(OAuthClient, Fixnum, Hash)>) —

    OAuthClient data, response status code and response headers



840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/purecloudplatformclientv2/api/o_auth_api.rb', line 840

def put_oauth_client_with_http_info(client_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi.put_oauth_client ..."
  end
  
  
  # verify the required parameter 'client_id' is set
  fail ArgumentError, "Missing the required parameter 'client_id' when calling OAuthApi.put_oauth_client" if client_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OAuthApi.put_oauth_client" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/oauth/clients/{clientId}".sub('{format}','json').sub('{' + 'clientId' + '}', client_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OAuthClient')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#put_oauth_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end