Class: Kaltura::KalturaUserService

Inherits:
KalturaServiceBase show all
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

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaUserService

Returns a new instance of KalturaUserService.



5496
5497
5498
 
# File 'lib/kaltura_client.rb', line 5496

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.

Returns:



5503
5504
5505
5506
5507
5508
5509
5510
5511
 
# File 'lib/kaltura_client.rb', line 5503

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

Returns:



5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
 
# File 'lib/kaltura_client.rb', line 5514

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

Returns:

  • (bool) 


5529
5530
5531
5532
5533
5534
5535
5536
5537
 
# File 'lib/kaltura_client.rb', line 5529

def (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.

Returns:



5541
5542
5543
5544
5545
5546
5547
5548
5549
 
# File 'lib/kaltura_client.rb', line 5541

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.

Returns:



5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
 
# File 'lib/kaltura_client.rb', line 5554

def (user_id=KalturaNotImplemented, =KalturaNotImplemented)
  kparams = {}
  client.add_param(kparams, 'userId', user_id)
  client.add_param(kparams, 'loginId', )
  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

Returns:



5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
 
# File 'lib/kaltura_client.rb', line 5567

def (user_id, , password=KalturaNotImplemented)
  kparams = {}
  client.add_param(kparams, 'userId', user_id)
  client.add_param(kparams, 'loginId', )
  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, mapped_fields = KalturaNotImplemented) ⇒ string

Creates a batch job that sends an email with a link to download a CSV containing a list of users

Returns:

  • (string) 


5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
 
# File 'lib/kaltura_client.rb', line 5581

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

#generate_qr_code(hash_key) ⇒ string

get QR image content

Returns:

  • (string) 


5596
5597
5598
5599
5600
5601
5602
5603
5604
 
# File 'lib/kaltura_client.rb', line 5596

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.

Returns:



5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/kaltura_client.rb', line 5608

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.

Returns:



5621
5622
5623
5624
5625
5626
5627
5628
5629
 
# File 'lib/kaltura_client.rb', line 5621

def ()
  kparams = {}
  client.add_param(kparams, 'loginId', )
  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.

Returns:

  • (string) 


5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
 
# File 'lib/kaltura_client.rb', line 5633

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.

Returns:



5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
 
# File 'lib/kaltura_client.rb', line 5648

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.

Returns:

  • (string) 


5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
 
# File 'lib/kaltura_client.rb', line 5661

def (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

Returns:



5677
5678
5679
5680
5681
5682
5683
5684
5685
 
# File 'lib/kaltura_client.rb', line 5677

def (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.

Returns:

  • (string) 


5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
 
# File 'lib/kaltura_client.rb', line 5689

def (, password, partner_id=KalturaNotImplemented, expiry=86400, privileges='*', otp=KalturaNotImplemented)
  kparams = {}
  client.add_param(kparams, 'loginId', )
  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.

Returns:



5706
5707
5708
5709
5710
5711
5712
5713
5714
 
# File 'lib/kaltura_client.rb', line 5706

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, link_type = KalturaNotImplemented) ⇒ Object

Reset user’s password and send the user an email to generate a new one.

Returns:



5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
 
# File 'lib/kaltura_client.rb', line 5718

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

#serve_csv(id) ⇒ string

Will serve a requested CSV

Returns:

  • (string) 


5731
5732
5733
5734
5735
5736
5737
5738
5739
 
# File 'lib/kaltura_client.rb', line 5731

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

Returns:



5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
 
# File 'lib/kaltura_client.rb', line 5743

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.

Returns:



5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
 
# File 'lib/kaltura_client.rb', line 5757

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.

Returns:



5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
 
# File 'lib/kaltura_client.rb', line 5770

def (, password, ='', new_password='', new_first_name=KalturaNotImplemented, new_last_name=KalturaNotImplemented, otp=KalturaNotImplemented)
  kparams = {}
  client.add_param(kparams, 'oldLoginId', )
  client.add_param(kparams, 'password', password)
  client.add_param(kparams, 'newLoginId', )
  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(hash_key) ⇒ KalturaAuthentication

Validate hash key

Returns:



5788
5789
5790
5791
5792
5793
5794
5795
5796
 
# File 'lib/kaltura_client.rb', line 5788

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