Class: KalturaApi::KalturaAdminUserService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_client.rb

Overview

Manage details for the administrative user

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaAdminUserService

Returns a new instance of KalturaAdminUserService.



9135
9136
9137
 
# File 'lib/kaltura_client.rb', line 9135

def initialize(client)
	super(client)
end

Instance Method Details

#login(email, password, partner_id = KalturaNotImplemented) ⇒ Object

Get an admin session using admin email and password (Used for login to the KMC application)



9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
 
# File 'lib/kaltura_client.rb', line 9169

def (email, password, partner_id=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'email', email);
	client.add_param(kparams, 'password', password);
	client.add_param(kparams, 'partnerId', partner_id);
	client.queue_service_action_call('adminuser', 'login', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#reset_password(email) ⇒ Object

Reset admin user password and send it to the users email address



9157
9158
9159
9160
9161
9162
9163
9164
9165
 
# File 'lib/kaltura_client.rb', line 9157

def reset_password(email)
	kparams = {}
	client.add_param(kparams, 'email', email);
	client.queue_service_action_call('adminuser', 'resetPassword', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#set_initial_password(hash_key, new_password) ⇒ Object

Set initial users password



9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
 
# File 'lib/kaltura_client.rb', line 9183

def set_initial_password(hash_key, new_password)
	kparams = {}
	client.add_param(kparams, 'hashKey', hash_key);
	# new password to set
	client.add_param(kparams, 'newPassword', new_password);
	client.queue_service_action_call('adminuser', 'setInitialPassword', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#update_password(email, password, new_email = '', new_password = '') ⇒ Object

Update admin user password and email



9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
 
# File 'lib/kaltura_client.rb', line 9141

def update_password(email, password, new_email='', new_password='')
	kparams = {}
	client.add_param(kparams, 'email', email);
	client.add_param(kparams, 'password', password);
	# Optional, provide only when you want to update the email
	client.add_param(kparams, 'newEmail', new_email);
	client.add_param(kparams, 'newPassword', new_password);
	client.queue_service_action_call('adminuser', 'updatePassword', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end