Class: DatadogAPIClient::V2::OAuth2ClientPublicAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/o_auth2_client_public_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ OAuth2ClientPublicAPI

Returns a new instance of OAuth2ClientPublicAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/o_auth2_client_public_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/o_auth2_client_public_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#delete_scopes_restriction(client_uuid, opts = {}) ⇒ Object

Delete an OAuth2 client scopes restriction.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/o_auth2_client_public_api.rb', line 29

def delete_scopes_restriction(client_uuid, opts = {})
  delete_scopes_restriction_with_http_info(client_uuid, opts)
  nil
end

#delete_scopes_restriction_with_http_info(client_uuid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an OAuth2 client scopes restriction.

Delete the scopes restriction configured for the OAuth2 client.

Parameters:

  • client_uuid (UUID) —

    UUID of the OAuth2 client.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
89
90
91
92
93
94
95
 
# File 'lib/datadog_api_client/v2/api/o_auth2_client_public_api.rb', line 41

def delete_scopes_restriction_with_http_info(client_uuid, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_scopes_restriction".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_scopes_restriction")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_scopes_restriction"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuth2ClientPublicAPI.delete_scopes_restriction ...'
  end
  # verify the required parameter 'client_uuid' is set
  if @api_client.config.client_side_validation && client_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'client_uuid' when calling OAuth2ClientPublicAPI.delete_scopes_restriction"
  end
  # resource path
  local_var_path = '/api/v2/oauth2/clients/{client_uuid}/scopes_restriction'.sub('{client_uuid}', CGI.escape(client_uuid.to_s).gsub('%2F', '/'))

  # 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(['*/*'])

  # 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] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_scopes_restriction,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#get_o_auth2_well_known_sites(opts = {}) ⇒ Object

Get OAuth2 well-known sites.

See Also:



100
101
102
103
 
# File 'lib/datadog_api_client/v2/api/o_auth2_client_public_api.rb', line 100

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

#get_o_auth2_well_known_sites_with_http_info(opts = {}) ⇒ Array<(OAuth2WellKnownSitesResponse, Integer, Hash)>

Get OAuth2 well-known sites.

Retrieve the list of public OAuth2 sites available for the current environment. This endpoint is used for OAuth2 discovery and returns sites where users can authenticate.

Parameters:

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

    the optional parameters

Returns:



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
154
155
156
157
158
159
160
161
 
# File 'lib/datadog_api_client/v2/api/o_auth2_client_public_api.rb', line 111

def get_o_auth2_well_known_sites_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_o_auth2_well_known_sites".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_o_auth2_well_known_sites")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_o_auth2_well_known_sites"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuth2ClientPublicAPI.get_o_auth2_well_known_sites ...'
  end
  # resource path
  local_var_path = '/api/v2/oauth2/.well-known/sites'

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

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

  new_options = opts.merge(
    :operation => :get_o_auth2_well_known_sites,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#get_oidc_discovery_document(opts = {}) ⇒ Object

Get OpenID Connect provider metadata.

See Also:



166
167
168
169
 
# File 'lib/datadog_api_client/v2/api/o_auth2_client_public_api.rb', line 166

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

#get_oidc_discovery_document_with_http_info(opts = {}) ⇒ Array<(OIDCDiscoveryDocument, Integer, Hash)>

Get OpenID Connect provider metadata.

Retrieve OpenID Connect provider metadata for the OAuth2 v2 token endpoint.

Parameters:

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

    the optional parameters

Returns:

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

    OIDCDiscoveryDocument data, response status code and response headers



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
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/datadog_api_client/v2/api/o_auth2_client_public_api.rb', line 177

def get_oidc_discovery_document_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_oidc_discovery_document".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_oidc_discovery_document")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_oidc_discovery_document"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuth2ClientPublicAPI.get_oidc_discovery_document ...'
  end
  # resource path
  local_var_path = '/api/v2/oauth2/.well-known/openid-configuration'

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

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

  new_options = opts.merge(
    :operation => :get_oidc_discovery_document,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#get_scopes_restriction(client_uuid, opts = {}) ⇒ Object

Get an OAuth2 client scopes restriction.

See Also:



232
233
234
235
 
# File 'lib/datadog_api_client/v2/api/o_auth2_client_public_api.rb', line 232

def get_scopes_restriction(client_uuid, opts = {})
  data, _status_code, _headers = get_scopes_restriction_with_http_info(client_uuid, opts)
  data
end

#get_scopes_restriction_with_http_info(client_uuid, opts = {}) ⇒ Array<(OAuthScopesRestrictionResponse, Integer, Hash)>

Get an OAuth2 client scopes restriction.

Get the scopes restriction configured for the OAuth2 client.

Parameters:

  • client_uuid (UUID) —

    UUID of the OAuth2 client.

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

    the optional parameters

Returns:



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
294
295
296
297
298
 
# File 'lib/datadog_api_client/v2/api/o_auth2_client_public_api.rb', line 244

def get_scopes_restriction_with_http_info(client_uuid, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_scopes_restriction".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_scopes_restriction")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_scopes_restriction"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuth2ClientPublicAPI.get_scopes_restriction ...'
  end
  # verify the required parameter 'client_uuid' is set
  if @api_client.config.client_side_validation && client_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'client_uuid' when calling OAuth2ClientPublicAPI.get_scopes_restriction"
  end
  # resource path
  local_var_path = '/api/v2/oauth2/clients/{client_uuid}/scopes_restriction'.sub('{client_uuid}', CGI.escape(client_uuid.to_s).gsub('%2F', '/'))

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_scopes_restriction,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#register_o_auth_client(body, opts = {}) ⇒ Object

Register an OAuth2 client.

See Also:



303
304
305
306
 
# File 'lib/datadog_api_client/v2/api/o_auth2_client_public_api.rb', line 303

def register_o_auth_client(body, opts = {})
  data, _status_code, _headers = register_o_auth_client_with_http_info(body, opts)
  data
end

#register_o_auth_client_with_http_info(body, opts = {}) ⇒ Array<(OAuthClientRegistrationResponse, Integer, Hash)>

Register an OAuth2 client.

Register an OAuth2 client using the Dynamic Client Registration protocol defined in RFC 7591.

Parameters:

Returns:



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
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/datadog_api_client/v2/api/o_auth2_client_public_api.rb', line 315

def register_o_auth_client_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.register_o_auth_client".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.register_o_auth_client")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.register_o_auth_client"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuth2ClientPublicAPI.register_o_auth_client ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling OAuth2ClientPublicAPI.register_o_auth_client"
  end
  # resource path
  local_var_path = '/api/v2/oauth2/register'

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

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

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

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

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

  new_options = opts.merge(
    :operation => :register_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,
    :api_version => "V2"
  )

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

#upsert_scopes_restriction(client_uuid, body, opts = {}) ⇒ Object

Upsert an OAuth2 client scopes restriction.

See Also:



376
377
378
379
 
# File 'lib/datadog_api_client/v2/api/o_auth2_client_public_api.rb', line 376

def upsert_scopes_restriction(client_uuid, body, opts = {})
  data, _status_code, _headers = upsert_scopes_restriction_with_http_info(client_uuid, body, opts)
  data
end

#upsert_scopes_restriction_with_http_info(client_uuid, body, opts = {}) ⇒ Array<(OAuthScopesRestrictionResponse, Integer, Hash)>

Upsert an OAuth2 client scopes restriction.

Create or update the scopes restriction configured for the OAuth2 client.

Parameters:

Returns:



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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/datadog_api_client/v2/api/o_auth2_client_public_api.rb', line 389

def upsert_scopes_restriction_with_http_info(client_uuid, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.upsert_scopes_restriction".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.upsert_scopes_restriction")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.upsert_scopes_restriction"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuth2ClientPublicAPI.upsert_scopes_restriction ...'
  end
  # verify the required parameter 'client_uuid' is set
  if @api_client.config.client_side_validation && client_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'client_uuid' when calling OAuth2ClientPublicAPI.upsert_scopes_restriction"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling OAuth2ClientPublicAPI.upsert_scopes_restriction"
  end
  # resource path
  local_var_path = '/api/v2/oauth2/clients/{client_uuid}/scopes_restriction'.sub('{client_uuid}', CGI.escape(client_uuid.to_s).gsub('%2F', '/'))

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :upsert_scopes_restriction,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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