Class: Fastly::MutualAuthenticationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/mutual_authentication_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MutualAuthenticationApi

Returns a new instance of MutualAuthenticationApi.



17
18
19
 
# File 'lib/fastly/api/mutual_authentication_api.rb', line 17

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/mutual_authentication_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#create_mutual_tls_authentication(opts = {}) ⇒ MutualAuthenticationResponse

Create a Mutual Authentication Create a mutual authentication using a bundle of certificates to enable client-to-server mutual TLS.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:



24
25
26
27
 
# File 'lib/fastly/api/mutual_authentication_api.rb', line 24

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

#create_mutual_tls_authentication_with_http_info(opts = {}) ⇒ Array<(MutualAuthenticationResponse, Integer, Hash)>

Create a Mutual Authentication Create a mutual authentication using a bundle of certificates to enable client-to-server mutual TLS.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:



33
34
35
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
 
# File 'lib/fastly/api/mutual_authentication_api.rb', line 33

def create_mutual_tls_authentication_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MutualAuthenticationApi.create_mutual_tls_authentication ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/tls/mutual_authentications'

  # 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/vnd.api+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+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(opts[:'mutual_authentication'])

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

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

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

#delete_mutual_tls(opts = {}) ⇒ nil

Delete a Mutual TLS Remove a Mutual TLS authentication

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :mutual_authentication_id (String) —

    Alphanumeric string identifying a mutual authentication. (required)

Returns:

  • (nil) 


87
88
89
90
 
# File 'lib/fastly/api/mutual_authentication_api.rb', line 87

def delete_mutual_tls(opts = {})
  delete_mutual_tls_with_http_info(opts)
  nil
end

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

Delete a Mutual TLS Remove a Mutual TLS authentication

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :mutual_authentication_id (String) —

    Alphanumeric string identifying a mutual authentication. (required)

Returns:

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

    nil, response status code and response headers



96
97
98
99
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
 
# File 'lib/fastly/api/mutual_authentication_api.rb', line 96

def delete_mutual_tls_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MutualAuthenticationApi.delete_mutual_tls ...'
  end
  # unbox the parameters from the hash
  mutual_authentication_id = opts[:'mutual_authentication_id']
  # verify the required parameter 'mutual_authentication_id' is set
  if @api_client.config.client_side_validation && mutual_authentication_id.nil?
    fail ArgumentError, "Missing the required parameter 'mutual_authentication_id' when calling MutualAuthenticationApi.delete_mutual_tls"
  end
  # resource path
  local_var_path = '/tls/mutual_authentications/{mutual_authentication_id}'.sub('{' + 'mutual_authentication_id' + '}', CGI.escape(mutual_authentication_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

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

#get_mutual_authentication(opts = {}) ⇒ MutualAuthenticationResponse

Get a Mutual Authentication Show a Mutual Authentication.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :mutual_authentication_id (String) —

    Alphanumeric string identifying a mutual authentication. (required)

  • :include (String) —

    Comma-separated list of related objects to include (optional). Permitted values: &#x60;tls_activations&#x60;. Including TLS activations will provide you with the TLS domain names that are related to your Mutual TLS authentication.

Returns:



149
150
151
152
 
# File 'lib/fastly/api/mutual_authentication_api.rb', line 149

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

#get_mutual_authentication_with_http_info(opts = {}) ⇒ Array<(MutualAuthenticationResponse, Integer, Hash)>

Get a Mutual Authentication Show a Mutual Authentication.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :mutual_authentication_id (String) —

    Alphanumeric string identifying a mutual authentication. (required)

  • :include (String) —

    Comma-separated list of related objects to include (optional). Permitted values: &#x60;tls_activations&#x60;. Including TLS activations will provide you with the TLS domain names that are related to your Mutual TLS authentication.

Returns:



159
160
161
162
163
164
165
166
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
 
# File 'lib/fastly/api/mutual_authentication_api.rb', line 159

def get_mutual_authentication_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MutualAuthenticationApi.get_mutual_authentication ...'
  end
  # unbox the parameters from the hash
  mutual_authentication_id = opts[:'mutual_authentication_id']
  # verify the required parameter 'mutual_authentication_id' is set
  if @api_client.config.client_side_validation && mutual_authentication_id.nil?
    fail ArgumentError, "Missing the required parameter 'mutual_authentication_id' when calling MutualAuthenticationApi.get_mutual_authentication"
  end
  # resource path
  local_var_path = '/tls/mutual_authentications/{mutual_authentication_id}'.sub('{' + 'mutual_authentication_id' + '}', CGI.escape(mutual_authentication_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])

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

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

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

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

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

#list_mutual_authentications(opts = {}) ⇒ MutualAuthenticationsResponse

List Mutual Authentications List all mutual authentications.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :include (String) —

    Comma-separated list of related objects to include (optional). Permitted values: &#x60;tls_activations&#x60;. Including TLS activations will provide you with the TLS domain names that are related to your Mutual TLS authentication.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

Returns:



216
217
218
219
 
# File 'lib/fastly/api/mutual_authentication_api.rb', line 216

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

#list_mutual_authentications_with_http_info(opts = {}) ⇒ Array<(MutualAuthenticationsResponse, Integer, Hash)>

List Mutual Authentications List all mutual authentications.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :include (String) —

    Comma-separated list of related objects to include (optional). Permitted values: &#x60;tls_activations&#x60;. Including TLS activations will provide you with the TLS domain names that are related to your Mutual TLS authentication.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

Returns:



227
228
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
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/fastly/api/mutual_authentication_api.rb', line 227

def list_mutual_authentications_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MutualAuthenticationApi.list_mutual_authentications ...'
  end
  # unbox the parameters from the hash
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling MutualAuthenticationApi.list_mutual_authentications, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling MutualAuthenticationApi.list_mutual_authentications, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/tls/mutual_authentications'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])

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

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

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

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

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

#patch_mutual_authentication(opts = {}) ⇒ MutualAuthenticationResponse

Update a Mutual Authentication Update a Mutual Authentication.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :mutual_authentication_id (String) —

    Alphanumeric string identifying a mutual authentication. (required)

  • :mutual_authentication (MutualAuthentication)

Returns:



288
289
290
291
 
# File 'lib/fastly/api/mutual_authentication_api.rb', line 288

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

#patch_mutual_authentication_with_http_info(opts = {}) ⇒ Array<(MutualAuthenticationResponse, Integer, Hash)>

Update a Mutual Authentication Update a Mutual Authentication.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :mutual_authentication_id (String) —

    Alphanumeric string identifying a mutual authentication. (required)

  • :mutual_authentication (MutualAuthentication)

Returns:



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
346
347
348
349
350
351
 
# File 'lib/fastly/api/mutual_authentication_api.rb', line 298

def patch_mutual_authentication_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MutualAuthenticationApi.patch_mutual_authentication ...'
  end
  # unbox the parameters from the hash
  mutual_authentication_id = opts[:'mutual_authentication_id']
  # verify the required parameter 'mutual_authentication_id' is set
  if @api_client.config.client_side_validation && mutual_authentication_id.nil?
    fail ArgumentError, "Missing the required parameter 'mutual_authentication_id' when calling MutualAuthenticationApi.patch_mutual_authentication"
  end
  # resource path
  local_var_path = '/tls/mutual_authentications/{mutual_authentication_id}'.sub('{' + 'mutual_authentication_id' + '}', CGI.escape(mutual_authentication_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/vnd.api+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+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(opts[:'mutual_authentication'])

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

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

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