Class: InfluxDB2::API::AuthorizationsApi

Inherits:
Object
  • Object
show all
Defined in:
apis/lib/influxdb2/apis/generated/api/authorizations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AuthorizationsApi

Returns a new instance of AuthorizationsApi.



18
19
20
# File 'apis/lib/influxdb2/apis/generated/api/authorizations_api.rb', line 18

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



16
17
18
# File 'apis/lib/influxdb2/apis/generated/api/authorizations_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#delete_authorizations_id(auth_id, opts = {}) ⇒ nil

Delete an authorization

Parameters:

  • auth_id (String)

    The ID of the authorization to delete.

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String)

    OpenTracing span context

Returns:

  • (nil)


26
27
28
29
# File 'apis/lib/influxdb2/apis/generated/api/authorizations_api.rb', line 26

def delete_authorizations_id(auth_id, opts = {})
  delete_authorizations_id_with_http_info(auth_id, opts)
  nil
end

#delete_authorizations_id_with_http_info(auth_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an authorization

Parameters:

  • auth_id (String)

    The ID of the authorization to delete.

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String)

    OpenTracing span context

Returns:

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

    nil, response status code and response headers



36
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 'apis/lib/influxdb2/apis/generated/api/authorizations_api.rb', line 36

def delete_authorizations_id_with_http_info(auth_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthorizationsApi.delete_authorizations_id ...'
  end
  # verify the required parameter 'auth_id' is set
  if @api_client.config.client_side_validation && auth_id.nil?
    fail ArgumentError, "Missing the required parameter 'auth_id' when calling AuthorizationsApi.delete_authorizations_id"
  end
  # resource path
  local_var_path = '/authorizations/{authID}'.sub('{' + 'authID' + '}', CGI.escape(auth_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'])
  header_params[:'Zap-Trace-Span'] = opts[:'zap_trace_span'] if !opts[:'zap_trace_span'].nil?

  # 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] || ['header']

  new_options = opts.merge(
    :operation => :"AuthorizationsApi.delete_authorizations_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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationsApi#delete_authorizations_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_authorizations(opts = {}) ⇒ Authorizations

List all authorizations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String)

    OpenTracing span context

  • :user_id (String)

    Only show authorizations that belong to a user ID.

  • :user (String)

    Only show authorizations that belong to a user name.

  • :org_id (String)

    Only show authorizations that belong to an organization ID.

  • :org (String)

    Only show authorizations that belong to a organization name.

Returns:



93
94
95
96
# File 'apis/lib/influxdb2/apis/generated/api/authorizations_api.rb', line 93

def get_authorizations(opts = {})
  data, _status_code, _headers = get_authorizations_with_http_info(opts)
  data
end

#get_authorizations_id(auth_id, opts = {}) ⇒ Authorization

Retrieve an authorization

Parameters:

  • auth_id (String)

    The ID of the authorization to get.

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String)

    OpenTracing span context

Returns:



160
161
162
163
# File 'apis/lib/influxdb2/apis/generated/api/authorizations_api.rb', line 160

def get_authorizations_id(auth_id, opts = {})
  data, _status_code, _headers = get_authorizations_id_with_http_info(auth_id, opts)
  data
end

#get_authorizations_id_with_http_info(auth_id, opts = {}) ⇒ Array<(Authorization, Integer, Hash)>

Retrieve an authorization

Parameters:

  • auth_id (String)

    The ID of the authorization to get.

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String)

    OpenTracing span context

Returns:

  • (Array<(Authorization, Integer, Hash)>)

    Authorization 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
217
# File 'apis/lib/influxdb2/apis/generated/api/authorizations_api.rb', line 170

def get_authorizations_id_with_http_info(auth_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthorizationsApi.get_authorizations_id ...'
  end
  # verify the required parameter 'auth_id' is set
  if @api_client.config.client_side_validation && auth_id.nil?
    fail ArgumentError, "Missing the required parameter 'auth_id' when calling AuthorizationsApi.get_authorizations_id"
  end
  # resource path
  local_var_path = '/authorizations/{authID}'.sub('{' + 'authID' + '}', CGI.escape(auth_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'])
  header_params[:'Zap-Trace-Span'] = opts[:'zap_trace_span'] if !opts[:'zap_trace_span'].nil?

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

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

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

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

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

#get_authorizations_with_http_info(opts = {}) ⇒ Array<(Authorizations, Integer, Hash)>

List all authorizations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String)

    OpenTracing span context

  • :user_id (String)

    Only show authorizations that belong to a user ID.

  • :user (String)

    Only show authorizations that belong to a user name.

  • :org_id (String)

    Only show authorizations that belong to an organization ID.

  • :org (String)

    Only show authorizations that belong to a organization name.

Returns:

  • (Array<(Authorizations, Integer, Hash)>)

    Authorizations 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
# File 'apis/lib/influxdb2/apis/generated/api/authorizations_api.rb', line 106

def get_authorizations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthorizationsApi.get_authorizations ...'
  end
  # resource path
  local_var_path = '/authorizations'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'userID'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'user'] = opts[:'user'] if !opts[:'user'].nil?
  query_params[:'orgID'] = opts[:'org_id'] if !opts[:'org_id'].nil?
  query_params[:'org'] = opts[:'org'] if !opts[:'org'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'Zap-Trace-Span'] = opts[:'zap_trace_span'] if !opts[:'zap_trace_span'].nil?

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

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

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

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

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

#patch_authorizations_id(auth_id, authorization_update_request, opts = {}) ⇒ Authorization

Update an authorization to be active or inactive

Parameters:

  • auth_id (String)

    The ID of the authorization to update.

  • authorization_update_request (AuthorizationUpdateRequest)

    Authorization to update

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String)

    OpenTracing span context

Returns:



225
226
227
228
# File 'apis/lib/influxdb2/apis/generated/api/authorizations_api.rb', line 225

def patch_authorizations_id(auth_id, authorization_update_request, opts = {})
  data, _status_code, _headers = patch_authorizations_id_with_http_info(auth_id, authorization_update_request, opts)
  data
end

#patch_authorizations_id_with_http_info(auth_id, authorization_update_request, opts = {}) ⇒ Array<(Authorization, Integer, Hash)>

Update an authorization to be active or inactive

Parameters:

  • auth_id (String)

    The ID of the authorization to update.

  • authorization_update_request (AuthorizationUpdateRequest)

    Authorization to update

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String)

    OpenTracing span context

Returns:

  • (Array<(Authorization, Integer, Hash)>)

    Authorization data, response status code and response headers



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
287
288
289
# File 'apis/lib/influxdb2/apis/generated/api/authorizations_api.rb', line 236

def patch_authorizations_id_with_http_info(auth_id, authorization_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthorizationsApi.patch_authorizations_id ...'
  end
  # verify the required parameter 'auth_id' is set
  if @api_client.config.client_side_validation && auth_id.nil?
    fail ArgumentError, "Missing the required parameter 'auth_id' when calling AuthorizationsApi.patch_authorizations_id"
  end
  # verify the required parameter 'authorization_update_request' is set
  if @api_client.config.client_side_validation && authorization_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'authorization_update_request' when calling AuthorizationsApi.patch_authorizations_id"
  end
  # resource path
  local_var_path = '/authorizations/{authID}'.sub('{' + 'authID' + '}', CGI.escape(auth_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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'Zap-Trace-Span'] = opts[:'zap_trace_span'] if !opts[:'zap_trace_span'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"AuthorizationsApi.patch_authorizations_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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthorizationsApi#patch_authorizations_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_authorizations(authorization_post_request, opts = {}) ⇒ Authorization

Create an authorization

Parameters:

  • authorization_post_request (AuthorizationPostRequest)

    Authorization to create

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String)

    OpenTracing span context

Returns:



296
297
298
299
# File 'apis/lib/influxdb2/apis/generated/api/authorizations_api.rb', line 296

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

#post_authorizations_with_http_info(authorization_post_request, opts = {}) ⇒ Array<(Authorization, Integer, Hash)>

Create an authorization

Parameters:

  • authorization_post_request (AuthorizationPostRequest)

    Authorization to create

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String)

    OpenTracing span context

Returns:

  • (Array<(Authorization, Integer, Hash)>)

    Authorization data, response status code and response headers



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
355
# File 'apis/lib/influxdb2/apis/generated/api/authorizations_api.rb', line 306

def (authorization_post_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthorizationsApi.post_authorizations ...'
  end
  # verify the required parameter 'authorization_post_request' is set
  if @api_client.config.client_side_validation && authorization_post_request.nil?
    fail ArgumentError, "Missing the required parameter 'authorization_post_request' when calling AuthorizationsApi.post_authorizations"
  end
  # resource path
  local_var_path = '/authorizations'

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'Zap-Trace-Span'] = opts[:'zap_trace_span'] if !opts[:'zap_trace_span'].nil?

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

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

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

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

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