Class: Kaltura::KalturaUserService
- Inherits:
-
KalturaServiceBase
- Object
- KalturaServiceBase
- Kaltura::KalturaUserService
- Defined in:
- lib/kaltura_client.rb
Overview
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
Instance Attribute Summary
Attributes inherited from KalturaServiceBase
Instance Method Summary collapse
-
#add(user) ⇒ KalturaUser
Adds a new user to an existing account in the Kaltura database.
- #add_from_bulk_upload(file_data, bulk_upload_data = KalturaNotImplemented, bulk_upload_user_data = KalturaNotImplemented) ⇒ KalturaBulkUpload
-
#check_login_data_exists(filter) ⇒ bool
Action which checks whther user login.
-
#delete(user_id) ⇒ KalturaUser
Deletes a user from a partner account.
-
#disable_login(user_id = KalturaNotImplemented, login_id = KalturaNotImplemented) ⇒ KalturaUser
Disables a user’s ability to log into a partner account using an email address and a password.
-
#enable_login(user_id, login_id, password = KalturaNotImplemented) ⇒ KalturaUser
Enables a user to log into a partner account using an email address and a password.
-
#export_to_csv(filter = KalturaNotImplemented, metadata_profile_id = KalturaNotImplemented, additional_fields = KalturaNotImplemented) ⇒ string
Creates a batch job that sends an email with a link to download a CSV containing a list of users.
-
#generate_qr_code(hash_key) ⇒ string
get QR image content.
-
#get(user_id = KalturaNotImplemented) ⇒ KalturaUser
Retrieves a user object for a specified user ID.
-
#get_by_login_id(login_id) ⇒ KalturaUser
Retrieves a user object for a user’s login ID and partner ID.
-
#index(id, should_update = true) ⇒ string
Index an entry by id.
-
#initialize(client) ⇒ KalturaUserService
constructor
A new instance of KalturaUserService.
-
#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaUserListResponse
Lists user objects that are associated with an account.
-
#login(partner_id, user_id, password, expiry = 86400, privileges = '*') ⇒ string
Logs a user into a partner account with a partner ID, a partner user ID (puser), and a user password.
-
#login_by_ks(requested_partner_id) ⇒ KalturaSessionResponse
Logs a user to the destination account provided the KS’ user ID is associated with the destination account and the loginData ID matches.
-
#login_by_login_id(login_id, password, partner_id = KalturaNotImplemented, expiry = 86400, privileges = '*', otp = KalturaNotImplemented) ⇒ string
Logs a user into a partner account with a user login ID and a user password.
-
#notify_ban(user_id) ⇒ Object
Notifies that a user is banned from an account.
-
#reset_password(email) ⇒ Object
Reset user’s password and send the user an email to generate a new one.
-
#serve_csv(id) ⇒ string
Will serve a requested CSV.
-
#set_initial_password(hash_key, new_password) ⇒ KalturaAuthentication
Set initial user password.
-
#update(user_id, user) ⇒ KalturaUser
Updates an existing user object.
-
#update_login_data(old_login_id, password, new_login_id = '', new_password = '', new_first_name = KalturaNotImplemented, new_last_name = KalturaNotImplemented, otp = KalturaNotImplemented) ⇒ Object
Updates a user’s login data: email, password, name.
Constructor Details
#initialize(client) ⇒ KalturaUserService
Returns a new instance of KalturaUserService.
5408 5409 5410 |
# File 'lib/kaltura_client.rb', line 5408 def initialize(client) super(client) end |
Instance Method Details
#add(user) ⇒ KalturaUser
Adds a new user to an existing account in the Kaltura database. Input param $id is the unique identifier in the partner’s system.
5415 5416 5417 5418 5419 5420 5421 5422 5423 |
# File 'lib/kaltura_client.rb', line 5415 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 |
#add_from_bulk_upload(file_data, bulk_upload_data = KalturaNotImplemented, bulk_upload_user_data = KalturaNotImplemented) ⇒ KalturaBulkUpload
5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 |
# File 'lib/kaltura_client.rb', line 5426 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 |
#check_login_data_exists(filter) ⇒ bool
Action which checks whther user login
5441 5442 5443 5444 5445 5446 5447 5448 5449 |
# File 'lib/kaltura_client.rb', line 5441 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 |
#delete(user_id) ⇒ KalturaUser
Deletes a user from a partner account.
5453 5454 5455 5456 5457 5458 5459 5460 5461 |
# File 'lib/kaltura_client.rb', line 5453 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 |
#disable_login(user_id = KalturaNotImplemented, login_id = KalturaNotImplemented) ⇒ KalturaUser
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.
5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 |
# File 'lib/kaltura_client.rb', line 5466 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 |
#enable_login(user_id, login_id, password = KalturaNotImplemented) ⇒ KalturaUser
Enables a user to log into a partner account using an email address and a password
5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 |
# File 'lib/kaltura_client.rb', line 5479 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 |
#export_to_csv(filter = KalturaNotImplemented, metadata_profile_id = KalturaNotImplemented, additional_fields = KalturaNotImplemented) ⇒ string
Creates a batch job that sends an email with a link to download a CSV containing a list of users
5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 |
# File 'lib/kaltura_client.rb', line 5493 def export_to_csv(filter=KalturaNotImplemented, =KalturaNotImplemented, additional_fields=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'filter', filter) client.add_param(kparams, 'metadataProfileId', ) client.add_param(kparams, 'additionalFields', additional_fields) client.queue_service_action_call('user', 'exportToCsv', 'string', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#generate_qr_code(hash_key) ⇒ string
get QR image content
5507 5508 5509 5510 5511 5512 5513 5514 5515 |
# File 'lib/kaltura_client.rb', line 5507 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 |
#get(user_id = KalturaNotImplemented) ⇒ KalturaUser
Retrieves a user object for a specified user ID.
5519 5520 5521 5522 5523 5524 5525 5526 5527 |
# File 'lib/kaltura_client.rb', line 5519 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 |
#get_by_login_id(login_id) ⇒ KalturaUser
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.
5532 5533 5534 5535 5536 5537 5538 5539 5540 |
# File 'lib/kaltura_client.rb', line 5532 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(id, should_update = true) ⇒ string
Index an entry by id.
5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 |
# File 'lib/kaltura_client.rb', line 5544 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 |
#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaUserListResponse
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.
5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 |
# File 'lib/kaltura_client.rb', line 5559 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 |
#login(partner_id, user_id, password, expiry = 86400, privileges = '*') ⇒ string
Logs a user into a partner account with a partner ID, a partner user ID (puser), and a user password.
5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 |
# File 'lib/kaltura_client.rb', line 5572 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 |
#login_by_ks(requested_partner_id) ⇒ KalturaSessionResponse
Logs a user to the destination account provided the KS’ user ID is associated with the destination account and the loginData ID matches
5588 5589 5590 5591 5592 5593 5594 5595 5596 |
# File 'lib/kaltura_client.rb', line 5588 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 |
#login_by_login_id(login_id, password, partner_id = KalturaNotImplemented, expiry = 86400, privileges = '*', otp = KalturaNotImplemented) ⇒ string
Logs a user into a partner account with a user login ID and a user password.
5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 |
# File 'lib/kaltura_client.rb', line 5600 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 |
#notify_ban(user_id) ⇒ Object
Notifies that a user is banned from an account.
5617 5618 5619 5620 5621 5622 5623 5624 5625 |
# File 'lib/kaltura_client.rb', line 5617 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_password(email) ⇒ Object
Reset user’s password and send the user an email to generate a new one.
5629 5630 5631 5632 5633 5634 5635 5636 5637 |
# File 'lib/kaltura_client.rb', line 5629 def reset_password(email) kparams = {} client.add_param(kparams, 'email', email) client.queue_service_action_call('user', 'resetPassword', '', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#serve_csv(id) ⇒ string
Will serve a requested CSV
5641 5642 5643 5644 5645 5646 5647 5648 5649 |
# File 'lib/kaltura_client.rb', line 5641 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_password(hash_key, new_password) ⇒ KalturaAuthentication
Set initial user password
5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 |
# File 'lib/kaltura_client.rb', line 5653 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 |
#update(user_id, user) ⇒ KalturaUser
Updates an existing user object. You can also use this action to update the userId.
5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 |
# File 'lib/kaltura_client.rb', line 5667 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 |
#update_login_data(old_login_id, password, new_login_id = '', new_password = '', new_first_name = KalturaNotImplemented, new_last_name = KalturaNotImplemented, otp = KalturaNotImplemented) ⇒ Object
Updates a user’s login data: email, password, name.
5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 |
# File 'lib/kaltura_client.rb', line 5680 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 |