Class: ClerkHttpClient::OAuthApplicationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OAuthApplicationsApi

Returns a new instance of OAuthApplicationsApi.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/clerk-http-client/api/oauth_applications_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_oauth_application(opts = {}) ⇒ OAuthApplicationWithSecret

Create an OAuth application Creates a new OAuth application with the given name and callback URL for an instance. The callback URL must be a valid url. All URL schemes are allowed such as ‘http://`, `https://`, `myapp://`, etc…

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



28
29
30
31
 
# File 'lib/clerk-http-client/api/oauth_applications_api.rb', line 28

def create_oauth_application(opts = {})
  data, _status_code, _headers = create_oauth_application_with_http_info(opts)
  data
end

#create_oauth_application_with_http_info(opts = {}) ⇒ Array<(OAuthApplicationWithSecret, Integer, Hash)>

Create an OAuth application Creates a new OAuth application with the given name and callback URL for an instance. The callback URL must be a valid url. All URL schemes are allowed such as &#x60;&#x60;, &#x60;&#x60;, &#x60;myapp://&#x60;, etc… POST

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(OAuthApplicationWithSecret, Integer, Hash)>) —

    OAuthApplicationWithSecret data, response status code and response headers



39
40
41
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
 
# File 'lib/clerk-http-client/api/oauth_applications_api.rb', line 39

def create_oauth_application_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuthApplicationsApi.create_oauth_application ...'
  end
  # resource path
  local_var_path = '/oauth_applications'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_oauth_application_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'OAuthApplicationWithSecret'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"OAuthApplicationsApi.create_oauth_application",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApplicationsApi#create_oauth_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_oauth_application(oauth_application_id, opts = {}) ⇒ DeletedObject

Delete an OAuth application Deletes the given OAuth application. This is not reversible.

Parameters:

  • oauth_application_id (String) —

    The ID of the OAuth application to delete

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/clerk-http-client/api/oauth_applications_api.rb', line 94

def delete_oauth_application(oauth_application_id, opts = {})
  data, _status_code, _headers = delete_oauth_application_with_http_info(oauth_application_id, opts)
  data
end

#delete_oauth_application_with_http_info(oauth_application_id, opts = {}) ⇒ Array<(DeletedObject, Integer, Hash)>

Delete an OAuth application Deletes the given OAuth application. This is not reversible. DELETE

Parameters:

  • oauth_application_id (String) —

    The ID of the OAuth application to delete

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

    the optional parameters

Returns:

  • (Array<(DeletedObject, Integer, Hash)>) —

    DeletedObject data, response status code and response headers



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
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/clerk-http-client/api/oauth_applications_api.rb', line 105

def delete_oauth_application_with_http_info(oauth_application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuthApplicationsApi.delete_oauth_application ...'
  end
  # verify the required parameter 'oauth_application_id' is set
  if @api_client.config.client_side_validation && oauth_application_id.nil?
    fail ArgumentError, "Missing the required parameter 'oauth_application_id' when calling OAuthApplicationsApi.delete_oauth_application"
  end
  # resource path
  local_var_path = '/oauth_applications/{oauth_application_id}'.sub('{' + 'oauth_application_id' + '}', CGI.escape(oauth_application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DeletedObject'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"OAuthApplicationsApi.delete_oauth_application",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApplicationsApi#delete_oauth_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_oauth_application(oauth_application_id, opts = {}) ⇒ OAuthApplication

Retrieve an OAuth application by ID Fetches the OAuth application whose ID matches the provided ‘id` in the path.

Parameters:

  • oauth_application_id (String) —

    The ID of the OAuth application

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

    the optional parameters

Returns:



159
160
161
162
 
# File 'lib/clerk-http-client/api/oauth_applications_api.rb', line 159

def get_oauth_application(oauth_application_id, opts = {})
  data, _status_code, _headers = get_oauth_application_with_http_info(oauth_application_id, opts)
  data
end

#get_oauth_application_with_http_info(oauth_application_id, opts = {}) ⇒ Array<(OAuthApplication, Integer, Hash)>

Retrieve an OAuth application by ID Fetches the OAuth application whose ID matches the provided &#x60;id&#x60; in the path. GET

Parameters:

  • oauth_application_id (String) —

    The ID of the OAuth application

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

    the optional parameters

Returns:

  • (Array<(OAuthApplication, Integer, Hash)>) —

    OAuthApplication data, response status code and response headers



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
 
# File 'lib/clerk-http-client/api/oauth_applications_api.rb', line 170

def get_oauth_application_with_http_info(oauth_application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuthApplicationsApi.get_oauth_application ...'
  end
  # verify the required parameter 'oauth_application_id' is set
  if @api_client.config.client_side_validation && oauth_application_id.nil?
    fail ArgumentError, "Missing the required parameter 'oauth_application_id' when calling OAuthApplicationsApi.get_oauth_application"
  end
  # resource path
  local_var_path = '/oauth_applications/{oauth_application_id}'.sub('{' + 'oauth_application_id' + '}', CGI.escape(oauth_application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'OAuthApplication'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"OAuthApplicationsApi.get_oauth_application",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApplicationsApi#get_oauth_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_oauth_applications(opts = {}) ⇒ OAuthApplications

Get a list of OAuth applications for an instance This request returns the list of OAuth applications for an instance. Results can be paginated using the optional ‘limit` and `offset` query parameters. The OAuth applications are ordered by descending creation date. Most recent OAuth applications will be returned first.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Float) —

    Applies a limit to the number of results returned. Can be used for paginating the results together with &#x60;offset&#x60;. (default to 10)

  • :offset (Float) —

    Skip the first &#x60;offset&#x60; results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with &#x60;limit&#x60;. (default to 0)

Returns:



225
226
227
228
 
# File 'lib/clerk-http-client/api/oauth_applications_api.rb', line 225

def list_oauth_applications(opts = {})
  data, _status_code, _headers = list_oauth_applications_with_http_info(opts)
  data
end

#list_oauth_applications_with_http_info(opts = {}) ⇒ Array<(OAuthApplications, Integer, Hash)>

Get a list of OAuth applications for an instance This request returns the list of OAuth applications for an instance. Results can be paginated using the optional &#x60;limit&#x60; and &#x60;offset&#x60; query parameters. The OAuth applications are ordered by descending creation date. Most recent OAuth applications will be returned first. GET

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Float) —

    Applies a limit to the number of results returned. Can be used for paginating the results together with &#x60;offset&#x60;. (default to 10)

  • :offset (Float) —

    Skip the first &#x60;offset&#x60; results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with &#x60;limit&#x60;. (default to 0)

Returns:

  • (Array<(OAuthApplications, Integer, Hash)>) —

    OAuthApplications data, response status code and response headers



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
 
# File 'lib/clerk-http-client/api/oauth_applications_api.rb', line 237

def list_oauth_applications_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuthApplicationsApi.list_oauth_applications ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling OAuthApplicationsApi.list_oauth_applications, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling OAuthApplicationsApi.list_oauth_applications, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling OAuthApplicationsApi.list_oauth_applications, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/oauth_applications'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'OAuthApplications'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"OAuthApplicationsApi.list_oauth_applications",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApplicationsApi#list_oauth_applications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#rotate_oauth_application_secret(oauth_application_id, opts = {}) ⇒ OAuthApplicationWithSecret

Rotate the client secret of the given OAuth application Rotates the OAuth application’s client secret. When the client secret is rotated, make sure to update it in authorized OAuth clients.

Parameters:

  • oauth_application_id (String) —

    The ID of the OAuth application for which to rotate the client secret

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

    the optional parameters

Returns:



301
302
303
304
 
# File 'lib/clerk-http-client/api/oauth_applications_api.rb', line 301

def rotate_oauth_application_secret(oauth_application_id, opts = {})
  data, _status_code, _headers = rotate_oauth_application_secret_with_http_info(oauth_application_id, opts)
  data
end

#rotate_oauth_application_secret_with_http_info(oauth_application_id, opts = {}) ⇒ Array<(OAuthApplicationWithSecret, Integer, Hash)>

Rotate the client secret of the given OAuth application Rotates the OAuth application&#39;s client secret. When the client secret is rotated, make sure to update it in authorized OAuth clients. POST

Parameters:

  • oauth_application_id (String) —

    The ID of the OAuth application for which to rotate the client secret

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

    the optional parameters

Returns:

  • (Array<(OAuthApplicationWithSecret, Integer, Hash)>) —

    OAuthApplicationWithSecret data, response status code and response headers



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
350
351
352
353
354
355
356
357
358
 
# File 'lib/clerk-http-client/api/oauth_applications_api.rb', line 312

def rotate_oauth_application_secret_with_http_info(oauth_application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuthApplicationsApi.rotate_oauth_application_secret ...'
  end
  # verify the required parameter 'oauth_application_id' is set
  if @api_client.config.client_side_validation && oauth_application_id.nil?
    fail ArgumentError, "Missing the required parameter 'oauth_application_id' when calling OAuthApplicationsApi.rotate_oauth_application_secret"
  end
  # resource path
  local_var_path = '/oauth_applications/{oauth_application_id}/rotate_secret'.sub('{' + 'oauth_application_id' + '}', CGI.escape(oauth_application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'OAuthApplicationWithSecret'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"OAuthApplicationsApi.rotate_oauth_application_secret",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApplicationsApi#rotate_oauth_application_secret\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_oauth_application(oauth_application_id, update_oauth_application_request, opts = {}) ⇒ OAuthApplication

Update an OAuth application Updates an existing OAuth application

Parameters:

  • oauth_application_id (String) —

    The ID of the OAuth application to update

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

    the optional parameters

Returns:



367
368
369
370
 
# File 'lib/clerk-http-client/api/oauth_applications_api.rb', line 367

def update_oauth_application(oauth_application_id, update_oauth_application_request, opts = {})
  data, _status_code, _headers = update_oauth_application_with_http_info(oauth_application_id, update_oauth_application_request, opts)
  data
end

#update_oauth_application_with_http_info(oauth_application_id, update_oauth_application_request, opts = {}) ⇒ Array<(OAuthApplication, Integer, Hash)>

Update an OAuth application Updates an existing OAuth application PATCH

Parameters:

  • oauth_application_id (String) —

    The ID of the OAuth application to update

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

    the optional parameters

Returns:

  • (Array<(OAuthApplication, Integer, Hash)>) —

    OAuthApplication data, response status code and response headers



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
427
428
429
430
431
432
433
434
 
# File 'lib/clerk-http-client/api/oauth_applications_api.rb', line 379

def update_oauth_application_with_http_info(oauth_application_id, update_oauth_application_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuthApplicationsApi.update_oauth_application ...'
  end
  # verify the required parameter 'oauth_application_id' is set
  if @api_client.config.client_side_validation && oauth_application_id.nil?
    fail ArgumentError, "Missing the required parameter 'oauth_application_id' when calling OAuthApplicationsApi.update_oauth_application"
  end
  # verify the required parameter 'update_oauth_application_request' is set
  if @api_client.config.client_side_validation && update_oauth_application_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_oauth_application_request' when calling OAuthApplicationsApi.update_oauth_application"
  end
  # resource path
  local_var_path = '/oauth_applications/{oauth_application_id}'.sub('{' + 'oauth_application_id' + '}', CGI.escape(oauth_application_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_oauth_application_request)

  # return_type
  return_type = opts[:debug_return_type] || 'OAuthApplication'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"OAuthApplicationsApi.update_oauth_application",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApplicationsApi#update_oauth_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end