Class: Kaltura::KalturaSsoService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_plugins/kaltura_sso_client_plugin.rb

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaSsoService

Returns a new instance of KalturaSsoService.



189
190
191
# File 'lib/kaltura_plugins/kaltura_sso_client_plugin.rb', line 189

def initialize(client)
	super(client)
end

Instance Method Details

#add(sso) ⇒ KalturaSso

Adds a new sso configuration.

Returns:



195
196
197
198
199
200
201
202
203
# File 'lib/kaltura_plugins/kaltura_sso_client_plugin.rb', line 195

def add(sso)
	kparams = {}
	client.add_param(kparams, 'sso', sso)
	client.queue_service_action_call('sso_sso', 'add', 'KalturaSso', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#delete(sso_id) ⇒ KalturaSso

Delete sso by ID

Returns:



207
208
209
210
211
212
213
214
215
# File 'lib/kaltura_plugins/kaltura_sso_client_plugin.rb', line 207

def delete(sso_id)
	kparams = {}
	client.add_param(kparams, 'ssoId', sso_id)
	client.queue_service_action_call('sso_sso', 'delete', 'KalturaSso', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#get(sso_id) ⇒ KalturaSso

Retrieves sso object

Returns:



219
220
221
222
223
224
225
226
227
# File 'lib/kaltura_plugins/kaltura_sso_client_plugin.rb', line 219

def get(sso_id)
	kparams = {}
	client.add_param(kparams, 'ssoId', sso_id)
	client.queue_service_action_call('sso_sso', 'get', 'KalturaSso', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaSsoListResponse

Lists sso objects that are associated with an account.



231
232
233
234
235
236
237
238
239
240
# File 'lib/kaltura_plugins/kaltura_sso_client_plugin.rb', line 231

def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'filter', filter)
	client.add_param(kparams, 'pager', pager)
	client.queue_service_action_call('sso_sso', 'list', 'KalturaSsoListResponse', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#login(user_id, application_type, partner_id = KalturaNotImplemented) ⇒ string

Login with SSO, getting redirect url according to application type and partner Id or according to application type and domain

Returns:

  • (string)


245
246
247
248
249
250
251
252
253
254
255
# File 'lib/kaltura_plugins/kaltura_sso_client_plugin.rb', line 245

def (user_id, application_type, partner_id=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'userId', user_id)
	client.add_param(kparams, 'applicationType', application_type)
	client.add_param(kparams, 'partnerId', partner_id)
	client.queue_service_action_call('sso_sso', 'login', 'string', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#update(sso_id, sso) ⇒ KalturaSso

Update sso by ID

Returns:



259
260
261
262
263
264
265
266
267
268
# File 'lib/kaltura_plugins/kaltura_sso_client_plugin.rb', line 259

def update(sso_id, sso)
	kparams = {}
	client.add_param(kparams, 'ssoId', sso_id)
	client.add_param(kparams, 'sso', sso)
	client.queue_service_action_call('sso_sso', 'update', 'KalturaSso', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end