Class: DatadogAPIClient::V2::AuthNMappingsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of AuthNMappingsAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/authn_mappings_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/authn_mappings_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

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

Create an AuthN Mapping.

See Also:



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

def create_authn_mapping(body, opts = {})
  data, _status_code, _headers = create_authn_mapping_with_http_info(body, opts)
  data
end

#create_authn_mapping_with_http_info(body, opts = {}) ⇒ Array<(AuthNMappingResponse, Integer, Hash)>

Create an AuthN Mapping.

Create an AuthN Mapping.

Parameters:

Returns:

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

    AuthNMappingResponse data, 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
 
# File 'lib/datadog_api_client/v2/api/authn_mappings_api.rb', line 41

def create_authn_mapping_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthNMappingsAPI.create_authn_mapping ...'
  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 AuthNMappingsAPI.create_authn_mapping"
  end
  # resource path
  local_var_path = '/api/v2/authn_mappings'

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

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

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

#delete_authn_mapping(authn_mapping_id, opts = {}) ⇒ Object

Delete an AuthN Mapping.

See Also:



96
97
98
99
 
# File 'lib/datadog_api_client/v2/api/authn_mappings_api.rb', line 96

def delete_authn_mapping(authn_mapping_id, opts = {})
  delete_authn_mapping_with_http_info(authn_mapping_id, opts)
  nil
end

#delete_authn_mapping_with_http_info(authn_mapping_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an AuthN Mapping.

Delete an AuthN Mapping specified by AuthN Mapping UUID.

Parameters:

  • authn_mapping_id (String) —

    The UUID of the AuthN Mapping.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
154
155
156
 
# File 'lib/datadog_api_client/v2/api/authn_mappings_api.rb', line 108

def delete_authn_mapping_with_http_info(authn_mapping_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthNMappingsAPI.delete_authn_mapping ...'
  end
  # verify the required parameter 'authn_mapping_id' is set
  if @api_client.config.client_side_validation && authn_mapping_id.nil?
    fail ArgumentError, "Missing the required parameter 'authn_mapping_id' when calling AuthNMappingsAPI.delete_authn_mapping"
  end
  # resource path
  local_var_path = '/api/v2/authn_mappings/{authn_mapping_id}'.sub('{authn_mapping_id}', CGI.escape(authn_mapping_id.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, :AuthZ]

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

#get_authn_mapping(authn_mapping_id, opts = {}) ⇒ Object

Get an AuthN Mapping by UUID.

See Also:



161
162
163
164
 
# File 'lib/datadog_api_client/v2/api/authn_mappings_api.rb', line 161

def get_authn_mapping(authn_mapping_id, opts = {})
  data, _status_code, _headers = get_authn_mapping_with_http_info(authn_mapping_id, opts)
  data
end

#get_authn_mapping_with_http_info(authn_mapping_id, opts = {}) ⇒ Array<(AuthNMappingResponse, Integer, Hash)>

Get an AuthN Mapping by UUID.

Get an AuthN Mapping specified by the AuthN Mapping UUID.

Parameters:

  • authn_mapping_id (String) —

    The UUID of the AuthN Mapping.

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

    the optional parameters

Returns:

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

    AuthNMappingResponse data, response status code and response headers



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
218
219
220
221
 
# File 'lib/datadog_api_client/v2/api/authn_mappings_api.rb', line 173

def get_authn_mapping_with_http_info(authn_mapping_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthNMappingsAPI.get_authn_mapping ...'
  end
  # verify the required parameter 'authn_mapping_id' is set
  if @api_client.config.client_side_validation && authn_mapping_id.nil?
    fail ArgumentError, "Missing the required parameter 'authn_mapping_id' when calling AuthNMappingsAPI.get_authn_mapping"
  end
  # resource path
  local_var_path = '/api/v2/authn_mappings/{authn_mapping_id}'.sub('{authn_mapping_id}', CGI.escape(authn_mapping_id.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] || 'AuthNMappingResponse'

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

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

#list_authn_mappings(opts = {}) ⇒ Object

List all AuthN Mappings.

See Also:



226
227
228
229
 
# File 'lib/datadog_api_client/v2/api/authn_mappings_api.rb', line 226

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

#list_authn_mappings_with_http_info(opts = {}) ⇒ Array<(AuthNMappingsResponse, Integer, Hash)>

List all AuthN Mappings.

List all AuthN Mappings in the org.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Size for a given page. The maximum allowed value is 100.

  • :page_number (Integer) —

    Specific page number to return.

  • :sort (AuthNMappingsSort) —

    Sort AuthN Mappings depending on the given field.

  • :filter (String) —

    Filter all mappings by the given string.

  • :resource_type (AuthNMappingResourceType) —

    Filter by mapping resource type. Defaults to “role” if not specified.

Returns:

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

    AuthNMappingsResponse data, response status code and response headers



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

def list_authn_mappings_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthNMappingsAPI.list_authn_mappings ...'
  end
  allowable_values = ['created_at', '-created_at', 'role_id', '-role_id', 'saml_assertion_attribute_id', '-saml_assertion_attribute_id', 'role.name', '-role.name', 'saml_assertion_attribute.attribute_key', '-saml_assertion_attribute.attribute_key', 'saml_assertion_attribute.attribute_value', '-saml_assertion_attribute.attribute_value']
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  allowable_values = ['role', 'team']
  if @api_client.config.client_side_validation && opts[:'resource_type'] && !allowable_values.include?(opts[:'resource_type'])
    fail ArgumentError, "invalid value for \"resource_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/authn_mappings'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'resource_type'] = opts[:'resource_type'] if !opts[:'resource_type'].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] || 'AuthNMappingsResponse'

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

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

#update_authn_mapping(authn_mapping_id, body, opts = {}) ⇒ Object

Edit an AuthN Mapping.

See Also:



304
305
306
307
 
# File 'lib/datadog_api_client/v2/api/authn_mappings_api.rb', line 304

def update_authn_mapping(authn_mapping_id, body, opts = {})
  data, _status_code, _headers = update_authn_mapping_with_http_info(authn_mapping_id, body, opts)
  data
end

#update_authn_mapping_with_http_info(authn_mapping_id, body, opts = {}) ⇒ Array<(AuthNMappingResponse, Integer, Hash)>

Edit an AuthN Mapping.

Edit an AuthN Mapping.

Parameters:

  • authn_mapping_id (String) —

    The UUID of the AuthN Mapping.

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

    the optional parameters

Returns:

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

    AuthNMappingResponse data, response status code and response headers



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/authn_mappings_api.rb', line 317

def update_authn_mapping_with_http_info(authn_mapping_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthNMappingsAPI.update_authn_mapping ...'
  end
  # verify the required parameter 'authn_mapping_id' is set
  if @api_client.config.client_side_validation && authn_mapping_id.nil?
    fail ArgumentError, "Missing the required parameter 'authn_mapping_id' when calling AuthNMappingsAPI.update_authn_mapping"
  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 AuthNMappingsAPI.update_authn_mapping"
  end
  # resource path
  local_var_path = '/api/v2/authn_mappings/{authn_mapping_id}'.sub('{authn_mapping_id}', CGI.escape(authn_mapping_id.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] || 'AuthNMappingResponse'

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

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