Class: Fastly::IamUserGroupsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IamUserGroupsApi

Returns a new instance of IamUserGroupsApi.



17
18
19
 
# File 'lib/fastly/api/iam_user_groups_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/iam_user_groups_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#add_user_group_members(opts = {}) ⇒ Object

Add members to a user group Add members to a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :request_body (Hash<String, Object>)

Returns:

  • (Object) 


25
26
27
28
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 25

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

#add_user_group_members_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Add members to a user group Add members to a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :request_body (Hash<String, Object>)

Returns:

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

    Object data, response status code and response headers



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
82
83
84
85
86
87
88
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 35

def add_user_group_members_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.add_user_group_members ...'
  end
  # unbox the parameters from the hash
  user_group_id = opts[:'user_group_id']
  # verify the required parameter 'user_group_id' is set
  if @api_client.config.client_side_validation && user_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_id' when calling IamUserGroupsApi.add_user_group_members"
  end
  # resource path
  local_var_path = '/user-groups/{user_group_id}/members'.sub('{' + 'user_group_id' + '}', CGI.escape(user_group_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(opts[:'request_body'])

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

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

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

#add_user_group_roles(opts = {}) ⇒ Object

Add roles to a user group Add roles to a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :request_body (Hash<String, Object>)

Returns:

  • (Object) 


95
96
97
98
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 95

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

#add_user_group_roles_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Add roles to a user group Add roles to a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :request_body (Hash<String, Object>)

Returns:

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

    Object data, response status code and response headers



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
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 105

def add_user_group_roles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.add_user_group_roles ...'
  end
  # unbox the parameters from the hash
  user_group_id = opts[:'user_group_id']
  # verify the required parameter 'user_group_id' is set
  if @api_client.config.client_side_validation && user_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_id' when calling IamUserGroupsApi.add_user_group_roles"
  end
  # resource path
  local_var_path = '/user-groups/{user_group_id}/roles'.sub('{' + 'user_group_id' + '}', CGI.escape(user_group_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(opts[:'request_body'])

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

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

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

#add_user_group_service_groups(opts = {}) ⇒ Object

Add service groups to a user group Add service groups to a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :request_body (Hash<String, Object>)

Returns:

  • (Object) 


165
166
167
168
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 165

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

#add_user_group_service_groups_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Add service groups to a user group Add service groups to a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :request_body (Hash<String, Object>)

Returns:

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

    Object data, response status code and response headers



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
222
223
224
225
226
227
228
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 175

def add_user_group_service_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.add_user_group_service_groups ...'
  end
  # unbox the parameters from the hash
  user_group_id = opts[:'user_group_id']
  # verify the required parameter 'user_group_id' is set
  if @api_client.config.client_side_validation && user_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_id' when calling IamUserGroupsApi.add_user_group_service_groups"
  end
  # resource path
  local_var_path = '/user-groups/{user_group_id}/service-groups'.sub('{' + 'user_group_id' + '}', CGI.escape(user_group_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(opts[:'request_body'])

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

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

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

#create_a_user_group(opts = {}) ⇒ Object

Create a user group Create a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :request_body (Hash<String, Object>)

Returns:

  • (Object) 


234
235
236
237
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 234

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

#create_a_user_group_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Create a user group Create a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :request_body (Hash<String, Object>)

Returns:

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

    Object data, response status code and response headers



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
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 243

def create_a_user_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.create_a_user_group ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/user-groups'

  # 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(opts[:'request_body'])

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

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

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

#delete_a_user_group(opts = {}) ⇒ nil

Delete a user group Delete a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

Returns:

  • (nil) 


297
298
299
300
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 297

def delete_a_user_group(opts = {})
  delete_a_user_group_with_http_info(opts)
  nil
end

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

Delete a user group Delete a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

Returns:

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

    nil, 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
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 306

def delete_a_user_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.delete_a_user_group ...'
  end
  # unbox the parameters from the hash
  user_group_id = opts[:'user_group_id']
  # verify the required parameter 'user_group_id' is set
  if @api_client.config.client_side_validation && user_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_id' when calling IamUserGroupsApi.delete_a_user_group"
  end
  # resource path
  local_var_path = '/user-groups/{user_group_id}'.sub('{' + 'user_group_id' + '}', CGI.escape(user_group_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 => :"IamUserGroupsApi.delete_a_user_group",
    :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: IamUserGroupsApi#delete_a_user_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_a_user_group(opts = {}) ⇒ Object

Get a user group Get a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

Returns:

  • (Object) 


358
359
360
361
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 358

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

#get_a_user_group_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get a user group Get a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

Returns:

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

    Object data, response status code and response headers



367
368
369
370
371
372
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
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 367

def get_a_user_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.get_a_user_group ...'
  end
  # unbox the parameters from the hash
  user_group_id = opts[:'user_group_id']
  # verify the required parameter 'user_group_id' is set
  if @api_client.config.client_side_validation && user_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_id' when calling IamUserGroupsApi.get_a_user_group"
  end
  # resource path
  local_var_path = '/user-groups/{user_group_id}'.sub('{' + 'user_group_id' + '}', CGI.escape(user_group_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] || 'Object'

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

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

#list_user_group_members(opts = {}) ⇒ Object

List members of a user group List members of a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :page (Integer) —

    Current page.

Returns:

  • (Object) 


423
424
425
426
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 423

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

#list_user_group_members_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

List members of a user group List members of a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :page (Integer) —

    Current page.

Returns:

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

    Object data, response status code and response headers



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 434

def list_user_group_members_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.list_user_group_members ...'
  end
  # unbox the parameters from the hash
  user_group_id = opts[:'user_group_id']
  # verify the required parameter 'user_group_id' is set
  if @api_client.config.client_side_validation && user_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_id' when calling IamUserGroupsApi.list_user_group_members"
  end
  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling IamUserGroupsApi.list_user_group_members, must be smaller than or equal to 100.'
  end

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

  # resource path
  local_var_path = '/user-groups/{user_group_id}/members'.sub('{' + 'user_group_id' + '}', CGI.escape(user_group_id.to_s))

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

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

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

#list_user_group_roles(opts = {}) ⇒ Object

List roles in a user group List roles in a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :page (Integer) —

    Current page.

Returns:

  • (Object) 


500
501
502
503
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 500

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

#list_user_group_roles_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

List roles in a user group List roles in a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :page (Integer) —

    Current page.

Returns:

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

    Object data, response status code and response headers



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 511

def list_user_group_roles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.list_user_group_roles ...'
  end
  # unbox the parameters from the hash
  user_group_id = opts[:'user_group_id']
  # verify the required parameter 'user_group_id' is set
  if @api_client.config.client_side_validation && user_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_id' when calling IamUserGroupsApi.list_user_group_roles"
  end
  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling IamUserGroupsApi.list_user_group_roles, must be smaller than or equal to 100.'
  end

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

  # resource path
  local_var_path = '/user-groups/{user_group_id}/roles'.sub('{' + 'user_group_id' + '}', CGI.escape(user_group_id.to_s))

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

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

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

#list_user_group_service_groups(opts = {}) ⇒ Object

List service groups in a user group List service groups in a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :page (Integer) —

    Current page.

Returns:

  • (Object) 


577
578
579
580
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 577

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

#list_user_group_service_groups_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

List service groups in a user group List service groups in a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :page (Integer) —

    Current page.

Returns:

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

    Object data, response status code and response headers



588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 588

def list_user_group_service_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.list_user_group_service_groups ...'
  end
  # unbox the parameters from the hash
  user_group_id = opts[:'user_group_id']
  # verify the required parameter 'user_group_id' is set
  if @api_client.config.client_side_validation && user_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_id' when calling IamUserGroupsApi.list_user_group_service_groups"
  end
  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling IamUserGroupsApi.list_user_group_service_groups, must be smaller than or equal to 100.'
  end

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

  # resource path
  local_var_path = '/user-groups/{user_group_id}/service-groups'.sub('{' + 'user_group_id' + '}', CGI.escape(user_group_id.to_s))

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

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

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

#list_user_groups(opts = {}) ⇒ Object

List user groups List all user groups.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :page (Integer) —

    Current page.

Returns:

  • (Object) 


653
654
655
656
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 653

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

#list_user_groups_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

List user groups List all user groups.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :page (Integer) —

    Current page.

Returns:

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

    Object data, response status code and response headers



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 663

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

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

  # resource path
  local_var_path = '/user-groups'

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

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

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

#remove_user_group_members(opts = {}) ⇒ nil

Remove members of a user group Remove members of a user group

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :request_body (Hash<String, Object>)

Returns:

  • (nil) 


723
724
725
726
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 723

def remove_user_group_members(opts = {})
  remove_user_group_members_with_http_info(opts)
  nil
end

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

Remove members of a user group Remove members of a user group

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :request_body (Hash<String, Object>)

Returns:

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

    nil, response status code and response headers



733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 733

def remove_user_group_members_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.remove_user_group_members ...'
  end
  # unbox the parameters from the hash
  user_group_id = opts[:'user_group_id']
  # verify the required parameter 'user_group_id' is set
  if @api_client.config.client_side_validation && user_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_id' when calling IamUserGroupsApi.remove_user_group_members"
  end
  # resource path
  local_var_path = '/user-groups/{user_group_id}/members'.sub('{' + 'user_group_id' + '}', CGI.escape(user_group_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(opts[:'request_body'])

  # return_type
  return_type = opts[:debug_return_type]

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

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

#remove_user_group_roles(opts = {}) ⇒ nil

Remove roles from a user group Remove roles from a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :request_body (Hash<String, Object>)

Returns:

  • (nil) 


791
792
793
794
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 791

def remove_user_group_roles(opts = {})
  remove_user_group_roles_with_http_info(opts)
  nil
end

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

Remove roles from a user group Remove roles from a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :request_body (Hash<String, Object>)

Returns:

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

    nil, response status code and response headers



801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 801

def remove_user_group_roles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.remove_user_group_roles ...'
  end
  # unbox the parameters from the hash
  user_group_id = opts[:'user_group_id']
  # verify the required parameter 'user_group_id' is set
  if @api_client.config.client_side_validation && user_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_id' when calling IamUserGroupsApi.remove_user_group_roles"
  end
  # resource path
  local_var_path = '/user-groups/{user_group_id}/roles'.sub('{' + 'user_group_id' + '}', CGI.escape(user_group_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(opts[:'request_body'])

  # return_type
  return_type = opts[:debug_return_type]

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

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

#remove_user_group_service_groups(opts = {}) ⇒ nil

Remove service groups from a user group Remove service groups from a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :request_body (Hash<String, Object>)

Returns:

  • (nil) 


859
860
861
862
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 859

def remove_user_group_service_groups(opts = {})
  remove_user_group_service_groups_with_http_info(opts)
  nil
end

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

Remove service groups from a user group Remove service groups from a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :request_body (Hash<String, Object>)

Returns:

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

    nil, response status code and response headers



869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 869

def remove_user_group_service_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.remove_user_group_service_groups ...'
  end
  # unbox the parameters from the hash
  user_group_id = opts[:'user_group_id']
  # verify the required parameter 'user_group_id' is set
  if @api_client.config.client_side_validation && user_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_id' when calling IamUserGroupsApi.remove_user_group_service_groups"
  end
  # resource path
  local_var_path = '/user-groups/{user_group_id}/service-groups'.sub('{' + 'user_group_id' + '}', CGI.escape(user_group_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(opts[:'request_body'])

  # return_type
  return_type = opts[:debug_return_type]

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

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

#update_a_user_group(opts = {}) ⇒ Object

Update a user group Update a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :request_body (Hash<String, Object>)

Returns:

  • (Object) 


927
928
929
930
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 927

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

#update_a_user_group_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Update a user group Update a user group.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :user_group_id (String) —

    Alphanumeric string identifying the user group. (required)

  • :request_body (Hash<String, Object>)

Returns:

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

    Object data, response status code and response headers



937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
 
# File 'lib/fastly/api/iam_user_groups_api.rb', line 937

def update_a_user_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamUserGroupsApi.update_a_user_group ...'
  end
  # unbox the parameters from the hash
  user_group_id = opts[:'user_group_id']
  # verify the required parameter 'user_group_id' is set
  if @api_client.config.client_side_validation && user_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_id' when calling IamUserGroupsApi.update_a_user_group"
  end
  # resource path
  local_var_path = '/user-groups/{user_group_id}'.sub('{' + 'user_group_id' + '}', CGI.escape(user_group_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(opts[:'request_body'])

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

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

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