Class: LaunchDarklyApi::OAuth2ClientsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/launchdarkly_api/api/o_auth2_clients_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OAuth2ClientsApi

Returns a new instance of OAuth2ClientsApi.



19
20
21
 
# File 'lib/launchdarkly_api/api/o_auth2_clients_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/launchdarkly_api/api/o_auth2_clients_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_o_auth2_client(oauth_client_post, opts = {}) ⇒ Client

Create a LaunchDarkly OAuth 2.0 client Create (register) a LaunchDarkly OAuth2 client. OAuth2 clients allow you to build custom integrations using LaunchDarkly as your identity provider.

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/launchdarkly_api/api/o_auth2_clients_api.rb', line 27

def create_o_auth2_client(oauth_client_post, opts = {})
  data, _status_code, _headers = create_o_auth2_client_with_http_info(oauth_client_post, opts)
  data
end

#create_o_auth2_client_with_http_info(oauth_client_post, opts = {}) ⇒ Array<(Client, Integer, Hash)>

Create a LaunchDarkly OAuth 2.0 client Create (register) a LaunchDarkly OAuth2 client. OAuth2 clients allow you to build custom integrations using LaunchDarkly as your identity provider.

Parameters:

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

    the optional parameters

Returns:

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

    Client data, response status code and response headers



37
38
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
87
88
 
# File 'lib/launchdarkly_api/api/o_auth2_clients_api.rb', line 37

def create_o_auth2_client_with_http_info(oauth_client_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuth2ClientsApi.create_o_auth2_client ...'
  end
  # verify the required parameter 'oauth_client_post' is set
  if @api_client.config.client_side_validation && oauth_client_post.nil?
    fail ArgumentError, "Missing the required parameter 'oauth_client_post' when calling OAuth2ClientsApi.create_o_auth2_client"
  end
  # resource path
  local_var_path = '/api/v2/oauth/clients'

  # 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'])
  # 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(oauth_client_post)

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

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

  new_options = opts.merge(
    :operation => :"OAuth2ClientsApi.create_o_auth2_client",
    :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: OAuth2ClientsApi#create_o_auth2_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete OAuth 2.0 client Delete an existing OAuth 2.0 client by unique client ID.

Parameters:

  • client_id (String) —

    The client ID

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

    the optional parameters

Returns:

  • (nil) 


95
96
97
98
 
# File 'lib/launchdarkly_api/api/o_auth2_clients_api.rb', line 95

def delete_o_auth_client(client_id, opts = {})
  delete_o_auth_client_with_http_info(client_id, opts)
  nil
end

#delete_o_auth_client_with_http_info(client_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete OAuth 2.0 client Delete an existing OAuth 2.0 client by unique client ID.

Parameters:

  • client_id (String) —

    The client ID

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

    the optional parameters

Returns:

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

    nil, 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/launchdarkly_api/api/o_auth2_clients_api.rb', line 105

def delete_o_auth_client_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuth2ClientsApi.delete_o_auth_client ...'
  end
  # verify the required parameter 'client_id' is set
  if @api_client.config.client_side_validation && client_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_id' when calling OAuth2ClientsApi.delete_o_auth_client"
  end
  # resource path
  local_var_path = '/api/v2/oauth/clients/{clientId}'.sub('{' + 'clientId' + '}', CGI.escape(client_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'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"OAuth2ClientsApi.delete_o_auth_client",
    :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: OAuth2ClientsApi#delete_o_auth_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_o_auth_client_by_id(client_id, opts = {}) ⇒ Client

Get client by ID Get a registered OAuth 2.0 client by unique client ID.

Parameters:

  • client_id (String) —

    The client ID

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

    the optional parameters

Returns:



158
159
160
161
 
# File 'lib/launchdarkly_api/api/o_auth2_clients_api.rb', line 158

def get_o_auth_client_by_id(client_id, opts = {})
  data, _status_code, _headers = get_o_auth_client_by_id_with_http_info(client_id, opts)
  data
end

#get_o_auth_client_by_id_with_http_info(client_id, opts = {}) ⇒ Array<(Client, Integer, Hash)>

Get client by ID Get a registered OAuth 2.0 client by unique client ID.

Parameters:

  • client_id (String) —

    The client ID

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

    the optional parameters

Returns:

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

    Client data, response status code and response headers



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
 
# File 'lib/launchdarkly_api/api/o_auth2_clients_api.rb', line 168

def get_o_auth_client_by_id_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuth2ClientsApi.get_o_auth_client_by_id ...'
  end
  # verify the required parameter 'client_id' is set
  if @api_client.config.client_side_validation && client_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_id' when calling OAuth2ClientsApi.get_o_auth_client_by_id"
  end
  # resource path
  local_var_path = '/api/v2/oauth/clients/{clientId}'.sub('{' + 'clientId' + '}', CGI.escape(client_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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"OAuth2ClientsApi.get_o_auth_client_by_id",
    :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: OAuth2ClientsApi#get_o_auth_client_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_o_auth_clients(opts = {}) ⇒ ClientCollection

Get clients Get all OAuth 2.0 clients registered by your account.

Parameters:

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

    the optional parameters

Returns:



220
221
222
223
 
# File 'lib/launchdarkly_api/api/o_auth2_clients_api.rb', line 220

def get_o_auth_clients(opts = {})
  data, _status_code, _headers = get_o_auth_clients_with_http_info(opts)
  data
end

#get_o_auth_clients_with_http_info(opts = {}) ⇒ Array<(ClientCollection, Integer, Hash)>

Get clients Get all OAuth 2.0 clients registered by your account.

Parameters:

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

    the optional parameters

Returns:

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

    ClientCollection data, response status code and response headers



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
 
# File 'lib/launchdarkly_api/api/o_auth2_clients_api.rb', line 229

def get_o_auth_clients_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuth2ClientsApi.get_o_auth_clients ...'
  end
  # resource path
  local_var_path = '/api/v2/oauth/clients'

  # 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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"OAuth2ClientsApi.get_o_auth_clients",
    :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: OAuth2ClientsApi#get_o_auth_clients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_o_auth_client(client_id, patch_operation, opts = {}) ⇒ Client

Patch client by ID Patch an existing OAuth 2.0 client by client ID. Updating an OAuth2 client uses a [JSON patch](datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](launchdarkly.com/docs/api#updates). Only ‘name`, `description`, and `redirectUri` may be patched.

Parameters:

  • client_id (String) —

    The client ID

  • patch_operation (Array<PatchOperation>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



279
280
281
282
 
# File 'lib/launchdarkly_api/api/o_auth2_clients_api.rb', line 279

def patch_o_auth_client(client_id, patch_operation, opts = {})
  data, _status_code, _headers = patch_o_auth_client_with_http_info(client_id, patch_operation, opts)
  data
end

#patch_o_auth_client_with_http_info(client_id, patch_operation, opts = {}) ⇒ Array<(Client, Integer, Hash)>

Patch client by ID Patch an existing OAuth 2.0 client by client ID. Updating an OAuth2 client uses a [JSON patch](datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](launchdarkly.com/docs/api#updates). Only &#x60;name&#x60;, &#x60;description&#x60;, and &#x60;redirectUri&#x60; may be patched.

Parameters:

  • client_id (String) —

    The client ID

  • patch_operation (Array<PatchOperation>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Client data, response status code and response headers



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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/launchdarkly_api/api/o_auth2_clients_api.rb', line 290

def patch_o_auth_client_with_http_info(client_id, patch_operation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuth2ClientsApi.patch_o_auth_client ...'
  end
  # verify the required parameter 'client_id' is set
  if @api_client.config.client_side_validation && client_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_id' when calling OAuth2ClientsApi.patch_o_auth_client"
  end
  # verify the required parameter 'patch_operation' is set
  if @api_client.config.client_side_validation && patch_operation.nil?
    fail ArgumentError, "Missing the required parameter 'patch_operation' when calling OAuth2ClientsApi.patch_o_auth_client"
  end
  # resource path
  local_var_path = '/api/v2/oauth/clients/{clientId}'.sub('{' + 'clientId' + '}', CGI.escape(client_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'])
  # 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(patch_operation)

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

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

  new_options = opts.merge(
    :operation => :"OAuth2ClientsApi.patch_o_auth_client",
    :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: OAuth2ClientsApi#patch_o_auth_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end