class Kaltura::KalturaUserService
Manage partner users on Kaltura's side
The userId in kaltura is the unique ID in the partner's system, and the [partnerId,Id] couple are unique key in kaltura's DB
Public Class Methods
# File lib/kaltura_client.rb, line 5511 def initialize(client) super(client) end
Public Instance Methods
Adds a new user to an existing account in the Kaltura
database.
Input param $id is the unique identifier in the partner's system.
@return [KalturaUser]
# File lib/kaltura_client.rb, line 5518 def add(user) kparams = {} client.add_param(kparams, 'user', user) client.queue_service_action_call('user', 'add', 'KalturaUser', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
@return [KalturaBulkUpload]
# File lib/kaltura_client.rb, line 5529 def add_from_bulk_upload(file_data, bulk_upload_data=KalturaNotImplemented, bulk_upload_user_data=KalturaNotImplemented) kparams = {} kfiles = {} client.add_param(kfiles, 'fileData', file_data) client.add_param(kparams, 'bulkUploadData', bulk_upload_data) client.add_param(kparams, 'bulkUploadUserData', bulk_upload_user_data) client.queue_service_action_call('user', 'addFromBulkUpload', 'KalturaBulkUpload', kparams, kfiles) if (client.is_multirequest) return nil end return client.do_queue() end
Action which checks whther user login @return [bool]
# File lib/kaltura_client.rb, line 5544 def check_login_data_exists(filter) kparams = {} client.add_param(kparams, 'filter', filter) client.queue_service_action_call('user', 'checkLoginDataExists', 'bool', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Deletes a user from a partner account. @return [KalturaUser]
# File lib/kaltura_client.rb, line 5556 def delete(user_id) kparams = {} client.add_param(kparams, 'userId', user_id) client.queue_service_action_call('user', 'delete', 'KalturaUser', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Disables a user's ability to log into a partner account using an email address and a password.
You may use either a userId or a loginId parameter for this action.
@return [KalturaUser]
# File lib/kaltura_client.rb, line 5569 def disable_login(user_id=KalturaNotImplemented, login_id=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'userId', user_id) client.add_param(kparams, 'loginId', login_id) client.queue_service_action_call('user', 'disableLogin', 'KalturaUser', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Enables a user to log into a partner account using an email address and a password @return [KalturaUser]
# File lib/kaltura_client.rb, line 5582 def enable_login(user_id, login_id, password=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'userId', user_id) client.add_param(kparams, 'loginId', login_id) client.add_param(kparams, 'password', password) client.queue_service_action_call('user', 'enableLogin', 'KalturaUser', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Creates a batch job that sends an email with a link to download a CSV containing a list of users @return [string]
# File lib/kaltura_client.rb, line 5596 def export_to_csv(filter=KalturaNotImplemented, metadata_profile_id=KalturaNotImplemented, additional_fields=KalturaNotImplemented, mapped_fields=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'filter', filter) client.add_param(kparams, 'metadataProfileId', metadata_profile_id) client.add_param(kparams, 'additionalFields', additional_fields) client.add_param(kparams, 'mappedFields', mapped_fields) client.queue_service_action_call('user', 'exportToCsv', 'string', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
get QR image content @return [string]
# File lib/kaltura_client.rb, line 5611 def generate_qr_code(hash_key) kparams = {} client.add_param(kparams, 'hashKey', hash_key) client.queue_service_action_call('user', 'generateQrCode', 'string', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Retrieves a user object for a specified user ID. @return [KalturaUser]
# File lib/kaltura_client.rb, line 5623 def get(user_id=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'userId', user_id) client.queue_service_action_call('user', 'get', 'KalturaUser', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Retrieves a user object for a user's login ID and partner ID.
A login ID is the email address used by a user to log into the system.
@return [KalturaUser]
# File lib/kaltura_client.rb, line 5636 def get_by_login_id(login_id) kparams = {} client.add_param(kparams, 'loginId', login_id) client.queue_service_action_call('user', 'getByLoginId', 'KalturaUser', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Index an entry by id. @return [string]
# File lib/kaltura_client.rb, line 5648 def index(id, should_update=true) kparams = {} client.add_param(kparams, 'id', id) client.add_param(kparams, 'shouldUpdate', should_update) client.queue_service_action_call('user', 'index', 'string', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Lists user objects that are associated with an account.
Blocked users are listed unless you use a filter to exclude them. Deleted users are not listed unless you use a filter to include them.
@return [KalturaUserListResponse]
# File lib/kaltura_client.rb, line 5663 def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'filter', filter) client.add_param(kparams, 'pager', pager) client.queue_service_action_call('user', 'list', 'KalturaUserListResponse', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Logs a user into a partner account with a partner ID, a partner user ID (puser), and a user password. @return [string]
# File lib/kaltura_client.rb, line 5676 def login(partner_id, user_id, password, expiry=86400, privileges='*') kparams = {} client.add_param(kparams, 'partnerId', partner_id) client.add_param(kparams, 'userId', user_id) client.add_param(kparams, 'password', password) client.add_param(kparams, 'expiry', expiry) client.add_param(kparams, 'privileges', privileges) client.queue_service_action_call('user', 'login', 'string', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Logs a user to the destination account provided the KS' user ID is associated with the destination account and the loginData ID matches @return [KalturaSessionResponse]
# File lib/kaltura_client.rb, line 5692 def login_by_ks(requested_partner_id) kparams = {} client.add_param(kparams, 'requestedPartnerId', requested_partner_id) client.queue_service_action_call('user', 'loginByKs', 'KalturaSessionResponse', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Logs a user into a partner account with a user login ID and a user password. @return [string]
# File lib/kaltura_client.rb, line 5704 def login_by_login_id(login_id, password, partner_id=KalturaNotImplemented, expiry=86400, privileges='*', otp=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'loginId', login_id) client.add_param(kparams, 'password', password) client.add_param(kparams, 'partnerId', partner_id) client.add_param(kparams, 'expiry', expiry) client.add_param(kparams, 'privileges', privileges) client.add_param(kparams, 'otp', otp) client.queue_service_action_call('user', 'loginByLoginId', 'string', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Notifies that a user is banned from an account. @return []
# File lib/kaltura_client.rb, line 5721 def notify_ban(user_id) kparams = {} client.add_param(kparams, 'userId', user_id) client.queue_service_action_call('user', 'notifyBan', '', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Reset user's password and send the user an email to generate a new one. @return []
# File lib/kaltura_client.rb, line 5733 def reset_password(email, link_type=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'email', email) client.add_param(kparams, 'linkType', link_type) client.queue_service_action_call('user', 'resetPassword', '', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Will serve a requested CSV @return [string]
# File lib/kaltura_client.rb, line 5746 def serve_csv(id) kparams = {} client.add_param(kparams, 'id', id) client.queue_service_action_call('user', 'serveCsv', 'string', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Set initial user password @return [KalturaAuthentication]
# File lib/kaltura_client.rb, line 5758 def set_initial_password(hash_key, new_password) kparams = {} client.add_param(kparams, 'hashKey', hash_key) client.add_param(kparams, 'newPassword', new_password) client.queue_service_action_call('user', 'setInitialPassword', 'KalturaAuthentication', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Updates an existing user object.
You can also use this action to update the userId.
@return [KalturaUser]
# File lib/kaltura_client.rb, line 5772 def update(user_id, user) kparams = {} client.add_param(kparams, 'userId', user_id) client.add_param(kparams, 'user', user) client.queue_service_action_call('user', 'update', 'KalturaUser', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Updates a user's login data: email, password, name. @return []
# File lib/kaltura_client.rb, line 5785 def update_login_data(old_login_id, password, new_login_id='', new_password='', new_first_name=KalturaNotImplemented, new_last_name=KalturaNotImplemented, otp=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'oldLoginId', old_login_id) client.add_param(kparams, 'password', password) client.add_param(kparams, 'newLoginId', new_login_id) client.add_param(kparams, 'newPassword', new_password) client.add_param(kparams, 'newFirstName', new_first_name) client.add_param(kparams, 'newLastName', new_last_name) client.add_param(kparams, 'otp', otp) client.queue_service_action_call('user', 'updateLoginData', '', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Validate hash key @return [KalturaAuthentication]
# File lib/kaltura_client.rb, line 5803 def validate_hash_key(hash_key) kparams = {} client.add_param(kparams, 'hashKey', hash_key) client.queue_service_action_call('user', 'validateHashKey', 'KalturaAuthentication', kparams) if (client.is_multirequest) return nil end return client.do_queue() end