Class: LaunchDarklyApi::AccessTokensApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccessTokensApi

Returns a new instance of AccessTokensApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_token(id, opts = {}) ⇒ nil

Delete access token Delete an access token by ID.

Parameters:

  • id (String) —

    The ID of the access token to update

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_token(id, opts = {})
  delete_token_with_http_info(id, opts)
  nil
end

#delete_token_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete access token Delete an access token by ID.

Parameters:

  • id (String) —

    The ID of the access token to update

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 37

def delete_token_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessTokensApi.delete_token ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AccessTokensApi.delete_token"
  end
  # resource path
  local_var_path = '/api/v2/tokens/{id}'.sub('{' + 'id' + '}', CGI.escape(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 => :"AccessTokensApi.delete_token",
    :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: AccessTokensApi#delete_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_token(id, opts = {}) ⇒ Token

Get access token Get a single access token by ID.

Parameters:

  • id (String) —

    The ID of the access token

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

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 90

def get_token(id, opts = {})
  data, _status_code, _headers = get_token_with_http_info(id, opts)
  data
end

#get_token_with_http_info(id, opts = {}) ⇒ Array<(Token, Integer, Hash)>

Get access token Get a single access token by ID.

Parameters:

  • id (String) —

    The ID of the access token

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

    the optional parameters

Returns:

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

    Token data, response status code and response headers



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
140
141
142
143
144
145
146
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 100

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

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

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

#get_tokens(opts = {}) ⇒ Tokens

List access tokens Fetch a list of all access tokens.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :show_all (Boolean) —

    If set to true, and the authentication access token has the &#39;Admin&#39; role, personal access tokens for all members will be retrieved.

  • :limit (Integer) —

    The number of access tokens to return in the response. Defaults to 25.

  • :offset (Integer) —

    Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query &#x60;limit&#x60;.

Returns:



155
156
157
158
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 155

def get_tokens(opts = {})
  data, _status_code, _headers = get_tokens_with_http_info(opts)
  data
end

#get_tokens_with_http_info(opts = {}) ⇒ Array<(Tokens, Integer, Hash)>

List access tokens Fetch a list of all access tokens.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :show_all (Boolean) —

    If set to true, and the authentication access token has the &#39;Admin&#39; role, personal access tokens for all members will be retrieved.

  • :limit (Integer) —

    The number of access tokens to return in the response. Defaults to 25.

  • :offset (Integer) —

    Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query &#x60;limit&#x60;.

Returns:

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

    Tokens data, response status code and response headers



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 167

def get_tokens_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessTokensApi.get_tokens ...'
  end
  # resource path
  local_var_path = '/api/v2/tokens'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'showAll'] = opts[:'show_all'] if !opts[:'show_all'].nil?
  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'])

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

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

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

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

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

#patch_token(id, patch_operation, opts = {}) ⇒ Token

Patch access token Update an access token’s settings. Updating an access token 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).

Parameters:

  • id (String) —

    The ID of the access token to update

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

    the optional parameters

Returns:



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

def patch_token(id, patch_operation, opts = {})
  data, _status_code, _headers = patch_token_with_http_info(id, patch_operation, opts)
  data
end

#patch_token_with_http_info(id, patch_operation, opts = {}) ⇒ Array<(Token, Integer, Hash)>

Patch access token Update an access token&#39;s settings. Updating an access token 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).

Parameters:

  • id (String) —

    The ID of the access token to update

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

    the optional parameters

Returns:

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

    Token data, response status code and response headers



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 231

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

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

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

#post_token(access_token_post, opts = {}) ⇒ Token

Create access token Create a new access token.

Parameters:

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

    the optional parameters

Returns:



293
294
295
296
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 293

def post_token(access_token_post, opts = {})
  data, _status_code, _headers = post_token_with_http_info(access_token_post, opts)
  data
end

#post_token_with_http_info(access_token_post, opts = {}) ⇒ Array<(Token, Integer, Hash)>

Create access token Create a new access token.

Parameters:

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

    the optional parameters

Returns:

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

    Token data, response status code and response headers



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
350
351
352
353
354
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 303

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

  # 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(access_token_post)

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

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

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

#reset_token(id, opts = {}) ⇒ Token

Reset access token Reset an access token’s secret key with an optional expiry time for the old key.

Parameters:

  • id (String) —

    The ID of the access token to update

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

    the optional parameters

Options Hash (opts):

  • :expiry (Integer) —

    An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately.

Returns:



362
363
364
365
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 362

def reset_token(id, opts = {})
  data, _status_code, _headers = reset_token_with_http_info(id, opts)
  data
end

#reset_token_with_http_info(id, opts = {}) ⇒ Array<(Token, Integer, Hash)>

Reset access token Reset an access token&#39;s secret key with an optional expiry time for the old key.

Parameters:

  • id (String) —

    The ID of the access token to update

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

    the optional parameters

Options Hash (opts):

  • :expiry (Integer) —

    An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately.

Returns:

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

    Token data, response status code and response headers



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

def reset_token_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessTokensApi.reset_token ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AccessTokensApi.reset_token"
  end
  # resource path
  local_var_path = '/api/v2/tokens/{id}/reset'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

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

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

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