Class: LiteLLMClient::SSOSettingsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SSOSettingsApi

Returns a new instance of SSOSettingsApi.



19
20
21
 
# File 'lib/litellm_client/api/sso_settings_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/sso_settings_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_default_team_settings_get_default_team_settings_get(opts = {}) ⇒ DefaultTeamSettingsResponse

Get Default Team Settings Get all SSO settings from the litellm_settings configuration. Returns a structured object with values and descriptions for UI display.

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/litellm_client/api/sso_settings_api.rb', line 26

def get_default_team_settings_get_default_team_settings_get(opts = {})
  data, _status_code, _headers = get_default_team_settings_get_default_team_settings_get_with_http_info(opts)
  data
end

#get_default_team_settings_get_default_team_settings_get_with_http_info(opts = {}) ⇒ Array<(DefaultTeamSettingsResponse, Integer, Hash)>

Get Default Team Settings Get all SSO settings from the litellm_settings configuration. Returns a structured object with values and descriptions for UI display.

Parameters:

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

    the optional parameters

Returns:

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

    DefaultTeamSettingsResponse 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
 
# File 'lib/litellm_client/api/sso_settings_api.rb', line 35

def get_default_team_settings_get_default_team_settings_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SSOSettingsApi.get_default_team_settings_get_default_team_settings_get ...'
  end
  # resource path
  local_var_path = '/get/default_team_settings'

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

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

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

#get_internal_user_settings_get_internal_user_settings_get(opts = {}) ⇒ InternalUserSettingsResponse

Get Internal User Settings Get all SSO settings from the litellm_settings configuration. Returns a structured object with values and descriptions for UI display.

Parameters:

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

    the optional parameters

Returns:



83
84
85
86
 
# File 'lib/litellm_client/api/sso_settings_api.rb', line 83

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

#get_internal_user_settings_get_internal_user_settings_get_with_http_info(opts = {}) ⇒ Array<(InternalUserSettingsResponse, Integer, Hash)>

Get Internal User Settings Get all SSO settings from the litellm_settings configuration. Returns a structured object with values and descriptions for UI display.

Parameters:

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

    the optional parameters

Returns:



92
93
94
95
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
 
# File 'lib/litellm_client/api/sso_settings_api.rb', line 92

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SSOSettingsApi.get_internal_user_settings_get_internal_user_settings_get ...'
  end
  # resource path
  local_var_path = '/get/internal_user_settings'

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

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

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

#get_sso_settings_get_sso_settings_get(opts = {}) ⇒ SSOSettingsResponse

Get Sso Settings Get all SSO configuration settings from the environment variables. Returns a structured object with values and descriptions for UI display.

Parameters:

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

    the optional parameters

Returns:



140
141
142
143
 
# File 'lib/litellm_client/api/sso_settings_api.rb', line 140

def get_sso_settings_get_sso_settings_get(opts = {})
  data, _status_code, _headers = get_sso_settings_get_sso_settings_get_with_http_info(opts)
  data
end

#get_sso_settings_get_sso_settings_get_with_http_info(opts = {}) ⇒ Array<(SSOSettingsResponse, Integer, Hash)>

Get Sso Settings Get all SSO configuration settings from the environment variables. Returns a structured object with values and descriptions for UI display.

Parameters:

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

    the optional parameters

Returns:

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

    SSOSettingsResponse data, response status code and response headers



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

def get_sso_settings_get_sso_settings_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SSOSettingsApi.get_sso_settings_get_sso_settings_get ...'
  end
  # resource path
  local_var_path = '/get/sso_settings'

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

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

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

#update_default_team_settings_update_default_team_settings_patch(default_team_sso_params, opts = {}) ⇒ Object

Update Default Team Settings Update the default team parameters for SSO users. These settings will be applied to new teams created from SSO.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


198
199
200
201
 
# File 'lib/litellm_client/api/sso_settings_api.rb', line 198

def update_default_team_settings_update_default_team_settings_patch(default_team_sso_params, opts = {})
  data, _status_code, _headers = update_default_team_settings_update_default_team_settings_patch_with_http_info(default_team_sso_params, opts)
  data
end

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

Update Default Team Settings Update the default team parameters for SSO users. These settings will be applied to new teams created from SSO.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
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
 
# File 'lib/litellm_client/api/sso_settings_api.rb', line 208

def update_default_team_settings_update_default_team_settings_patch_with_http_info(default_team_sso_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SSOSettingsApi.update_default_team_settings_update_default_team_settings_patch ...'
  end
  # verify the required parameter 'default_team_sso_params' is set
  if @api_client.config.client_side_validation && default_team_sso_params.nil?
    fail ArgumentError, "Missing the required parameter 'default_team_sso_params' when calling SSOSettingsApi.update_default_team_settings_update_default_team_settings_patch"
  end
  # resource path
  local_var_path = '/update/default_team_settings'

  # 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(default_team_sso_params)

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

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

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

#update_internal_user_settings_update_internal_user_settings_patch(default_internal_user_params, opts = {}) ⇒ Object

Update Internal User Settings Update the default internal user parameters for SSO users. These settings will be applied to new users who sign in via SSO.

Parameters:

Returns:

  • (Object) 


266
267
268
269
 
# File 'lib/litellm_client/api/sso_settings_api.rb', line 266

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

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

Update Internal User Settings Update the default internal user parameters for SSO users. These settings will be applied to new users who sign in via SSO.

Parameters:

Returns:

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

    Object data, response status code and response headers



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
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
 
# File 'lib/litellm_client/api/sso_settings_api.rb', line 276

def (default_internal_user_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SSOSettingsApi.update_internal_user_settings_update_internal_user_settings_patch ...'
  end
  # verify the required parameter 'default_internal_user_params' is set
  if @api_client.config.client_side_validation && default_internal_user_params.nil?
    fail ArgumentError, "Missing the required parameter 'default_internal_user_params' when calling SSOSettingsApi.update_internal_user_settings_update_internal_user_settings_patch"
  end
  # resource path
  local_var_path = '/update/internal_user_settings'

  # 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(default_internal_user_params)

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

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

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

#update_sso_settings_update_sso_settings_patch(sso_config, opts = {}) ⇒ Object

Update Sso Settings Update SSO configuration by saving to both environment variables and config file.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


334
335
336
337
 
# File 'lib/litellm_client/api/sso_settings_api.rb', line 334

def update_sso_settings_update_sso_settings_patch(sso_config, opts = {})
  data, _status_code, _headers = update_sso_settings_update_sso_settings_patch_with_http_info(sso_config, opts)
  data
end

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

Update Sso Settings Update SSO configuration by saving to both environment variables and config file.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/litellm_client/api/sso_settings_api.rb', line 344

def update_sso_settings_update_sso_settings_patch_with_http_info(sso_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SSOSettingsApi.update_sso_settings_update_sso_settings_patch ...'
  end
  # verify the required parameter 'sso_config' is set
  if @api_client.config.client_side_validation && sso_config.nil?
    fail ArgumentError, "Missing the required parameter 'sso_config' when calling SSOSettingsApi.update_sso_settings_update_sso_settings_patch"
  end
  # resource path
  local_var_path = '/update/sso_settings'

  # 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(sso_config)

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

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

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