Package com.kaltura.client.services

Class UserService

java.lang.Object

com.kaltura.client.services.UserService

public class UserService
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserService.AddFromBulkUploadUserBuilder
static class	UserService.AddUserBuilder
static class	UserService.CheckLoginDataExistsUserBuilder
static class	UserService.DeleteUserBuilder
static class	UserService.DisableLoginUserBuilder
static class	UserService.EnableLoginUserBuilder
static class	UserService.ExportToCsvUserBuilder
static class	UserService.GenerateQrCodeUserBuilder
static class	UserService.GetByLoginIdUserBuilder
static class	UserService.GetUserBuilder
static class	UserService.IndexUserBuilder
static class	UserService.ListUserBuilder
static class	UserService.LoginByKsUserBuilder
static class	UserService.LoginByLoginIdUserBuilder
static class	UserService.LoginDataResetPasswordUserBuilder
static class	UserService.LoginUserBuilder
static class	UserService.NotifyBanUserBuilder
static class	UserService.ResetPasswordUserBuilder
static class	UserService.ServeCsvUserBuilder
static class	UserService.SetInitialPasswordUserBuilder
static class	UserService.UpdateLoginDataUserBuilder
static class	UserService.UpdateUserBuilder
static class	UserService.ValidateHashKeyUserBuilder

Constructor Summary

Constructors

Constructor	Description
UserService()

Method Summary

Modifier and Type	Method	Description
static UserService.AddUserBuilder	add(User user)	Adds a new user to an existing account in the Kaltura database.
static UserService.AddFromBulkUploadUserBuilder	addFromBulkUpload(FileHolder fileData)
static UserService.AddFromBulkUploadUserBuilder	addFromBulkUpload(FileHolder fileData, BulkUploadJobData bulkUploadData)
static UserService.AddFromBulkUploadUserBuilder	addFromBulkUpload(FileHolder fileData, BulkUploadJobData bulkUploadData, BulkUploadUserData bulkUploadUserData)
static UserService.AddFromBulkUploadUserBuilder	addFromBulkUpload(File fileData)
static UserService.AddFromBulkUploadUserBuilder	addFromBulkUpload(FileInputStream fileData, String fileDataMimeType, String fileDataName)
static UserService.AddFromBulkUploadUserBuilder	addFromBulkUpload(FileInputStream fileData, String fileDataMimeType, String fileDataName, BulkUploadJobData bulkUploadData)
static UserService.AddFromBulkUploadUserBuilder	addFromBulkUpload(FileInputStream fileData, String fileDataMimeType, String fileDataName, BulkUploadJobData bulkUploadData, BulkUploadUserData bulkUploadUserData)
static UserService.AddFromBulkUploadUserBuilder	addFromBulkUpload(File fileData, BulkUploadJobData bulkUploadData)
static UserService.AddFromBulkUploadUserBuilder	addFromBulkUpload(File fileData, BulkUploadJobData bulkUploadData, BulkUploadUserData bulkUploadUserData)
static UserService.AddFromBulkUploadUserBuilder	addFromBulkUpload(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize)
static UserService.AddFromBulkUploadUserBuilder	addFromBulkUpload(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize, BulkUploadJobData bulkUploadData)
static UserService.AddFromBulkUploadUserBuilder	addFromBulkUpload(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize, BulkUploadJobData bulkUploadData, BulkUploadUserData bulkUploadUserData)
static UserService.CheckLoginDataExistsUserBuilder	checkLoginDataExists(UserLoginDataFilter filter)	Action which checks whther user login
static UserService.DeleteUserBuilder	delete(String userId)	Deletes a user from a partner account.
static UserService.DisableLoginUserBuilder	disableLogin()
static UserService.DisableLoginUserBuilder	disableLogin(String userId)
static UserService.DisableLoginUserBuilder	disableLogin(String userId, String loginId)	Disables a user's ability to log into a partner account using an email address and a password.
static UserService.EnableLoginUserBuilder	enableLogin(String userId, String loginId)
static UserService.EnableLoginUserBuilder	enableLogin(String userId, String loginId, String password)	Enables a user to log into a partner account using an email address and a password
static UserService.ExportToCsvUserBuilder	exportToCsv()
static UserService.ExportToCsvUserBuilder	exportToCsv(UserFilter filter)
static UserService.ExportToCsvUserBuilder	exportToCsv(UserFilter filter, int metadataProfileId)
static UserService.ExportToCsvUserBuilder	exportToCsv(UserFilter filter, int metadataProfileId, List<CsvAdditionalFieldInfo> additionalFields)
static UserService.ExportToCsvUserBuilder	exportToCsv(UserFilter filter, int metadataProfileId, List<CsvAdditionalFieldInfo> additionalFields, List<KeyValue> mappedFields)
static UserService.ExportToCsvUserBuilder	exportToCsv(UserFilter filter, int metadataProfileId, List<CsvAdditionalFieldInfo> additionalFields, List<KeyValue> mappedFields, ExportToCsvOptions options)	Creates a batch job that sends an email with a link to download a CSV containing a list of users
static UserService.GenerateQrCodeUserBuilder	generateQrCode(String hashKey)	get QR image content
static UserService.GetUserBuilder	get()
static UserService.GetUserBuilder	get(String userId)	Retrieves a user object for a specified user ID.
static UserService.GetByLoginIdUserBuilder	getByLoginId(String loginId)	Retrieves a user object for a user's login ID and partner ID.
static UserService.IndexUserBuilder	index(String id)
static UserService.IndexUserBuilder	index(String id, boolean shouldUpdate)	Index an entry by id.
static UserService.ListUserBuilder	list()
static UserService.ListUserBuilder	list(UserFilter filter)
static UserService.ListUserBuilder	list(UserFilter filter, FilterPager pager)	Lists user objects that are associated with an account.
static UserService.LoginUserBuilder	login(int partnerId, String userId, String password)
static UserService.LoginUserBuilder	login(int partnerId, String userId, String password, int expiry)
static UserService.LoginUserBuilder	login(int partnerId, String userId, String password, int expiry, String privileges)	Logs a user into a partner account with a partner ID, a partner user ID (puser), and a user password.
static UserService.LoginByKsUserBuilder	loginByKs(int requestedPartnerId)	Logs a user to the destination account provided the KS' user ID is associated with the destination account and the loginData ID matches
static UserService.LoginByLoginIdUserBuilder	loginByLoginId(String loginId, String password)
static UserService.LoginByLoginIdUserBuilder	loginByLoginId(String loginId, String password, int partnerId)
static UserService.LoginByLoginIdUserBuilder	loginByLoginId(String loginId, String password, int partnerId, int expiry)
static UserService.LoginByLoginIdUserBuilder	loginByLoginId(String loginId, String password, int partnerId, int expiry, String privileges)
static UserService.LoginByLoginIdUserBuilder	loginByLoginId(String loginId, String password, int partnerId, int expiry, String privileges, String otp)	Logs a user into a partner account with a user login ID and a user password.
static UserService.LoginDataResetPasswordUserBuilder	loginDataResetPassword(String loginDataId, String newPassword)	Resets user login password
static UserService.NotifyBanUserBuilder	notifyBan(String userId)	Notifies that a user is banned from an account.
static UserService.ResetPasswordUserBuilder	resetPassword(String email)
static UserService.ResetPasswordUserBuilder	resetPassword(String email, ResetPassLinkType linkType)	Reset user's password and send the user an email to generate a new one.
static UserService.ServeCsvUserBuilder	serveCsv(String id)	Will serve a requested CSV
static UserService.SetInitialPasswordUserBuilder	setInitialPassword(String hashKey, String newPassword)	Set initial user password
static UserService.UpdateUserBuilder	update(String userId, User user)	Updates an existing user object.
static UserService.UpdateLoginDataUserBuilder	updateLoginData(String oldLoginId, String password)
static UserService.UpdateLoginDataUserBuilder	updateLoginData(String oldLoginId, String password, String newLoginId)
static UserService.UpdateLoginDataUserBuilder	updateLoginData(String oldLoginId, String password, String newLoginId, String newPassword)
static UserService.UpdateLoginDataUserBuilder	updateLoginData(String oldLoginId, String password, String newLoginId, String newPassword, String newFirstName)
static UserService.UpdateLoginDataUserBuilder	updateLoginData(String oldLoginId, String password, String newLoginId, String newPassword, String newFirstName, String newLastName)
static UserService.UpdateLoginDataUserBuilder	updateLoginData(String oldLoginId, String password, String newLoginId, String newPassword, String newFirstName, String newLastName, String otp)	Updates a user's login data: email, password, name.
static UserService.ValidateHashKeyUserBuilder	validateHashKey(String hashKey)	Validate hash key

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserService

public UserService()

Method Detail

add

public static UserService.AddUserBuilder add(User user)

Adds a new user to an existing account in the Kaltura database. Input param $id is the unique identifier in the partner's system.

Parameters:

user - The new user

addFromBulkUpload

public static UserService.AddFromBulkUploadUserBuilder addFromBulkUpload(FileHolder fileData)

addFromBulkUpload

public static UserService.AddFromBulkUploadUserBuilder addFromBulkUpload(File fileData)

addFromBulkUpload

public static UserService.AddFromBulkUploadUserBuilder addFromBulkUpload(InputStream fileData,
                                                                         String fileDataMimeType,
                                                                         String fileDataName,
                                                                         long fileDataSize)

addFromBulkUpload

public static UserService.AddFromBulkUploadUserBuilder addFromBulkUpload(FileInputStream fileData,
                                                                         String fileDataMimeType,
                                                                         String fileDataName)

addFromBulkUpload

public static UserService.AddFromBulkUploadUserBuilder addFromBulkUpload(FileHolder fileData,
                                                                         BulkUploadJobData bulkUploadData)

addFromBulkUpload

public static UserService.AddFromBulkUploadUserBuilder addFromBulkUpload(File fileData,
                                                                         BulkUploadJobData bulkUploadData)

addFromBulkUpload

public static UserService.AddFromBulkUploadUserBuilder addFromBulkUpload(InputStream fileData,
                                                                         String fileDataMimeType,
                                                                         String fileDataName,
                                                                         long fileDataSize,
                                                                         BulkUploadJobData bulkUploadData)

addFromBulkUpload

public static UserService.AddFromBulkUploadUserBuilder addFromBulkUpload(FileInputStream fileData,
                                                                         String fileDataMimeType,
                                                                         String fileDataName,
                                                                         BulkUploadJobData bulkUploadData)

addFromBulkUpload

public static UserService.AddFromBulkUploadUserBuilder addFromBulkUpload(File fileData,
                                                                         BulkUploadJobData bulkUploadData,
                                                                         BulkUploadUserData bulkUploadUserData)

addFromBulkUpload

public static UserService.AddFromBulkUploadUserBuilder addFromBulkUpload(InputStream fileData,
                                                                         String fileDataMimeType,
                                                                         String fileDataName,
                                                                         long fileDataSize,
                                                                         BulkUploadJobData bulkUploadData,
                                                                         BulkUploadUserData bulkUploadUserData)

addFromBulkUpload

public static UserService.AddFromBulkUploadUserBuilder addFromBulkUpload(FileInputStream fileData,
                                                                         String fileDataMimeType,
                                                                         String fileDataName,
                                                                         BulkUploadJobData bulkUploadData,
                                                                         BulkUploadUserData bulkUploadUserData)

addFromBulkUpload

public static UserService.AddFromBulkUploadUserBuilder addFromBulkUpload(FileHolder fileData,
                                                                         BulkUploadJobData bulkUploadData,
                                                                         BulkUploadUserData bulkUploadUserData)

checkLoginDataExists

public static UserService.CheckLoginDataExistsUserBuilder checkLoginDataExists(UserLoginDataFilter filter)

Action which checks whther user login

Parameters:

filter -

delete

public static UserService.DeleteUserBuilder delete(String userId)

Deletes a user from a partner account.

Parameters:

userId - The user's unique identifier in the partner's system

disableLogin

public static UserService.DisableLoginUserBuilder disableLogin()

disableLogin

public static UserService.DisableLoginUserBuilder disableLogin(String userId)

disableLogin

public static UserService.DisableLoginUserBuilder disableLogin(String userId,
                                                               String loginId)

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.

Parameters:

userId - The user's unique identifier in the partner's system

loginId - The user's email address that identifies the user for login

enableLogin

public static UserService.EnableLoginUserBuilder enableLogin(String userId,
                                                             String loginId)

enableLogin

public static UserService.EnableLoginUserBuilder enableLogin(String userId,
                                                             String loginId,
                                                             String password)

Enables a user to log into a partner account using an email address and a password

Parameters:

userId - The user's unique identifier in the partner's system

loginId - The user's email address that identifies the user for login

password - The user's password

exportToCsv

public static UserService.ExportToCsvUserBuilder exportToCsv()

exportToCsv

public static UserService.ExportToCsvUserBuilder exportToCsv(UserFilter filter)

exportToCsv

public static UserService.ExportToCsvUserBuilder exportToCsv(UserFilter filter,
                                                             int metadataProfileId)

exportToCsv

public static UserService.ExportToCsvUserBuilder exportToCsv(UserFilter filter,
                                                             int metadataProfileId,
                                                             List<CsvAdditionalFieldInfo> additionalFields)

exportToCsv

public static UserService.ExportToCsvUserBuilder exportToCsv(UserFilter filter,
                                                             int metadataProfileId,
                                                             List<CsvAdditionalFieldInfo> additionalFields,
                                                             List<KeyValue> mappedFields)

exportToCsv

public static UserService.ExportToCsvUserBuilder exportToCsv(UserFilter filter,
                                                             int metadataProfileId,
                                                             List<CsvAdditionalFieldInfo> additionalFields,
                                                             List<KeyValue> mappedFields,
                                                             ExportToCsvOptions options)

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

Parameters:

filter - A filter used to exclude specific types of users

metadataProfileId -

additionalFields -

mappedFields - mapping between field

options -

generateQrCode

public static UserService.GenerateQrCodeUserBuilder generateQrCode(String hashKey)

get QR image content

Parameters:

hashKey -

get

public static UserService.GetUserBuilder get()

get

public static UserService.GetUserBuilder get(String userId)

Retrieves a user object for a specified user ID.

Parameters:

userId - The user's unique identifier in the partner's system

getByLoginId

public static UserService.GetByLoginIdUserBuilder getByLoginId(String loginId)

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.

Parameters:

loginId - The user's email address that identifies the user for login

index

public static UserService.IndexUserBuilder index(String id)

index

public static UserService.IndexUserBuilder index(String id,
                                                 boolean shouldUpdate)

Index an entry by id.

Parameters:

id -

shouldUpdate -

list

public static UserService.ListUserBuilder list()

list

public static UserService.ListUserBuilder list(UserFilter filter)

list

public static UserService.ListUserBuilder list(UserFilter filter,
                                               FilterPager pager)

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.

Parameters:

filter - A filter used to exclude specific types of users

pager - A limit for the number of records to display on a page

login

public static UserService.LoginUserBuilder login(int partnerId,
                                                 String userId,
                                                 String password)

login

public static UserService.LoginUserBuilder login(int partnerId,
                                                 String userId,
                                                 String password,
                                                 int expiry)

login

public static UserService.LoginUserBuilder login(int partnerId,
                                                 String userId,
                                                 String password,
                                                 int expiry,
                                                 String privileges)

Logs a user into a partner account with a partner ID, a partner user ID (puser), and a user password.

Parameters:

partnerId - The identifier of the partner account

userId - The user's unique identifier in the partner's system

password - The user's password

expiry - The requested time (in seconds) before the generated KS expires (By default, a KS expires after 24 hours).

privileges - Special privileges

loginByKs

public static UserService.LoginByKsUserBuilder loginByKs(int requestedPartnerId)

Logs a user to the destination account provided the KS' user ID is associated with the destination account and the loginData ID matches

Parameters:

requestedPartnerId -

loginByLoginId

public static UserService.LoginByLoginIdUserBuilder loginByLoginId(String loginId,
                                                                   String password)

loginByLoginId

public static UserService.LoginByLoginIdUserBuilder loginByLoginId(String loginId,
                                                                   String password,
                                                                   int partnerId)

loginByLoginId

public static UserService.LoginByLoginIdUserBuilder loginByLoginId(String loginId,
                                                                   String password,
                                                                   int partnerId,
                                                                   int expiry)

loginByLoginId

public static UserService.LoginByLoginIdUserBuilder loginByLoginId(String loginId,
                                                                   String password,
                                                                   int partnerId,
                                                                   int expiry,
                                                                   String privileges)

loginByLoginId

public static UserService.LoginByLoginIdUserBuilder loginByLoginId(String loginId,
                                                                   String password,
                                                                   int partnerId,
                                                                   int expiry,
                                                                   String privileges,
                                                                   String otp)

Logs a user into a partner account with a user login ID and a user password.

Parameters:

loginId - The user's email address that identifies the user for login

password - The user's password

partnerId - The identifier of the partner account

expiry - The requested time (in seconds) before the generated KS expires (By default, a KS expires after 24 hours).

privileges - Special privileges

otp - the user's one-time password

loginDataResetPassword

public static UserService.LoginDataResetPasswordUserBuilder loginDataResetPassword(String loginDataId,
                                                                                   String newPassword)

Resets user login password

Parameters:

loginDataId - The user's current email address that identified the user for login

newPassword - The user's new password

notifyBan

public static UserService.NotifyBanUserBuilder notifyBan(String userId)

Notifies that a user is banned from an account.

Parameters:

userId - The user's unique identifier in the partner's system

resetPassword

public static UserService.ResetPasswordUserBuilder resetPassword(String email)

resetPassword

public static UserService.ResetPasswordUserBuilder resetPassword(String email,
                                                                 ResetPassLinkType linkType)

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

Parameters:

email - The user's email address (login email)

linkType - kmc or kms

serveCsv

public static UserService.ServeCsvUserBuilder serveCsv(String id)

Will serve a requested CSV

Parameters:

id - - the requested file id

setInitialPassword

public static UserService.SetInitialPasswordUserBuilder setInitialPassword(String hashKey,
                                                                           String newPassword)

Set initial user password

Parameters:

hashKey - The hash key used to identify the user (retrieved by email)

newPassword - The new password to set for the user

update

public static UserService.UpdateUserBuilder update(String userId,
                                                   User user)

Updates an existing user object. You can also use this action to update the userId.

Parameters:

userId - The user's unique identifier in the partner's system

user - Id The user's unique identifier in the partner's system

updateLoginData

public static UserService.UpdateLoginDataUserBuilder updateLoginData(String oldLoginId,
                                                                     String password)

updateLoginData

public static UserService.UpdateLoginDataUserBuilder updateLoginData(String oldLoginId,
                                                                     String password,
                                                                     String newLoginId)

updateLoginData

public static UserService.UpdateLoginDataUserBuilder updateLoginData(String oldLoginId,
                                                                     String password,
                                                                     String newLoginId,
                                                                     String newPassword)

updateLoginData

public static UserService.UpdateLoginDataUserBuilder updateLoginData(String oldLoginId,
                                                                     String password,
                                                                     String newLoginId,
                                                                     String newPassword,
                                                                     String newFirstName)

updateLoginData

public static UserService.UpdateLoginDataUserBuilder updateLoginData(String oldLoginId,
                                                                     String password,
                                                                     String newLoginId,
                                                                     String newPassword,
                                                                     String newFirstName,
                                                                     String newLastName)

updateLoginData

public static UserService.UpdateLoginDataUserBuilder updateLoginData(String oldLoginId,
                                                                     String password,
                                                                     String newLoginId,
                                                                     String newPassword,
                                                                     String newFirstName,
                                                                     String newLastName,
                                                                     String otp)

Updates a user's login data: email, password, name.

Parameters:

oldLoginId - The user's current email address that identified the user for login

password - The user's current email address that identified the user for login

newLoginId - Optional, The user's email address that will identify the user for login

newPassword - Optional, The user's new password

newFirstName - Optional, The user's new first name

newLastName - Optional, The user's new last name

otp - the user's one-time password

validateHashKey

public static UserService.ValidateHashKeyUserBuilder validateHashKey(String hashKey)

Validate hash key

Parameters:

hashKey - The hash key used to identify the user (retrieved by email)