Class: LiteLLMClient::SCIMV2Api

Inherits:
Object
  • Object
show all
Defined in:
lib/litellm_client/api/scimv2_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SCIMV2Api

Returns a new instance of SCIMV2Api.



19
20
21
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_group_scim_v2_groups_post(scim_group, opts = {}) ⇒ SCIMGroup

Create Group Create a group according to SCIM v2 protocol

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 27

def create_group_scim_v2_groups_post(scim_group, opts = {})
  data, _status_code, _headers = create_group_scim_v2_groups_post_with_http_info(scim_group, opts)
  data
end

#create_group_scim_v2_groups_post_with_http_info(scim_group, opts = {}) ⇒ Array<(SCIMGroup, Integer, Hash)>

Create Group Create a group according to SCIM v2 protocol

Parameters:

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

    the optional parameters

Returns:

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

    SCIMGroup data, response status code and response headers



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/litellm_client/api/scimv2_api.rb', line 37

def create_group_scim_v2_groups_post_with_http_info(scim_group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SCIMV2Api.create_group_scim_v2_groups_post ...'
  end
  # verify the required parameter 'scim_group' is set
  if @api_client.config.client_side_validation && scim_group.nil?
    fail ArgumentError, "Missing the required parameter 'scim_group' when calling SCIMV2Api.create_group_scim_v2_groups_post"
  end
  # resource path
  local_var_path = '/scim/v2/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']) unless header_params['Accept']
  # 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(scim_group)

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

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

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

#create_user_scim_v2_users_post(scim_user, opts = {}) ⇒ SCIMUser

Create User Create a user according to SCIM v2 protocol

Parameters:

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 95

def create_user_scim_v2_users_post(scim_user, opts = {})
  data, _status_code, _headers = create_user_scim_v2_users_post_with_http_info(scim_user, opts)
  data
end

#create_user_scim_v2_users_post_with_http_info(scim_user, opts = {}) ⇒ Array<(SCIMUser, Integer, Hash)>

Create User Create a user according to SCIM v2 protocol

Parameters:

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

    the optional parameters

Returns:

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

    SCIMUser 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
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 105

def create_user_scim_v2_users_post_with_http_info(scim_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SCIMV2Api.create_user_scim_v2_users_post ...'
  end
  # verify the required parameter 'scim_user' is set
  if @api_client.config.client_side_validation && scim_user.nil?
    fail ArgumentError, "Missing the required parameter 'scim_user' when calling SCIMV2Api.create_user_scim_v2_users_post"
  end
  # resource path
  local_var_path = '/scim/v2/Users'

  # 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']) unless header_params['Accept']
  # 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(scim_user)

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

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

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

#delete_group_scim_v2_groups_group_id_delete(group_id, opts = {}) ⇒ nil

Delete Group Delete a group according to SCIM v2 protocol

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


163
164
165
166
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 163

def delete_group_scim_v2_groups_group_id_delete(group_id, opts = {})
  delete_group_scim_v2_groups_group_id_delete_with_http_info(group_id, opts)
  nil
end

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

Delete Group Delete a group according to SCIM v2 protocol

Parameters:

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 173

def delete_group_scim_v2_groups_group_id_delete_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SCIMV2Api.delete_group_scim_v2_groups_group_id_delete ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMV2Api.delete_group_scim_v2_groups_group_id_delete"
  end
  # resource path
  local_var_path = '/scim/v2/Groups/{group_id}'.sub('{' + 'group_id' + '}', CGI.escape(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']) unless header_params['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] || ['APIKeyHeader']

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

#delete_user_scim_v2_users_user_id_delete(user_id, opts = {}) ⇒ nil

Delete User Delete a user according to SCIM v2 protocol

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


226
227
228
229
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 226

def delete_user_scim_v2_users_user_id_delete(user_id, opts = {})
  delete_user_scim_v2_users_user_id_delete_with_http_info(user_id, opts)
  nil
end

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

Delete User Delete a user according to SCIM v2 protocol

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 236

def delete_user_scim_v2_users_user_id_delete_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SCIMV2Api.delete_user_scim_v2_users_user_id_delete ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMV2Api.delete_user_scim_v2_users_user_id_delete"
  end
  # resource path
  local_var_path = '/scim/v2/Users/{user_id}'.sub('{' + 'user_id' + '}', CGI.escape(user_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']) unless header_params['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] || ['APIKeyHeader']

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

#get_group_scim_v2_groups_group_id_get(group_id, opts = {}) ⇒ SCIMGroup

Get Group Get a single group by ID according to SCIM v2 protocol

Parameters:

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

    the optional parameters

Returns:



289
290
291
292
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 289

def get_group_scim_v2_groups_group_id_get(group_id, opts = {})
  data, _status_code, _headers = get_group_scim_v2_groups_group_id_get_with_http_info(group_id, opts)
  data
end

#get_group_scim_v2_groups_group_id_get_with_http_info(group_id, opts = {}) ⇒ Array<(SCIMGroup, Integer, Hash)>

Get Group Get a single group by ID according to SCIM v2 protocol

Parameters:

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

    the optional parameters

Returns:

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

    SCIMGroup data, response status code and response headers



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
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 299

def get_group_scim_v2_groups_group_id_get_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SCIMV2Api.get_group_scim_v2_groups_group_id_get ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMV2Api.get_group_scim_v2_groups_group_id_get"
  end
  # resource path
  local_var_path = '/scim/v2/Groups/{group_id}'.sub('{' + 'group_id' + '}', CGI.escape(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']) unless header_params['Accept']

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

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

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

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

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

#get_groups_scim_v2_groups_get(opts = {}) ⇒ SCIMListResponse

Get Groups Get a list of groups according to SCIM v2 protocol

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :start_index (Integer) — default: default to 1
  • :count (Integer) — default: default to 10
  • :filter (String)

Returns:



354
355
356
357
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 354

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

#get_groups_scim_v2_groups_get_with_http_info(opts = {}) ⇒ Array<(SCIMListResponse, Integer, Hash)>

Get Groups Get a list of groups according to SCIM v2 protocol

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :start_index (Integer) — default: default to 1
  • :count (Integer) — default: default to 10
  • :filter (String)

Returns:

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

    SCIMListResponse data, response status code and response headers



366
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
416
417
418
419
420
421
422
423
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 366

def get_groups_scim_v2_groups_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SCIMV2Api.get_groups_scim_v2_groups_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'start_index'].nil? && opts[:'start_index'] < 1
    fail ArgumentError, 'invalid value for "opts[:"start_index"]" when calling SCIMV2Api.get_groups_scim_v2_groups_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
    fail ArgumentError, 'invalid value for "opts[:"count"]" when calling SCIMV2Api.get_groups_scim_v2_groups_get, must be smaller than or equal to 100.'
  end

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

  # resource path
  local_var_path = '/scim/v2/Groups'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?

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

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

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

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

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

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

#get_user_scim_v2_users_user_id_get(user_id, opts = {}) ⇒ SCIMUser

Get User Get a single user by ID according to SCIM v2 protocol

Parameters:

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

    the optional parameters

Returns:



430
431
432
433
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 430

def get_user_scim_v2_users_user_id_get(user_id, opts = {})
  data, _status_code, _headers = get_user_scim_v2_users_user_id_get_with_http_info(user_id, opts)
  data
end

#get_user_scim_v2_users_user_id_get_with_http_info(user_id, opts = {}) ⇒ Array<(SCIMUser, Integer, Hash)>

Get User Get a single user by ID according to SCIM v2 protocol

Parameters:

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

    the optional parameters

Returns:

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

    SCIMUser data, response status code and response headers



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
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 440

def get_user_scim_v2_users_user_id_get_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SCIMV2Api.get_user_scim_v2_users_user_id_get ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMV2Api.get_user_scim_v2_users_user_id_get"
  end
  # resource path
  local_var_path = '/scim/v2/Users/{user_id}'.sub('{' + 'user_id' + '}', CGI.escape(user_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']) unless header_params['Accept']

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

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

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

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

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

#get_users_scim_v2_users_get(opts = {}) ⇒ SCIMListResponse

Get Users Get a list of users according to SCIM v2 protocol

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :start_index (Integer) — default: default to 1
  • :count (Integer) — default: default to 10
  • :filter (String)

Returns:



495
496
497
498
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 495

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

#get_users_scim_v2_users_get_with_http_info(opts = {}) ⇒ Array<(SCIMListResponse, Integer, Hash)>

Get Users Get a list of users according to SCIM v2 protocol

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :start_index (Integer) — default: default to 1
  • :count (Integer) — default: default to 10
  • :filter (String)

Returns:

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

    SCIMListResponse data, response status code and response headers



507
508
509
510
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
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 507

def get_users_scim_v2_users_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SCIMV2Api.get_users_scim_v2_users_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'start_index'].nil? && opts[:'start_index'] < 1
    fail ArgumentError, 'invalid value for "opts[:"start_index"]" when calling SCIMV2Api.get_users_scim_v2_users_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
    fail ArgumentError, 'invalid value for "opts[:"count"]" when calling SCIMV2Api.get_users_scim_v2_users_get, must be smaller than or equal to 100.'
  end

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

  # resource path
  local_var_path = '/scim/v2/Users'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?

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

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

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

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

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

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

#patch_group_scim_v2_groups_group_id_patch(group_id, scim_patch_op, opts = {}) ⇒ SCIMGroup

Patch Group Patch a group according to SCIM v2 protocol

Parameters:

  • group_id (String)
  • scim_patch_op (SCIMPatchOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



572
573
574
575
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 572

def patch_group_scim_v2_groups_group_id_patch(group_id, scim_patch_op, opts = {})
  data, _status_code, _headers = patch_group_scim_v2_groups_group_id_patch_with_http_info(group_id, scim_patch_op, opts)
  data
end

#patch_group_scim_v2_groups_group_id_patch_with_http_info(group_id, scim_patch_op, opts = {}) ⇒ Array<(SCIMGroup, Integer, Hash)>

Patch Group Patch a group according to SCIM v2 protocol

Parameters:

  • group_id (String)
  • scim_patch_op (SCIMPatchOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    SCIMGroup data, response status code and response headers



583
584
585
586
587
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
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 583

def patch_group_scim_v2_groups_group_id_patch_with_http_info(group_id, scim_patch_op, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SCIMV2Api.patch_group_scim_v2_groups_group_id_patch ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMV2Api.patch_group_scim_v2_groups_group_id_patch"
  end
  # verify the required parameter 'scim_patch_op' is set
  if @api_client.config.client_side_validation && scim_patch_op.nil?
    fail ArgumentError, "Missing the required parameter 'scim_patch_op' when calling SCIMV2Api.patch_group_scim_v2_groups_group_id_patch"
  end
  # resource path
  local_var_path = '/scim/v2/Groups/{group_id}'.sub('{' + 'group_id' + '}', CGI.escape(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']) unless header_params['Accept']
  # 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(scim_patch_op)

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

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

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

#patch_user_scim_v2_users_user_id_patch(user_id, scim_patch_op, opts = {}) ⇒ SCIMUser

Patch User Patch a user according to SCIM v2 protocol

Parameters:

  • user_id (String)
  • scim_patch_op (SCIMPatchOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



646
647
648
649
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 646

def patch_user_scim_v2_users_user_id_patch(user_id, scim_patch_op, opts = {})
  data, _status_code, _headers = patch_user_scim_v2_users_user_id_patch_with_http_info(user_id, scim_patch_op, opts)
  data
end

#patch_user_scim_v2_users_user_id_patch_with_http_info(user_id, scim_patch_op, opts = {}) ⇒ Array<(SCIMUser, Integer, Hash)>

Patch User Patch a user according to SCIM v2 protocol

Parameters:

  • user_id (String)
  • scim_patch_op (SCIMPatchOp)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    SCIMUser data, response status code and response headers



657
658
659
660
661
662
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
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 657

def patch_user_scim_v2_users_user_id_patch_with_http_info(user_id, scim_patch_op, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SCIMV2Api.patch_user_scim_v2_users_user_id_patch ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMV2Api.patch_user_scim_v2_users_user_id_patch"
  end
  # verify the required parameter 'scim_patch_op' is set
  if @api_client.config.client_side_validation && scim_patch_op.nil?
    fail ArgumentError, "Missing the required parameter 'scim_patch_op' when calling SCIMV2Api.patch_user_scim_v2_users_user_id_patch"
  end
  # resource path
  local_var_path = '/scim/v2/Users/{user_id}'.sub('{' + 'user_id' + '}', CGI.escape(user_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']) unless header_params['Accept']
  # 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(scim_patch_op)

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

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

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

#update_group_scim_v2_groups_group_id_put(group_id, scim_group, opts = {}) ⇒ SCIMGroup

Update Group Update a group according to SCIM v2 protocol

Parameters:

  • group_id (String)
  • scim_group (SCIMGroup)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



720
721
722
723
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 720

def update_group_scim_v2_groups_group_id_put(group_id, scim_group, opts = {})
  data, _status_code, _headers = update_group_scim_v2_groups_group_id_put_with_http_info(group_id, scim_group, opts)
  data
end

#update_group_scim_v2_groups_group_id_put_with_http_info(group_id, scim_group, opts = {}) ⇒ Array<(SCIMGroup, Integer, Hash)>

Update Group Update a group according to SCIM v2 protocol

Parameters:

  • group_id (String)
  • scim_group (SCIMGroup)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    SCIMGroup data, response status code and response headers



731
732
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
785
786
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 731

def update_group_scim_v2_groups_group_id_put_with_http_info(group_id, scim_group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SCIMV2Api.update_group_scim_v2_groups_group_id_put ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMV2Api.update_group_scim_v2_groups_group_id_put"
  end
  # verify the required parameter 'scim_group' is set
  if @api_client.config.client_side_validation && scim_group.nil?
    fail ArgumentError, "Missing the required parameter 'scim_group' when calling SCIMV2Api.update_group_scim_v2_groups_group_id_put"
  end
  # resource path
  local_var_path = '/scim/v2/Groups/{group_id}'.sub('{' + 'group_id' + '}', CGI.escape(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']) unless header_params['Accept']
  # 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(scim_group)

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

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

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

#update_user_scim_v2_users_user_id_put(user_id, scim_user, opts = {}) ⇒ SCIMUser

Update User Update a user according to SCIM v2 protocol

Parameters:

  • user_id (String)
  • scim_user (SCIMUser)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



794
795
796
797
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 794

def update_user_scim_v2_users_user_id_put(user_id, scim_user, opts = {})
  data, _status_code, _headers = update_user_scim_v2_users_user_id_put_with_http_info(user_id, scim_user, opts)
  data
end

#update_user_scim_v2_users_user_id_put_with_http_info(user_id, scim_user, opts = {}) ⇒ Array<(SCIMUser, Integer, Hash)>

Update User Update a user according to SCIM v2 protocol

Parameters:

  • user_id (String)
  • scim_user (SCIMUser)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    SCIMUser data, response status code and response headers



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
853
854
855
856
857
858
859
860
 
# File 'lib/litellm_client/api/scimv2_api.rb', line 805

def update_user_scim_v2_users_user_id_put_with_http_info(user_id, scim_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SCIMV2Api.update_user_scim_v2_users_user_id_put ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMV2Api.update_user_scim_v2_users_user_id_put"
  end
  # verify the required parameter 'scim_user' is set
  if @api_client.config.client_side_validation && scim_user.nil?
    fail ArgumentError, "Missing the required parameter 'scim_user' when calling SCIMV2Api.update_user_scim_v2_users_user_id_put"
  end
  # resource path
  local_var_path = '/scim/v2/Users/{user_id}'.sub('{' + 'user_id' + '}', CGI.escape(user_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']) unless header_params['Accept']
  # 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(scim_user)

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

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

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