Class: PureCloud::OAuthApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/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/purecloud/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/purecloud/api/o_auth_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_clients_client_id(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/purecloud/api/o_auth_api.rb', line 32

def delete_clients_client_id(client_id, opts = {})
  delete_clients_client_id_with_http_info(client_id, opts)
  return nil
end

#delete_clients_client_id_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
 
# File 'lib/purecloud/api/o_auth_api.rb', line 42

def delete_clients_client_id_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#delete_clients_client_id ..."
  end
  
  # verify the required parameter 'client_id' is set
  fail "Missing the required parameter 'client_id' when calling delete_clients_client_id" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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_clients_client_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_clients(opts = {}) ⇒ OAuthClientEntityListing

The list of OAuth clients

Parameters:

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

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/purecloud/api/o_auth_api.rb', line 90

def get_clients(opts = {})
  data, status_code, headers = get_clients_with_http_info(opts)
  return data
end

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

Get OAuth Client

Parameters:

  • client_id —

    Client ID

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

    the optional parameters

Returns:



146
147
148
149
 
# File 'lib/purecloud/api/o_auth_api.rb', line 146

def get_clients_client_id(client_id, opts = {})
  data, status_code, headers = get_clients_client_id_with_http_info(client_id, opts)
  return data
end

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



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

def get_clients_client_id_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#get_clients_client_id ..."
  end
  
  # verify the required parameter 'client_id' is set
  fail "Missing the required parameter 'client_id' when calling get_clients_client_id" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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_clients_client_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



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

def get_clients_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#get_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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_clients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_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. nThe preferred authorizedGrantTypes is ‘CODE’ which requires applications to send a client ID and client secret. This is typically a web server. nIf 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. nIf 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 nvia the ‘roleIds’ field.

Parameters:

  • body —

    Client

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

    the optional parameters

Returns:



206
207
208
209
 
# File 'lib/purecloud/api/o_auth_api.rb', line 206

def post_clients(body, opts = {})
  data, status_code, headers = post_clients_with_http_info(body, opts)
  return data
end

#post_clients_client_id_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:



266
267
268
269
 
# File 'lib/purecloud/api/o_auth_api.rb', line 266

def post_clients_client_id_secret(client_id, opts = {})
  data, status_code, headers = post_clients_client_id_secret_with_http_info(client_id, opts)
  return data
end

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



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

def post_clients_client_id_secret_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#post_clients_client_id_secret ..."
  end
  
  # verify the required parameter 'client_id' is set
  fail "Missing the required parameter 'client_id' when calling post_clients_client_id_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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_clients_client_id_secret\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_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. nThe preferred authorizedGrantTypes is &#39;CODE&#39; which requires applications to send a client ID and client secret. This is typically a web server. nIf 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. nIf 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 nvia 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



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

def post_clients_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#post_clients ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  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_clients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update OAuth Client

Parameters:

  • client_id —

    Client ID

  • body —

    Client

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

    the optional parameters

Returns:



327
328
329
330
 
# File 'lib/purecloud/api/o_auth_api.rb', line 327

def put_clients_client_id(client_id, body, opts = {})
  data, status_code, headers = put_clients_client_id_with_http_info(client_id, body, opts)
  return data
end

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



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

def put_clients_client_id_with_http_info(client_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OAuthApi#put_clients_client_id ..."
  end
  
  # verify the required parameter 'client_id' is set
  fail "Missing the required parameter 'client_id' when calling put_clients_client_id" if client_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_clients_client_id" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  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_clients_client_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end