Home

Publisher Guide Users Roles and Permissions User Manual

1. Service Actions conversionprofile delete flavorparams delete Publisher s Guide Users Roles and Permissions User Manual Page 74 Me e AN Kaltura open source video 12 2 28 TRANSGODING UPDATE Partner ID 0 Permission Items API Actions Service Actions conversionprofile update addflavorparams removeflavorparams flavorparams update 12 2 29 TRANSCODING ADD Partner ID 0 Permission Items API Actions Service Actions conversionprofile add flavorparams add 12 2 30 TRANSCODING BASE Partner ID 0 Publisher s Guide Users Roles and Permissions User Manual Page 75 Me E Sam Kaltura open source video Permission Items API Actions Service Actions conversionprofile get list flavorparams get list getbyconversionprofileid getdefault thumbparams list 12 2 31 ACCESS CONTROL DELETE Partner ID 0 Permission Items API Actions Service Actions accesscontrol delete 12 2 32 ACCESS CONTROL UPDATE Partner ID 0 Permission Items API Actions Service Actions accesscontrol update Publisher s Guide Users Roles and Permissions User Manual Page 76 Me e AN Kaltura open source video 12 2 33 ACCESS CONTROL ADD Partner ID 0 Permission Items API Actions Service Actions
2. Publisher s Guide Users Roles and Permissions User Manual Me e VAN Kaltura open source video Name Description USER NOT FOUND The user cannot be located 4 1 5 deleteAction Deletes a user from a partner account public function deleteAction SuserId Parameters Name Input Output Type Description userId Input String The user s unique identifier in the partner s system Return Value Errors Name Description INVALID_USER_ID The user ID is not valid 4 1 6 listAction Lists user objects that are associated with an account public function listAction KalturaUserFilter Sfilter null KalturaFilterPager pager null Remarks 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 Publisher s Guide Users Roles and Permissions User Manual Page 23 Me e AN Kaltura open source video Parameters Name Input Output Type Description filter Input KalturaUserFilter A filter used to exclude specific optional types of users pager Input KalturaFilterPager A limit for the number of optional records to display on a page Return Value Type Description KalturaUserListResponse The list of user objects 4 1 7 notifyBan Notifies that a user is banned from an account
3. Publisher s Guide Users Roles and Permissions User Manual Page 66 Me AN Kaltura open source video Service Actions flavorparams list flavorasset getbyentryid getwebplayablebyentryid getflavorassetswithparams thumbasset getbyentryid accesscontrol list category list userrole get permission list 12 2 5 KMC ACCESS Partner ID 0 12 2 6 AUDIT TRAIL ADD Partner ID 0 Permission Items API Actions 12 2 7 AUDIT TRAIL BASE Partner ID 0 Publisher s Guide Users Roles and Permissions User Manual Page 67 Me AN Kaltura open source video Permission Items API Actions Service Actions audit_audittrail list get 12 2 8 ANALYTICS SEND DATA Partner ID 0 Permission Items API Actions Service Actions stats collect kmccollect reportkceerror 12 2 9 SEARCH SERVICE Partner ID 0 Permission Items API Actions Service Actions search search getmediainfo searchurl externallogin Publisher s Guide Users Roles and Permissions User Manual Page 68 Me AN Kaltura open source video 12 2 10 WIDGET ADMIN Partner ID 0 Permission Items API Actions Service Actions widget add clone get update list 12 2 11 ANALYTICS SEND DATA Partner ID 0 12 2 12 WIDGET ADMIN P
4. user update updatelogindata enablelogin disablelogin 12 2 22 ADMIN BASE Partner ID 0 Permission Items API Actions Service Actions user get list notifyban getbyloginid partner getinfo userrole get Publisher s Guide Users Roles and Permissions User Manual Page 72 Me E Sam Kaltura open source video Service Actions list permission get list permissionitem get list uiconf getavailabletypes 12 2 23 CUSTOM DATA PROFILE DELETE Partner ID 0 Permission Items API Actions Service metadata_metadataprofile Actions delete 12 2 24 CUSTOM DATA PROFILE UPDATE Partner ID 0 Permission Items API Actions Service Actions metadata_metadataprofile update updatedefinitionfromfile updateviewsfromfile revert Publisher s Guide Users Roles and Permissions User Manual Page 73 Me e AN Kaltura open source video 12 2 25 CUSTOM DATA PROFILE ADD Partner ID 0 Permission Items API Actions Service Actions metadata_metadataprofile add addfromfile 12 2 26 CUSTOM DATA PROFILE BASE Partner ID 0 Permission Items API Actions Service Actions metadata_metadataprofile list get listfields 12 2 27 TRANSCODING DELETE Partner ID 0 Permission Items API Actions
5. To create a new role from an existing role 1 Log on to the Kaltura system 2 AKS is generated to identify and authenticate the user 3 Send the following API request to the server UserRoleService cloneAction e Specify the user role to copy 4 The server processes the API request and returns the duplicate user role object 6 2 SAMPLE CODE Include the KalturaClient class require_once KalturaClient php Initiate a new KalturaClient object with the partner details partnerid lt PARTNER_ID_HERE gt replace with your partner ID Sconfig new KalturaConfiguration Spartnerid Sconfig gt serviceUrl http www kaltura com set serviceUrl if different Sclient new KalturaClient config Set user login variables and call user gt loginByLoginId action SloginId lt USER_LOGIN_EMAIL_HERE gt replace with user s login email Spassword lt USER_LOGIN_PASSWORD_HERE gt replace with user s login password Ska Sclient gt user gt loginByLoginId loginId password SpartnerId Set the client to use the KS that is returned Sclient gt setKs Sks set the original user role rm SoriginalRoleId lt ORIGINAL_USER_ROLE_ID gt must match an existing user role ID Publisher s Guide Users Roles and Permissions User Manual Page 49 vV S0 AN Kaltura open source video Call the userRole gt clone action SduplicatedRole cl
6. 12 2 97 BASE USER SESSION PERMISSION Partner ID 0 Publisher s Guide Users Roles and Permissions User Manual Page 114 Me AN Kaltura open source video Permission Items API Actions Service Actions metadata_metadataprofile list get listfields metadata_metadata document_documents list add addfromfile addfromurl delete get update updatefromfile addfromuploadedfile convert addfromentry addfromflavorasset get update delete list upload convertppttoswf serve servebyflavorparamsid Publisher s Guide Users Roles and Permissions User Manual Page 115 Me E Sam Kaltura open source video Service Actions annotation_annotation update delete list add get shortlink_shortlink get list goto session start startwidgetsession end impersonate uiconf get list user login loginbyloginid updatelogindata resetpassword setinitialpassword widget add clone get partner register getsecrets Publisher s Guide Users Roles and Permissions User Manual Page 116 Me AN Kaltura open source video Service Actions adminuser updatepassword resetpassword login setinitialpassword
7. conversionprofile list flavorparams list flavorasset get getbyentryid getwebplayablebyentryid getflavorassetswithparams list category get Publisher s Guide Users Roles and Permissions User Manual Page 101 Me E Sam Kaltura open source video Service Actions list document get list serve servebyflavorparamsid Permission Items API Parameters Object Properties 12 2 90 CONTENT MANAGE METADATA Partner ID 0 Permission Items API Actions Service Actions document_documents update media update data update baseentry update document update Publisher s Guide Users Roles and Permissions User Manual Page 102 Me AN Kaltura open source video Permission Items API Parameters Object Properties KalturaBaseEntry name tags description 12 2 91 CONTENT INGEST FEED Partner ID 0 12 2 92 CONTENT MANAGE MIX Partner ID 0 Permission Items API Actions Service Actions mixing add update clone appendmediaentry requestflattening getmixesbymediaid getreadymediaentries 12 2 93 CONTENT INGEST UPLOAD Partner ID 0 Publisher s Guide Users Roles and Permissions User Manual Page 103 Me AN Kaltura open source video Permission Items API Actions
8. Service Actions document_documents addfromuploadedfile addfromentry addfromflavorasset upload media data baseentry conversionprofile upload addfromurl addfromsearchresult addfromuploadedfile addfromrecordedwebcam addfromentry addfromflavorasset upload add addfromuploadedfile upload list upload getuploadedfiletokenbyfilename uploadtoken add get upload list delete document addfromuploadedfile Publisher s Guide Users Roles and Permissions User Manual Page 104 Me E Sam Kaltura open source video Service Actions upload 12 2 94 CONTENT INGEST BULK UPLOAD Partner ID 0 Permission Items API Actions Service Actions bulkupload add get delete list conversionprofile list 12 2 95 ALWAYS ALLOWED ACTIONS Partner ID 0 Permission Items API Actions Service Actions document_documents serve servebyflavorparamsid shortlink_shortlink goto session start startwidgetsession Publisher s Guide Users Roles and Permissions User Manual Page 105 Me E Sam Kaltura open source video Service Actions end impersonate uiconf get user login loginbyloginid updatelogindata resetpassword setinitialpassword widget
9. public function notifyBan SuserlId Parameters Name Input Output Type Description userId Input String The user s unique identifier in the partner s system Errors Name Description INVALID_USER_ID The user ID is not valid 4 1 8 loginAction Logs a user into a partner account with a partner ID a partner user ID puser and a user password public function loginAction partnerId SuserId Spassword Sexpiry Publisher s Guide Users Roles and Permissions User Manual Page 24 Me e VAN Kaltura open source video 86400 Sprivileges Remarks ee The action enables a user to generate a KS The KS enables the user to execute API actions Parameters Name Input Output Type Description partnerld Input Integer The identifier of the partner account userId Input String The user s unique identifier in the partner s system password Input String The user s password expiry Input Integer The requested time in seconds before the generated KS expires By default a KS expires after 24 hours privileges Input String Special privileges Return Value Type Description String The user s KS Errors Name Description USER_NOT_FOUND The user cannot be located USER_WRONG_PASSWORD The user password is incorrect INVALID PARTNER ID The partner ID partner id is not valid LOGIN_RETRIES_EXCEEDED
10. anonymousrank stats collect kmccollect reportkceerror system ping notification getclientnotification Publisher s Guide Users Roles and Permissions User Manual Page 119 Me e VAN Kaltura open source video Service Actions flavorasset getbyentryid getwebplayablebyentryid thumbasset get getbyentryid servebyentryid serve generate addfromurl addfromimage category get list upload upload getuploadedfiletokenbyfilename uploadtoken add get upload list delete permission getcurrentpermissions document addfromuploadedfile get update delete list Publisher s Guide Users Roles and Permissions User Manual Page 120 Me AN Kaltura open source video Service Actions upload convertppttoswf serve servebyflavorparamsid thumbasset list Permission Items API Parameters Object Properties KalturaBaseEntry categories categoriesids name tags description 12 2 98 SYSTEM ADMIN SYSTEM MONITOR Partner ID 2 12 2 99 SYSTEM ADMIN DEVELOPERS TAB Partner ID 2 12 2 100 SYSTEM ADMIN BATCH CONTROL Partner ID 2 Publisher s Guide Users Roles and Permissions User Manual Page 121 Me AN Kaltura open source
11. get partner register getsecrets adminuser updatepassword resetpassword login setinitialpassword search search getmediainfo searchurl externallogin playlist execute media flag baseentry flag stats collect kmccollect Publisher s Guide Users Roles and Permissions User Manual Page 106 Me AN Kaltura open source video Service Actions reportkceerror system ping thumbasset servebyentryid serve permission getcurrentpermissions document serve servebyflavorparamsid 12 2 96 BATCH BASE Partner ID 1 Permission Items API Actions Service metadata metadata media baseentry jobs Actions update addfromuploadedfile upload addfrombulk addfromuploadedfile abortmail abortbulkupload abortconvertcollection abortprovisionprovide abortprovisiondelete abortconvert Publisher s Guide Users Roles and Permissions User Manual Page 107 MIL i N Kaltura open source video Service Actions abortpostconvert abortextractmedia abortstorageexport abortstoragedelete abortimport abortpull abortnotification abortconvertprofile abortremoteconvert deletemail deletebulkupload deleteconvertcollection deleteprovisionprovide deleteprovisiondelet
12. getdefault thumbasset get getbyentryid servebyentryid serve setasdefault generatebyentryid generate regenerate addfromurl addfromimage delete deletebyentryid list document update Publisher s Guide Users Roles and Permissions User Manual Page 92 Me e AN Kaltura open source video 12 2 71 CONTENT MANAGE SCHEDULE Partner ID 0 Permission Items API Actions Service Actions document_documents update media update data update baseentry update document update Permission Items API Parameters Object Properties KalturaBaseEntry startDate endDate 12 2 72 CONTENT MANAGE ACCESS CONTROL Partner ID 0 Permission Items API Actions Service Actions document_documents update media update data update baseentry update Publisher s Guide Users Roles and Permissions User Manual Page 93 Me AN Kaltura open source video Service Actions document update Permission Items API Parameters Object Properties KalturaBaseEntry accessControlld 12 2 73 CONTENT MANAGE CUSTOM DATA Partner ID 0 Permission Items API Actions Service Actions metadata_metadata list add addfromfile addfromurl delete update updatefromfile 12 2 74 C
13. search search getmediainfo searchurl externallogin playlist get list execute media addfromurl addfromsearchresult addfromuploadedfile addfromrecordedwebcam get convert addfromentry addfromflavorasset update upload delete list count Publisher s Guide Users Roles and Permissions User Manual Page 117 s AN Kaltura open source video Service Actions updatethumbnail updatethumbnailjpeg updatethumbnailfromurl updatethumbnailfromsourceentry requestconversion flag anonymousrank livestream get list updateofflinethumbnailjpeg updateofflinethumbnailfromurl mixing add get update delete list count clone appendmediaentry requestflattening getmixesbymediaid getreadymediaentries anonymousrank data add Publisher s Guide Users Roles and Permissions User Manual Page 118 Me AN Kaltura open source video Service Actions get update delete list serve baseentry addfromuploadedfile list count get getcontextdata update upload getbyids delete updatethumbnailjpeg updatethumbnailfromurl updatethumbnailfromsourceentry flag
14. 2 63 12 2 64 12 2 65 12 2 66 12 2 67 12 2 68 12 2 69 STUDIO UPDATE UIGONE n Seed ee eg se de Me eiin nuie 80 STUDIO ADD UICONF A 80 STUDIO do OE ER IR OE EE 81 SYNDICATION DELETE sessies veeg Pase eg Se eg Dee se iittala 81 SYNDICATION UPDATE ie lec ten ela ee 81 SYNDIGATION ADD Ee Ee Tere ete oe leas Eg ee GE nlite ais 82 SYNDICATION BASE issie esse ee sege se De GE de Ge BA Beek Ee set dade ee ee bek Beek Edge tetas 82 PLAYLIST EMBED GODE ii ss ie eet see ites EVER ME sege Ds EE Gee Se gee Dee See Gee ees Leed ee 82 NOAH GREEN 82 PLAYLIST UPDATE toes GE Se SA ee MR nina intent daisies 83 PLAYLIST ADD ies ase cats Er ee eats See oes Socata GER GE Ee en ees ee ee eed 83 PLAYLIST BASE dese es ee iese ee ee Ee erh Pe ee eed Sege e ee 84 CONTENT MODERATE APPROVE REJEOT ees ee se ee se ee ee ee ee ee ee ee ee ee ee ge ee ee 84 CONTENT MODERATE CUSTOM DATA ee ese ee se ee ee ee ee ee ee ee ee ee ee ee ee ee ee ke dee 85 CONTENT MODERATE METADATA esse see ee se ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ke see 85 CONTENT MODERATE BADGE ese ee see see ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ke see 86 LIVE STREAM UPDATE sier esse ss idees see gese se ee Sak ee eeu ee bee We Ee see nineties 87 AAR IE AE No OE ET N 87 CONTENT MANAGE GHADE iese ee ese see see ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ke dee 88 CONTENT MANAGE ANNOTATION ee ee ee ee ee ee ee ee ee ee
15. SupdateUser gt roleIds lt NEW_ROLE_ID_HERE gt must match an existing user role ID Call the user update action SupdatedUser client user update Suserid SupdateUser Publisher s Guide Users Roles and Permissions User Manual Page 56 We aw Kaltura open source video 10 UNDERSTANDING SERVER DATA FLOwS This section describes the basic data flow of the Kaltura server for users roles and permissions 1 10 A user logs into the system using a unique email and password or the account s user admin secret A successful login request generates a KS string that is returned to the user The KS holds elements that identify the user such as partnerId userId and sessionType The user uses the KS to issue an API request The server receives the API request for a specific service and action The server decodes the KS identifies the user and checks for the role associated with the user The server checks for the permissions contained in the user s role The server checks for the permission items contained in the user s permissions The server grants access to the requested service and action only if a suitable permission item is found for the user A request to insert or update a new object property that requires special permission succeeds only if the user has the insert or update permission for the property The request fails if the user does not have the permission The respons
16. You tried logging in too many times Your account is locked and will not be available for 24 hours Publisher s Guide Users Roles and Permissions User Manual Page 25 Me E Sam Kaltura open source video Name Description LOGIN_BLOCKED Your account is locked PASSWORD_EXPIRED Your password expired USER_IS_BLOCKED The user is blocked 4 1 9 loginByLoginldAction Logs a user into a partner account with a user login ID and a user password public function loginByLoginIdAction SloginId Spassword Spartnerid null Sexpiry Remarks Sprivileges The action enables a user to generate a KS The KS enables the user to execute API actions Tem Name Input Output Type Description loginId Input String The user s email address that identifies the user for login password Input String The user s password partnerid Input Integer The identifier of the partner account Optional expiry Input Integer The requested time in seconds before the generated KS expires By default a KS expires after 24 hours privileges Input String Special privileges Return Value Type Description String The user s KS Publisher s Guide Users Roles and Permissions User Manual Page 26 MIL Ex N Kaltura open source video Errors Name Description USER_NOT_FOUND The user cannot be locat
17. ae Ee ae Dee 16 Special and Plugin Permissions iese ee ee Ge AA ee RR Ge AA Ge AA ee RR ee ee ee ee Re ee 16 Partner Group Permissions eie ee ee GR RA Ge AA Re RR ee AA Ge ee ee ee ee ee ee ek ee 16 4 APIS FOR USERS ROLES AND PERMISSIONS ee esse ee naas ee se ee ee se ee ka ae ek Raak ER Ee ee Ke ek Re Ge RR Ke ee EE Ee ee 18 4 1 USERSERVICE susse dees ee ee ees ee ee ee ee ee ee AR Ee ee AA AR Ee ee AA ER Ee Re AA AA Re ee AA AA ee ee ee ee ee 18 Publisher s Guide Users Roles and Permissions User Manual Page 2 MIL Ex N Kaltura open source video AAS Ge ie RE ER ER EE EEA E 19 4 1 2 lee ALCACTION EE EE Be RE SE ER EE ER EE oes EER EE ee Ek EE Ee NE se Res Ee GR N Ee Ge ee arenes 20 e e DEE 21 Aid QetByLOGinIGACt OM ies EE Es Fe ek ee ge ee ee Le ese ee sl ened 22 RE Ee ie RE OE N een EE N 23 G EE Lee EE 23 417 Le ER EE EE EE 24 ALS ee ee EE EE ER EE EE A 24 4 1 9 loginByLOginlGACtion EERS Ge EE DR EE ee EGO endl nem ER RE Ge FOR ieee 26 4 4 10 updateLodinDataACtOM EE 27 4 1 11 resetPasswordACHON ee ee ee ee ee ee Re ee Ge Re ee Ge ee Ge Re ee Ge Re ee Ge Re ee ee ke ee ee ke ee ee 28 4 1 12 setlnitialPasswordACHON 00 0 cece ee se ee ee ee Ge Re ee ee Re ee Ge Re ee ee ee ee Re ee Ge ke ee ee ee ee 29 4 1 13 enableloginActiGR see a Ee es ee ge Ge ae ee ee aD ee be S ee es ee 31 41 14 disableLognACIOM N AE AE OE AA EE EA 32 42 IUSERROLESERVIGE 2 es ed ed Oe cous ee ee ee ie ge ee Pi
18. contentdistribution_distributionprovider list contentdistribution_distributionprofile get list listoypartner contentdistribution_entrydistribution 12 2 79 CONTENT MANAGE Partner ID 0 Permission Items API Actions get list validate servereturneddata servesentdata DISTRIBUTION WHERE Service Actions contentdistribution_entrydistribution add update delete 12 2 80 SYSTEM ADMIN USER MANAGE Partner ID 2 Publisher s Guide Users Roles and Permissions User Manual Page 97 Me e AN Kaltura open source video 12 2 81 SYSTEM ADMIN PUBLISHER USAGE Partner ID 2 Permission Items API Actions Service Actions systempartner_systempartner getusage 12 2 82 SYSTEM ADMIN PUBLISHER ADD Partner ID 2 12 2 83 SYSTEM ADMIN PUBLISHER REMOVE Partner ID 2 Permission Items API Actions Service Actions systempartner_systempartner updatestatus 12 2 84 SYSTEM ADMIN PUBLISHER BLOCK Partner ID 2 Permission Items API Actions Service Actions systempartner_systempartner updatestatus Publisher s Guide Users Roles and Permissions User Manual Page 98 Me e VAN Kaltura open source video 12 2 85 SYSTEM ADMIN PUBLISHER GONFIG Partner ID 2 Permission Items API Actions Service Actions systempartner_systemp
19. ee Ge ee RA ee ee ke eg ee 88 CONTENT MANAGE DOWNLOAD 88 CONTENT MANAGE VIRUS GCAN ee ee ee ee ee ee ee ee ee ee ee ee ee ee de ee ke ee ke ee ee 89 CONTENT MANAGE DISTRIBUTION PROFILE MODIFV ssassn 89 CONTENT MANAGE DISTRIBUTION REMONE esse esse ee ee ee ee ee ee ee ee ee ee ee dee 89 CONTENT MANAGE DISTRIBUTION GEND eie ese esse ee se ee ee ee ee ee ee ee ee ee ee ge dee 90 CGONTENT MANAGE AGGIOGN CATEGORIES ee ese ee ee ee ee ee ese ee ee ee ee ee ee see 90 Publisher s Guide Users Roles and Permissions User Manual Page 7 MIL Ex N Kaltura open source video 12 2 70 12 2 71 12 2 72 12 2 73 12 2 74 12 2 75 12 2 76 12 2 77 12 2 78 12 2 79 12 2 80 12 2 81 12 2 82 12 2 83 12 2 84 12 2 85 12 2 86 12 2 87 12 2 88 12 2 89 12 2 90 12 2 91 12 2 92 12 2 93 12 2 94 12 2 95 CONTENT_MANAGE_THUMBNAIL ee ee ee ee ee se ee se ee ee ee ee ee ee ee ee ee ee ee ee ke eek dee 91 CONTENT MANAGE GCHEDULE eee see see ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ke dee 93 CONTENT MANAGE ACCESS CONTROL ee se ee ee ee ee ee ee ee ee ee ee ke eek ee 93 CONTENT MANAGE CUSTOM DATA ee see ee ee ee se ee ee ee ee ee ee ee ee ee ee ee ee ke eek dee 94 CONTENT MANAGE DELETE iese esse ee ee ee see see ee ee a ee ee ee ee ke dee 94 CONTENT MANAGE HECONWVERT ees ese ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ke dee 95 CONTENT MANAGE EDIT C
20. ee ee ee ee ee ee ede ee ee ee 70 12 2 16 ADMIN ROLE DELETE ipisna ee ee ee ee ee ee ee Ge ee ee GRA GRA ERA ek ee 70 12 2 17 ADMIN ROLE ADD sesse ee ee ee ee ek cee ek eee ee ee ee ee ee Ge ee Ge ee Ge ee GRA GRA ERA ERA EA Re ee 70 Publisher s Guide Users Roles and Permissions User Manual Page 5 MIL Ex N Kaltura open source video 12 2 18 12 2 19 12 2 20 12 2 21 12 2 22 12 2 23 12 2 24 12 2 25 12 2 26 12 2 27 12 2 28 12 2 29 12 2 30 12 2 31 12 2 32 12 2 33 12 2 34 12 2 35 12 2 36 12 2 37 12 2 38 12 2 39 12 2 40 12 2 41 12 2 42 12 2 43 ADMIN ROLE UPDATE iii see ee se ee be Ve ge SEER a eanna ai 71 ADMIN USER DELETE sis et ie Re Ee Bed vee a Ee Oase deg 71 ADMIN USER ADD ss seide sere eg deet DEd ne ede tne De KEER ge Be Pd ke Ee bg ere 71 ADMIN USER UPDATE sesse use eg denen degie es se see sk vere ske ven dee Deed se 72 n N os N AE EE AE 72 CUSTOM DATA PROFILE DELETE esse ese see ee se ee se ee ee ee ee ee ee ee ee ee ee ee ee ee ee be dee 73 CUSTOM DATA PROFILE UPDATE ees esse see ee se ee se ee ee ee ee ee ee ee ee ee ee ee ee ee ee ke dee 73 CUSTOM DATA PROFILE ADD iese us see Kees see GES RA GE SE eg EO Gee ese eN ee sk Eeu Ese ee es 74 CUSTOM DATA PROFILE BAGE esse see see ee ee se ee ee ee ee ee ee ee ee ee ee ee an 74 TRANSCODING DELETE ici sviti ete ese ie Gee ee seek Ge ite eek see RR eek ske Ee ee tei 74 TRANSCODING UPDATE
21. ees ME see se i bed wes ee se be ede eege be ed ee be GE GE AE Ge ee 51 LISTING AN ACCOUNT S PERMISSION ITEMS ees ee sees sae sae ka Ge ka Ge ee Ee Ee Ee AR Ee AR Ee ee Re ee Re ee 53 8 USE CASE urana a ege 53 8 2 SAMPLE CODE sass EE ER AE T e e A eee eee 53 APPLYING A ROLE TO A USER cisssscccctencciset aiden nannaa es Rees oe ke Dee edain h bee Gee BERK ER eek nd ee AE RR we bee es Deeg de 55 Ch se RE 55 9 2 SAMPLE GODE EE EE GE TE ee neste EE EE 55 UNDERSTANDING SERVER DATA FLOWS use ese ee se ee sees see gees kas ka Ge ka Ge ee ee Ee ER Se ER Ee AR Re Ak Re ek Red nnn 57 UNDERSTANDING APPLICATION DATA FLOWS esse ee sees sees sae ka Ge Ka Ge ER Ge Ee Ee ER Re AR Ee AR Ee ee Re ee Re ee ee 58 KS WW le EE OR NEE 58 Publisher s Guide Users Roles and Permissions User Manual Page 4 MIL Ex N Kaltura open source video 112 ADMIN GONSOLE EE 58 11 3 KALTURA MEDIASPAGE 4 ei Ses esis Eed bee ERG RE dee ee ge bo geseg Ve se SERE vae aa ee ai 58 12 APPENDIX A SYSTEM DEFAULTS ue iese ese esse ese ese ee se ek se ek se ee seek bee eke ee Kees ka Ge Ke Ee ERA ER Re AR Re ek Re ee Re ee Rae 59 12 1 MAPPING ROLES TO PERMISSION NAMES iese ee ee ee ee ee ee ee ee ee ee ee ee ee ee ke ee ee de ee ee ee ee ee Ge ke ee ee ee ee ee ke ee 59 12 1 1 Understanding Default Roles AA 59 12 12 Partner 0 FROGS ES ie E be eet ese io ER DE ee etsy 59 12 1 3 Template Partner 99 Roles ie ee se ee AR R
22. esse see ee eee ee ee ee ee ee Ge ee Ge ee Ge GRA RA RA RR ee ee 75 TRANSCODING ADD ee ee ee Ge Ge Ge Ge GRA RA RA RR AR ee 75 TRANSCODING BASE iseer see RR AG Ed Ee Ge ee ER sede gebere be Ee eed er ee sees 75 ACCESS CONTROL DELET Baws civic cities 76 ACCESS CONTROL UPDATE 76 ACCESS CONTROL ADD rss esse bees ee eke GEE Be SES n Geek ee ee GE aia ese ek testes 77 ACCESS CONTROL BAGE AA 77 INTEGRATION UPDATE GETTINOGB eee ee eee eee ee ee ee ee ee ee ee ee ee ee ee ee ee ee eed 77 INTEGRATION BASSE ei ese ese Se GE ees cit ent cena edn tenia 78 ACCOUNT UPDATE GETTINGB ede ee ee ee ee se ee se ee ee ee ee ee ee ee ee ee ee ee ke ee ke eek ee 78 ACCOUNT BASE rie ed gies se eb se Ge ge Ed aroa eg Ge EE Se Pd ve GE Ge ede 78 ADVERTISING UPDATE SETTINGS ede ese ee se ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ge dee 79 ADVERTISING BASE ii ee ee see Gee iii ead nati Een ee EER bee ee ie 79 STUDIO SELECT CONTENT ees ees cee see ee ee ee ee Ge ee ee Ge ee Ge ee RA RR eek ee 79 STUDIO BRAND UICONF AA 79 STUDIO DELETE UIGONE ee ees ee ee ee ee see ee ee ee ee ee ee ge ee ee ee ee ee Ge ee ee eek ek eek ee 80 Publisher s Guide Users Roles and Permissions User Manual Page 6 MIL Ex N Kaltura open source video 12 2 44 12 2 45 12 2 46 12 2 47 12 2 48 12 2 49 12 2 50 12 2 51 12 2 52 12 2 53 12 2 54 12 2 55 12 2 56 12 2 57 12 2 58 12 2 59 12 2 60 12 2 61 12 2 62 12
23. permission objects that are associated with an account public function listAction KalturaPermissionFilter filter null KalturaFilterPager Spager null Remarks Blocked permissions are listed unless you use a filter to exclude them Deleted permissions are not listed unless you use a filter to include them Parameters Name Input Output Type Description filter Input KalturaPermissionFilter A filter used to exclude Optional specific types of permissions pager Input KalturaFilterPager A limit for the number of Optional records to display on a page Return Value Type Description KalturaPermissionListResponse The list of permission objects 4 3 6 getCurrentPermissions Retrieves a list of permissions that apply to the current KS public function getCurrentPermissions Remarks The data is extracted from the KS as follows e The data is taken from the user s role when there is a userId e The data is taken according to the sessionType in the following cases o There is no userID Publisher s Guide Users Roles and Permissions User Manual Page 41 Me AN Kaltura open source video o The user is not associated with a role Return Value Type Description String A comma separated list of current permission names 4 4 PERMISSIONITEMSERVICE A service API class that creates and manages permission items Extends KalturaBaseServic
24. video Permission Items API Actions Service Actions jobs addmailjob listbatchjobs abortjob retryjob deletejob addconvertprofilejob batchcontrol setscheduleconfig setworkerconfig stopschedule stopworker startworker kill getcommand setcommandresult getfullstatus listschedulers listworkers listcommands 12 2 101 SYSTEM ADMIN BATCH CONTROL INPROGRESS Partner ID 2 Publisher s Guide Users Roles and Permissions User Manual Page 122 Me e AN Kaltura open source video 12 2 102 SYSTEM ADMIN BATCH CONTROL FAILED Partner ID 2 12 2 103 SYSTEM ADMIN BATCH CONTROL SETUP Partner ID 2 12 2 104 SYSTEM ADMIN STORAGE Partner ID 2 Permission Items API Actions Service Actions flavorparams list storageprofile_storageprofile listbypartner updatestatus get update add 12 2 105 SYSTEM ADMIN VIRUS SCAN Partner ID 2 Permission Items API Actions Service Actions virusscan_virusscanprofile add Publisher s Guide Users Roles and Permissions User Manual Page 123 Me e VAN Kaltura open source video Service Actions delete get list update scan 12 2 106 SYSTEM ADMIN EMAIL INGESTION Partner ID 2 Permission Items API Actions Service Actions emailingestionprofile add get update de
25. 2 PLAYLIST DELETE Partner ID 0 Publisher s Guide Users Roles and Permissions User Manual Page 82 Me e VAN Kaltura open source video Permission Items API Actions Service Actions playlist delete 12 2 53 PLAYLIST UPDATE Partner ID 0 Permission Items API Actions Service Actions playlist update media list mixing list data list baseentry list 12 2 54 PLAYLIST ADD Partner ID 0 Permission Items API Actions Service Actions playlist add media list mixing list data list Publisher s Guide Users Roles and Permissions User Manual Page 83 Me AN Kaltura open source video Service Actions baseentry list 12 2 55 PLAYLIST BASE Partner ID 0 Permission Items API Actions Service Actions playlist get list execute executefromcontent executefromfilters getstatsfromcontent media list mixing list data list baseentry list 12 2 56 CONTENT MODERATE APPROVE REJECT Partner ID 0 Publisher s Guide Users Roles and Permissions User Manual Page 84 Me AN Kaltura open source video Permission Items API Actions Service Actions media reject approve baseentry reject approve 12 2 57 CONTENT MODERATE CUSTOM DATA Partner ID 0 Permission Items API Actions Service
26. 3 SYSTEM ADMIN EMAIL INGESGSTION eee eee eee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee 124 SYSTEM ADMIN CONTENT DISTRIBUTION BAGE ese esse ee se ee ee ee ee ee ee 124 SYSTEM ADMIN CONTENT DISTRIBUTION MODIEN ese esse ee ee ee ee ee ee 125 SYSTEM ADMIN PERMISSIONS MANAGE iese ese ee ee se ee se ee ee ee ee ee ee ee ee ee ee 126 SYSTEM scINTERNAL cs ies ese ee ur seed ee ese de Gee wees bee seeds Oe esse bee ee ie 127 SYSTEM ADMIN ENTRY INVESGSTIGATION esse sees ee se ee se ee ee ee ee ee ee ee ee ee ee 127 SYSTEM FILESYNG issues esse esse Kees GR Eie bed ee se bes ee ese Se wee bee fe 128 ADMIN_PERMISSION_ADD AA 128 ADMIN PERMISSION UPDATE dese ee se ee ee ee ee ee ee ee ee ee ee ee ee ee eke ee ee ee ee se ee 129 ADMIN PERMISSION DEL ETE ees esse ee se ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee 129 SHORT LINK BASE us sesse sesse ese dee se vae ad byge esse edge Ge eg Ge DRS ed Ge EEU Vie 129 SHORT LINK MODIEY sessies ses egg ed ees tease ke beg De ee de OS eu ee Ee Ee 130 Publisher s Guide Users Roles and Permissions User Manual Page 9 Ze LJ AN Kaltura open source video 1 ABOUT THIS DOCUMENT 1 1 SCOPE This document describes e The roles and permissions infrastructure e How to use Kaltura server APIs to define and modify roles and permissions in Kaltura applications This document does not address e The Users and Roles pages in Kaltura applications such as the Kaltura Management Conso
27. ALID_USER_ID The user ID is not valid CANNOT_DELETE_OR_BLOCK_ROOT_ADMIN_USER An account owner user cannot be deleted USER_ROLE_NOT_FOUND The user role cannot be located ACCOUNT_OWNER_NEEDS_PARTNER_ADMIN_ROLE The account owner must have a partner administrator role 4 1 3 getAction Retrieves a user object for a specified user ID public function getAction userId Parameters Name Input Output Type Description userId Input String The user s unique identifier in the partner s system Publisher s Guide Users Roles and Permissions User Manual Page 21 Me E Sam Kaltura open source video Return Value Type Description KalturaUser The specified user object Errors Name Description INVALID_USER_ID The user ID is not valid 4 1 4 getByLoginldAction Retrieves a user object for a user s login ID and partner ID public function getByLoginIdAction S loginId Remarks A login ID is the email address used by a user to log into the system Parameters Name Input Output Type Description loginId Input String The user s email address that identifies the user for login Return Value Type Description KalturaUser The user object represented by the login and partner IDs Errors Name Description LOGIN_DATA_NOT_FOUND The login ID cannot be located
28. ATEGORIES eed se ee se ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee 96 CONTENT MANAGE EMBED COD iese see ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ge dee 96 CONTENT MANAGE DISTRIBUTION BADGE ees ese ee se ee ee ee ee ee ee ee ee ee ee ge dee 96 CONTENT MANAGE DISTRIBUTION WHERE esse ee se ee ee ee ee ee ee ee ee ee ee ee see 97 SYSTEM ADMIN USER MANAGE ee ees ese ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ke dee 97 SYSTEM ADMIN PUBLISHER UGAGE iese ee ese ee se ee ee ee ee ee ee ee ee ee ee ee ee ee ee ke see 98 SYSTEM ADMIN PUBLISHER ADD esse see ee se ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ge see 98 SYSTEM ADMIN PUBLISHER HEMOVE ese ese ee se ee ee ee ee ee ee ee ee ee ee ee ee ee ee ke ee ee 98 SYSTEM ADMIN PUBLISHER BLOCK ees ese ee se ee se ee ee ee ee ee ee ee ee ee ee ee ee ee ee ke ee ee 98 SYSTEM ADMIN PUBLISHER GONFIG 1 00 ese ee ee se ee se ee ee ee ee ee ee ee ee ee ee ee ee ee see 99 SYSTEM ADMIN PUBLISHER KMC ACCESS ecien 99 SYSTEM ADMIN PUBLISHER DAGE ese ee ee se ee se ee ee ee ee ee ee ee ee ee ee ee ee ee ee ke dee 99 SYSTEM ADMIN BASE seereis ed ee ev ese Ve na i ek Gee ee da 100 CONTENT MANAGE DBAGE iese ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee Ge ee ee ee ee ee ee ee ee 100 CONTENT MANAGE METADATA ees ee ee ee ee ee see ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee 102 CONTENT INGEST FEED iese ses egg dees eg ge we ee ke beg De ee de Ge ese ee ee bee die 103
29. Actions metadata_metadata add addfromfile addfromurl delete update updatefromfile 12 2 58 CONTENT MODERATE METADATA Partner ID 0 Permission Items API Actions Service Actions document_documents update Publisher s Guide Users Roles and Permissions User Manual Page 85 Me e VAN Kaltura open source video Service Actions media update anonymousrank mixing anonymousrank data update baseentry update anonymousrank document update Permission Items API Parameters Object Properties KalturaBaseEntry name tags description 12 2 59 CONTENT MODERATE BASE Partner ID 0 Permission Items API Actions Service Actions metadata_metadataprofile list contentdistribution_distributionprofile list playlist list media list flag Publisher s Guide Users Roles and Permissions User Manual Page 86 Me E Sam Kaltura open source video Service Actions listflags livestream list mixing list data list baseentry list count flag listflags conversionprofile list flavorparams list category list 12 2 60 LIVE STREAM UPDATE Partner ID 0 Permission Items API Actions livestream baseentry 12 2 61 LIVE STREAM ADD Partner ID 0 Actions update update Publisher s Guid
30. BaseService Actions Name Description addAction Adds a new user role object to the account getAction Retrieves a user role object using its ID updateAction Updates an existing user role object deleteAction Deletes an existing user role object listAction Lists user role objects that are associated with an account cloneAction Creates a new user role object that is a duplicate of an existing role 4 2 1 addAction Adds a new user role object to the account public function addAction KalturaUserRole SuserRole Publisher s Guide Users Roles and Permissions User Manual Page 33 Me E Sam Kaltura open source video Parameters Name Input Output Type Description userRole Input KalturaUserRole Anew role Return Value Type Description KalturaUserRole The added user role object Errors Name Description PROPERTY_VALIDATION_CANNOT_BE_NULL The property name cannot be NULL PROPERTY VALIDATION NOT UPDATABLE The property name cannot be updated PERMISSION NOT FOUND A permission associated with the role cannot be located 4 2 2 getAction Retrieves a user role object using its ID public function getAction SuserRolerd Parameters Name Input Output Type Description userRoleld Input Integer The user role s unique identifier Return Value Type Description KalturaUserR
31. CONTENT MANAGE MIN 103 CONTENT INGEST UPLOAD ee esse ee ee ee ain ea ee ee ee ee ee ee ee 103 CONTENT INGEST BULK UPLOAD oe ee ete ee ee ee ee Ge ee ee ee Ge ee ee ee ee 105 ALWAYS ALLOWED ACTION eed ee se ee ee ee ee ee ee ee ee ee AR ee ee ee ee ee 105 Publisher s Guide Users Roles and Permissions User Manual Page 8 open source video 12 2 96 12 2 97 12 2 98 12 2 99 12 2 100 12 2 101 12 2 102 12 2 103 12 2 104 12 2 105 12 2 106 12 2 107 12 2 108 12 2 109 12 2 110 12 2 111 12 2 112 12 2 113 12 2 114 12 2 115 12 2 116 12 2 117 BATCH BASE sees ee Sk ese bee eine eee deste ed ME a LEER ee ecient 107 BASE USER SESSION PERDMIGGION ee ese ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee dee 114 SYSTEM ADMIN SYSTEM MONTTOR esse cee see ese ee ee se ee se ee ee ee ee ee ee ee ee 121 SYSTEM ADMIN DEVELOPERS TAB esse see se ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee 121 SYSTEM ADMIN BATCH CONTROL ee ee see see ee ee ee ee ee ee ee ee ee ee ee ee ee ee 121 SYSTEM ADMIN BATCH CONTROL INPROGRESS esse esse esse ee ee ee ee ee ee 122 SYSTEM ADMIN BATCH CONTROL FAILED eie ee es se ee se ee ee ee ee ee ee ee ee ee ee 123 SYSTEM ADMIN BATCH CONTROL GETUR ese ese ee se ee ee ee ee ee ee ee ee ee ee 123 SYSTEM ADMIN STORAGE ees esse ee ee ee ee ee cee eee ee ee eaaa ee 123 SYSTEM ADMIN VIRUS GCAN ees ee ee ese cere eke eter ee ee ee Ge ee ee ee ee ee ee ee ee 12
32. GE_DELETE CONTENT_MANAGE_RECONVERT CONTENT_MANAGE_EDIT_CATEGORIES CONTENT_MANAGE_ANNOTATION CONTENT_MANAGE_SHARE CONTENT_MANAGE_DOWNLOAD LIVE_STREAM_ADD LIVE_STREAM_UPDATE CONTENT_MODERATE_BASE CONTENT_MODERATE_METADATA CONTENT_MODERATE_CUSTOM_DATA Publisher s Guide Users Roles and Permissions User Manual Page 60 NZ aw Kaltura open source video Role Permissions CONTENT_MODERATE_APPROVE_REJECT PLAYLIST_BASE PLAYLIST_ADD PLAYLIST_UPDATE PLAYLIST_DELETE SYNDICATION_BASE SYNDICATION_ADD SYNDICATION_UPDATE SYNDICATION_DELETE STUDIO_BASE STUDIO_ADD_UICONF STUDIO_UPDATE_UICONF STUDIO_DELETE_UICONF ACCOUNT_BASE INTEGRATION_BASE ACCESS_CONTROL_BASE ACCESS_CONTROL_ADD ACCESS_CONTROL_UPDATE ACCESS_CONTROL_DELETE TRANSCODING_BASE TRANSCODING_ADD TRANSCODING_UPDATE TRANSCODING_DELETE CUSTOM_DATA_PROFILE_BASE CUSTOM_DATA_PROFILE_ADD CUSTOM_DATA_PROFILE_UPDATE CUSTOM_DATA_PROFILE_DELETE CUSTOM_DATA_FIELD_ADD CUSTOM_DATA_FIELD_UPDATE Publisher s Guide Users Roles and Permissions User Manual Page 61 NZ aw Kaltura open source video Role Permissions CUSTOM_DATA_FIELD_DELETE ANALYTICS_BASE WIDGET_ADMIN SEARCH_SERVICE ANALYTICS_SEND_DATA AUDIT_TRAIL_BASE AUDIT_TRAIL_ADD ADVERTISING_BASE ADVERTISING_UPDATE_SETTINGS PLAYLIST_EMBED_CODE STUDIO BRAND UICONF STUDIO SELECT CONTENT CONTENT MANAGE EMBED CODE PLAYLIST EMBED CODE Content U
33. G_USED The role is in use The action cannot be completed 4 2 5 listAction Lists user role objects that are associated with an account public function listAction KalturaUserRoleFilter KalturaFilterPager Spager null Remarks Blocked user roles are listed unless you use a filter to exclude them Deleted user roles are not listed unless you use a filter to include them Parameters Name filter pager Input Output Input Optional Input Optional Type KalturaUserRoleFilter KalturaFilterPager Stilter null Description A filter used to exclude specific types of user roles A limit for the number of records to display on a page Publisher s Guide Users Roles and Permissions User Manual Page 36 Me AN Kaltura open source video Return Value Type Description KalturaUserRoleListResponse The list of user role objects 4 2 6 cloneAction Creates a new user role object that is a duplicate of an existing role public function cloneAction userRoleId Parameters Name Input Output Type Description userRoleId Input Integer The user role s unique identifier Return Value Type Description KalturaUserRole The duplicate user role object Errors Name Description INVALID_OBJECT_ID The object identifier is not valid 4 3 PERMISSIONSERVICE A
34. Guest SYSTEM_ADMIN_BASE 12 2 MAPPING PERMISSION NAMES TO PERMISSION ITEMS This section lists e Permission name section title e Partner identifier e Permission Items A permission item may be e An API action which includes a service and action e An API parameter which includes an object and property 12 2 1 CUSTOM DATA FIELD DELETE Partner ID 0 Permission Items API Actions Service Actions metadata_metadataprofile delete update 12 2 2 CUSTOM DATA FIELD UPDATE Partner ID 0 Permission Items API Actions Publisher s Guide Users Roles and Permissions User Manual Page 64 open source video Service Actions metadata_metadataprofile update 12 2 3 CUSTOM DATA FIELD ADD Partner ID 0 Publisher s Guide Users Roles and Permissions User Manual Page 65 Me e VAN Kaltura open source video Permission Items API Actions Service Actions metadata_metadataprofile add update 12 2 4 KMC READ ONLY Partner ID 0 Permission Items API Actions Service Actions metadata_metadataprofile list metadata_metadata list contentdistribution_distributionprofile list contentdistribution_entrydistribution list uiconf list listtemplates user get partner getinfo getusage playlist list mixing getmixesbymediaid baseentry list get getcontextdata report getgraphs
35. INVALID The value in field name is not valid The login ID cannot be located The existing password is incorrect The password you entered is not valid Passwords must e Contain between 8 and 14 characters e Not contain your name e Contain at least one lowercase letter a z e Contain at least one digit 0 9 e Contain at least one of the following symbols A RSM LAND e Not contain the following characters lt or gt PASSWORD_ALREADY_USED The password you chose has already been used LOGIN ID ALREADY USED The login ID is already in use 4 1 11 resetPasswordAction Resets a user s password and sends the user an email containing a link for setting up the new password public function resetPasswordAction email Publisher s Guide Users Roles and Permissions User Manual Page 28 MIL Ex N Kaltura open source video Remarks This action is used in the Forgot password feature Parameters Name Input Output Type Description email Input String The user s email address login email Errors Name Description LOGIN_DATA_NOT_FOUND PASSWORD_STRUCTURE_INVALID The login ID login email cannot be located The password you entered is not valid Passwords must e Contain between 8 and 14 characters e Not contain your name e Contain at least one lowercase letter a z e Contain at least one digit 0 9 e Contain at least one of the fo
36. Item The deleted permission item object Errors Name Description INVALID OBJECT ID The object identifier is not valid 4 4 5 listAction Lists permission item objects that are associated with an account public function listAction KalturaPermissionItemFilter Sfilter null KalturaFilterPager Spager null Parameters Name Input Output Type Description filter Input Optional KalturaPermissionItemFilter A filter used to exclude specific types of permission items pager Input Optional KalturaFilterPager A limit for the number of records to display on a page Publisher s Guide Users Roles and Permissions User Manual Page 45 We Kaltura open source video Return Value Type Description KalturaPremissionItemListResponse The list of permission item objects Publisher s Guide Users Roles and Permissions User Manual Page 46 V Soe AN Kaltura open source video 5 1 USE CASE To add a user to a partner account 1 Log on to the Kaltura system 2 AKS is generated to identify and authenticate the user 3 Send the following API request to the server UserService gt addAction e Specify the user parameters as a KalturaUser object 4 The server processes the API request and returns the new user object 5 2 SAMPLE CODE Include the KalturaClient class require_once KalturaClient php Initiate a new Kal
37. KS is generated to identify and authenticate the user 3 Send the following API request to the server UserService updateAction e Specify the following o The user role ID o A KalturaUser object with a parameter that specifies the new user role identifier 4 The server processes the API request and returns the user role object 9 2 SAMPLE CODE Include the KalturaClient class require_once KalturaClient php Initiate a new KalturaClient object with the partner details SpartnerId lt PARTNER_ID_HERE gt replace with your partner ID Sconfig new KalturaConfiguration Spartnerid Sconfig gt serviceUrl http www kaltura com set serviceUrl if different Sclient new KalturaClient Sconfig Set user login variables and call user gt loginByLoginId action SloginId lt USER_LOGIN_EMAIL_HERE gt replace with user s login email Spassword lt USER_LOGIN_PASSWORD_HERE gt replace with user s login password ks client gt user gt loginByLoginId loginId password S partnerId ese rneer EE EE Publisher s Guide Users Roles and Permissions User Manual Page 55 V o oO A Kaltura open source video Sclient gt setKs Sks Set the existing user s ID SuserId user_id must match an existing user ID Create a new KalturaUser object and set the roleIds parameter to the required user role ID SupdateUser new KalturaUser
38. ONTENT MANAGE DELETE Partner ID 0 Publisher s Guide Users Roles and Permissions User Manual Page 94 Me e VAN Kaltura open source video Permission Items API Actions Service Actions document_documents delete media delete livestream delete mixing delete data delete baseentry delete flavorasset delete document delete 12 2 75 CONTENT MANAGE Partner ID 0 Permission Items API Actions RECONVERT Service Actions document_documents convert convertppttoswf media convert requestconversion mixing reguestflattening flavorasset convert reconvert syndicationfeed requestconversion document convertppttoswf Publisher s Guide Users Roles and Permissions User Manual Page 95 Me e VAN Kaltura open source video 12 2 76 CONTENT Partner ID 0 Permission Items API Actions MANAGE EDIT CATEGORIES Service Actions category add get update delete 12 2 77 CONTENT MANAGE EMBED CODE Partner ID 0 Permission Items API Actions Service Actions shortlink_shortlink list add update 12 2 78 CONTENT Partner ID 0 MANAGE DISTRIBUTION BASE Publisher s Guide Users Roles and Permissions User Manual Page 96 Me e VAN Kaltura open source video Permission Items API Actions Service Actions
39. SZ Ex N Kaltura open source video Publisher s Guide Users Roles and Permissions User Manual Version 1 0 Publisher s Guide Users Roles and Permissions User Manual Page 1 MIL Ex N Kaltura open source video Table of Contents 1 ABOUT THIS DOCUMENT siese ee ese es os bee ke gee oek Dee Se EE ek cute cube een eke ee RS EN EE DE Re eek Ed ee 10 EI SCOPE DR EE EA De De ER teasers case GE Re De Oe eee 10 LS WHO SHOULD READ THIS DOCUMENT eege sur eu Eege Ee see Gee gee Eben gek eau eek see Ee De 10 1 3 ASSUMPTIONS DE GE a DEE RE ES Re sng EE ee Ee GE ERGE ee 10 L RELATED INFORMATION ARE N RE EE EE N 10 ER Ce A EE 11 3 UNDERSTANDING USERS ROLES AND PERMISSIONS ee ese ee aas en sees ER se ee ke ek Re Gee RR e ee ese ee 12 3 1 ROLES AND PERMISSIONS OVERVIEW esse ee ee ee ee ee se ee ee ee ee ee ee ee ee ee ee ee ee Re ee ee AA Ge ee AR Re ee ee AA ee ee ge ee ee 12 SA1 ies le ie EE ER RE AE ER 12 3 1 2 Server Inirastruchure esse ed ee AA ee ER GR AA Ge AA AR RA Ge AA Ee AR Re ee Ge AA ee ee ee RA ee 12 3 2 USERS ONERVIENW annnm 13 er neet BE 13 3 22 Server Infrastructures sarcen DEENEN eb ek even a ta EENS dE 14 Su EE 14 ACCOUNT OWNER RE EO EE OE EE EN 14 Elte fC 14 Partner User ID puser id RENEE ge GE GE ee ER GR denne EE 15 Kaltura User GT RR EO EE EO EE bees EE AE 15 User ee AE D 15 3 3 PERMISSION WR dE 16 Normal Ee see EE Ee Re Se ee ee S ae N ee ee eg
40. TION CANNOT BE NULL The property property namel cannot be NULL INVALID FIELD VALUE The value in field field namel is not valid UNKNOWN PARTNER ID The partner ID partner id is not recognized ADMIN LOGIN USERS OUOTA EXCEEDED PASSWORD STRUCTURE INVALID The permitted number of user logins has been reached No more logins are permitted for this partner account The password you entered is not valid Passwords must e Contain between 8 and 14 characters e Not contain your name e Contain at least one lowercase letter a z e Contain at least one digit 0 9 e Contain at least one of the following symbols o G 2 e Not contain the following characters lt or gt DUPLICATE_USER_BY_LOGIN_ID A loginable user with the email ogin_email already exists in system 4 1 2 updateAction Updates an existing user object public function updateAction SuserId KalturaUser user Remarks You also can use this action to update the userId Publisher s Guide Users Roles and Permissions User Manual Page 20 Me e VAN Kaltura open source video Parameters Name Input Output Type Description userId Input String The user s unique identifier in the partner s system user Input KalturaUser The updated user Return Value Type Description KalturaUser The updated user object Errors Name Description INV
41. User Manual Page 13 open source video Kaltura application or widget or a Kaltura plugin 3 2 2 Server Infrastructure Partner A partner is an individual or organization with a Kaltura system account A partner defines roles and permissions that apply to its users A user may be associated with multiple partner accounts Account Owner Each Kaltura account must have a user who is defined as the account owner An account owner e Cannot be deleted e Receives account administrator emails e Has full control of account permissions and roles e May assign full control of account permissions and roles to additional users e May be changed to a different user after the user is assigned full control of account permissions and roles Note An account may have only one account owner Kaltura Session KS KS Definition The Kaltura system uses a Kaltura Session KS identifier to identify and authenticate a user The KS e Is the string identifier generated by Kaltura or the client application using a shared secret for web session authentication e ls generated using elements such as o Partner ID o User ID o Session type Publisher s Guide Users Roles and Permissions User Manual Page 14 open source video The session type is one of the following e ADMIN Can access all the entries of the partner e USER Can access only entries created by the user Source for Roles and Permissions The user s role determines
42. accesscontrol add 12 2 34 ACCESS CONTROL BASE Partner ID 0 Permission Items API Actions Service Actions accesscontrol get list 12 2 35 INTEGRATION UPDATE SETTINGS Partner ID 0 Permission Items API Actions Service Actions partner update Publisher s Guide Users Roles and Permissions User Manual Page 77 Me e AN Kaltura open source video 12 2 36 INTEGRATION BASE Partner ID 0 Permission Items API Actions Service Actions partner getinfo Permission Items API Parameters Object Properties KalturaPartner secret adminSecret 12 2 37 ACCOUNT UPDATE SETTINGS Partner ID 0 Permission Items API Actions Service Actions partner update 12 2 38 ACCOUNT BASE Partner ID 0 Publisher s Guide Users Roles and Permissions User Manual Page 78 Me e VAN Kaltura open source video Permission Items API Actions Service Actions user list partner getinfo getusage userrole list 12 2 39 ADVERTISING UPDATE SETTINGS Partner ID 0 12 2 40 ADVERTISING BASE Partner ID 0 12 2 41 STUDIO SELECT CONTENT Partner ID 0 Permission Items API Actions Service Actions playlist list 12 2 42 STUDIO BRAND UIGONF Partner ID 0 Publisher s Guide Users Roles and Permissions User Manual Page 79 Me AN Ka
43. ajobs updateexclusivetransformmetadatajob freeexclusivetransformmetadatajob gettransformmetadataobjects upgrademetadataobjects metadata_metadata invalidate multicenters filesyncimportbatch updateexclusivefilesyncimportjob freeexclusivefilesyncimportjob getexclusivefilesyncimportjobs getexclusivealmostdonefilesyncimportjobs virusscan virusscanbatch updateexclusivevirusscanjob freeexclusivevirusscanjob getexclusivevirusscanjobs Publisher s Guide Users Roles and Permissions User Manual Page 113 MIL Ex N Kaltura open source video Service Actions contentdistribution_contentdistributionbatch getexclusivedistributionsubmitjobs updateexclusivedistributionsubmitjob freeexclusivedistributionsubmitjob getexclusivealmostdonedistributionsubmitjobs getexclusivedistributionupdatejobs updateexclusivedistributionupdatejob freeexclusivedistributionupdatejob getexclusivealmostdonedistributionupdatejobs getexclusivedistributiondeletejobs updateexclusivedistributiondeletejob freeexclusivedistributiondeletejob getexclusivealmostdonedistributiondeletejobs getexclusivedistributionfetchreportjobs updateexclusivedistributionfetchreportjob freeexclusivedistributionfetchreportjob getexclusivealmostdonedistributionfetchreportjobs createrequiredjobs updatesunstatus
44. artner ID 0 12 2 13 ANALYTICS BASE Partner ID 0 Permission Items API Actions Service Actions report getgraphs gettotal Publisher s Guide Users Roles and Permissions User Manual Page 69 Me AN Kaltura open source video Service Actions gettable geturlforreportascsv category list 12 2 14 ADMIN WHITE BRANDING Partner ID 0 12 2 15 ADMIN PUBLISHER MANAGE Partner ID 0 12 2 16 ADMIN ROLE DELETE Partner ID 0 Permission Items API Actions Service Actions userrole delete 12 2 17 ADMIN ROLE ADD Partner ID 0 Publisher s Guide Users Roles and Permissions User Manual Page 70 Me AN Kaltura open source video Permission Items API Actions Service Actions userrole add clone 12 2 18 ADMIN ROLE UPDATE Partner ID 0 Permission Items API Actions Service Actions userrole update 12 2 19 ADMIN USER DELETE Partner ID 0 Permission Items API Actions Service Actions user delete 12 2 20 ADMIN USER ADD Partner ID 0 Publisher s Guide Users Roles and Permissions User Manual Page 71 Me e VAN Kaltura open source video Permission Items API Actions Service Actions user add 12 2 21 ADMIN USER UPDATE Partner ID 0 Permission Items API Actions Service Actions
45. artner updatestatus updateconfiguration 12 2 86 SYSTEM ADMIN PUBLISHER KMC ACCESS Partner ID 2 Permission Items API Actions Service Actions systempartner_systempartner getadminsession 12 2 87 SYSTEM ADMIN PUBLISHER BASE Partner ID 2 Permission Items API Actions Service Actions systempartner_systempartner get list getconfiguration getpackages Publisher s Guide Users Roles and Permissions User Manual Page 99 Me AN Kaltura open source video 12 2 88 SYSTEM ADMIN BASE Partner ID 2 Permission Items API Actions Service Actions session impersonate user list getbyloginid 12 2 89 CONTENT MANAGE Partner ID 0 Permission Items API Actions BASE Service Actions metadata_metadataprofile list metadata_metadata list get document_documents get list serve servebyflavorparamsid media get list count Publisher s Guide Users Roles and Permissions User Manual Page 100 Me AN Kaltura open source video Service Actions livestream get list mixing get list count getmixesbymediaid getreadymediaentries data get list serve baseentry list count get getcontextdata getbyids notification getclientnotification
46. at least one lowercase letter a z e Contain at least one digit 0 9 e Contain at least one of the following symbols Klee LA e Not contain the following characters lt or gt LOGIN ID ALREADY USED The login ID is already in use 4 1 14 disableLoginAction Disables a user s ability to log into a partner account using an email address and a password public function disableLoginAction SuserId null S loginId null Remarks You may use either a userId or a loginId parameter for this action Parameters Name Input Output Type Description userId Input String The user s unique identifier in the Optional partner s system login d Input String The user s email address that Optional identifies the user for login Return Value Type Description KalturaUser The user object represented by the user and login IDs Publisher s Guide Users Roles and Permissions User Manual Page 32 MIL Ex N Kaltura open source video Errors Name Description USER LOGIN ALREADY DISABLED The user already is not allowed to log in PROPERTY VALIDATION CANNOT BE NULL The property property namel cannot be NULL USER NOT FOUND The user cannot be located CANNOT DISABLE LOGIN FOR ADMIN USER A login cannot be disabled for an ADMIN user 4 2 USERROLESERVICE A service API class that creates and manages user roles Extends Kaltura
47. bject property Permission defines a functional flow by grouping the granular permission items Role groups functional flows into usable users roles Permission Item A permission item e Consists of an API action or an API object property e Defines a specific API action such as o baseEntry gt list Publisher s Guide Users Roles and Permissions User Manual Page 12 open source video o category gt add o liveStream gt delete or Defines a specific API object property such as o KalturaBaseEntry startDate o KalturaBaseEntry accessControlProfileld e Can allow the following when applied to an API object property o Read o Update o Insert e Is internal to the Kaltura server Permission A permission e May have different meanings in different applications e May be used by an application to enable access to a functionality such as creating a player or uploading content e Consists of a set of permission items Role A user may be associated with a role A role is a set of permissions Note A user currently can have only one role Although the server supports multiple roles per user the API currently blocks multiple role functionality 3 2 USERS OVERVIEW 3 2 1 Introduction Roles and permissions apply to users of the Kaltura system A user is an individual who logs on to a Kaltura account The user typically accesses the Kaltura server a Publisher s Guide Users Roles and Permissions
48. e Actions Name Description addAction Adds a new permission item object to the account getAction Retrieves a permission item object using its ID updateAction Lists permission item objects that are associated with an account deleteAction Deletes an existing permission item object listAction Lists permission item objects that are associated with an account 4 4 1 addAction Adds a new permission item object to the account public function addAction KalturaPermissionItem SpermissionItem Remarks This action is available only to Kaltura system administrators Parameters Name Input Output Type Description permissionItem Input KalturaPermissionItem The new permission item Publisher s Guide Users Roles and Permissions User Manual Page 42 Me E Sam Kaltura open source video Return Value Type Description KalturaPermissionItem The added permission item object Errors Name Description PROPERTY_VALIDATION_CANNOT_BE_NULL The property name cannot be NULL PROPERTY VALIDATION NOT UPDATABLE The property name cannot be updated 4 4 2 getAction Retrieves a permission item object using its ID public function getAction S permissionItemId Parameters Name Input Output Type Description permissionItemId Input Integer The permission item s unique identifier Return Value Type Desc
49. e deleteconvert deletepostconvert deleteextractmedia deletestorageexport deletestoragedelete deleteimport deletepull deletenotification deleteconvertprofile deleteremoteconvert Publisher s Guide Users Roles and Permissions User Manual Page 108 MIL i N Kaltura open source video Service Actions retrymail retrybulkupload retryconvertcollection retryprovisionprovide retryprovisiondelete retryconvert retrypostconvert retryextractmedia retrystorageexport retrystoragedelete retryimport retrypull retrynotification retryconvertprofile retryremoteconvert getpullstatus getimportstatus getpostconvertstatus getextractmediastatus getstorageexportstatus getstoragedeletestatus getbulkuploadstatus getconvertcollectionstatus getprovisionprovidestatus Publisher s Guide Users Roles and Permissions User Manual Page 109 MIL i N Kaltura open source video Service Actions getprovisiondeletestatus getconvertstatus getnotificationstatus getconvertprofilestatus getremoteconvertstatus getmailstatus batch getqueuesize checkfileexists getexclusivepulljobs updateexclusivepulljob freeexclusivepulljob getexclusiveimportjobs updateexclusive
50. e Users Roles and Permissions User Manual Page 87 Me e VAN Kaltura open source video Permission Items API Actions Service Actions livestream add 12 2 62 CONTENT MANAGE SHARE Partner ID 0 12 2 63 CONTENT MANAGE ANNOTATION Partner ID 0 Permission Items API Actions Service Actions annotation_annotation update delete list add get 12 2 64 CONTENT MANAGE DOWNLOAD Partner ID 0 Permission Items API Actions Service Actions flavorasset getdownloadurl Publisher s Guide Users Roles and Permissions User Manual Page 88 Me e VAN Kaltura open source video Service Actions xinternal xaddbulkdownload 12 2 65 CONTENT MANAGE VIRUS SCAN Partner ID 0 12 2 66 CONTENT MANAGE DIFY Partner ID 0 Permission Items API Actions DISTRIBUTION PROFILE MO Service Actions metadata_metadataprofile list listfields contentdistribution_distributionprofile add update updatestatus delete flavorparams list 12 2 67 CONTENT MANAGE Partner ID 0 DISTRIBUTION REMOVE Publisher s Guide Users Roles and Permissions User Manual Page 89 Me E Sam Kaltura open source video Permission Items API Actions Service Actions contentdistribution_entrydistribution submitdelete 12 2 68 CONTENT MANAGE Partner ID 0 P
51. e AR ee Ak ee ee AR ee AR ee AR ee de ee ee ee 59 12 1 4 Admin Console Partner 2 Roles iii se ee AR GR AA AA ee RR Ge AA ee ee ge ee ee 63 12 2 MAPPING PERMISSION NAMES TO PERMISSION ITEMS iese esse ee ee ee ee ee ee ee ee ee ee ee ee ge ee ee ee ee ee ee ee ee ee ke ee 64 12 2 1 CUSTOM DATA FIELD D ELETE ees see esse ee se ee ee ee ee ee ee ee ee ee ee ee ende ede ee ee ee ee ee ee 64 12 2 2 CUSTOM DATA FIELD UPDATE 64 12 2 3 CUSTOM DATA FIELD ADD iese see see see ee se ee ee ee Ge ee Ge ee Ge GRA GRA ERA AR Re ee ee ee ee 65 12 24 KMC READ ONLY siinsesse aaa GER ee Gegee ee Eie Re ea geb eek ee dee hd ees oe ge ea 66 1225 KMC ACCESS et ee EE see ii heeds edi einen dele bees ee 67 12 2 6 AUDIT TRAIL ADD ee ee SE AG EE Rene EE Re Ge EER aaa eke se Dek ee Ee ees Ee bee 67 122 7 AUDIT TRAIL BASE sies esse NE es sees Gede bedde ie de aaaea aaria an na aaa 67 12 2 8 ANALYTICS SEND DATA 68 12 2 9 SEARCH SERVIC Bis susse ese Ens EE Ee SEE SR REG GER de ees ss GER ER ve Re ue gedd ge 68 12 2 10 WIDGET ADMIN ts esse ie ee es Lee ees ES Ke Ee Ri dE ek ainda 69 12 2 11 ANALYTICS SEND DATA esse age tee seg ke be ese Re Ee ek Ge bee se Ee ee eg ke Be ee ARK Reed Ee Seed eg Ee 69 12 2 12 WIDGET ADMIN RR OE ER EE RE OR et 69 12 2 13 ANALYTICS BASE csalnia EE OE a 69 12 2 14 ADMIN WHITE DRANDING ee see ee ee ee ee ee ee ee Ge ee Ge ee GRA GRA GRA ERA ERA Re ee 70 12 2 15 ADMIN PUBLISHER MANAGE iese see see ee se ee ee ee ee ee ee ee ee ee ee ee
52. e ae Goeie TE ae DS OE Re 33 A21 ee eie RR EE EE EE EO EO gedoe 33 Re EE 34 4 2 3 OPCAteA COM RE EE EE ee Eg Ee ee Oe ER Ge Oe ee GR ge ee ee Ee ee ee ele 35 424 EE BE 35 42o te ER EA ER EO ER IE AE 36 Te e dae ol RE EE ER EE RE EE OR EE EO ER EE 37 4 3 PERMISSIONSERVICE issue ie teug ende Me esse osse su gee ek De eed ee eg ees gede seg deu we el gede ee ee eg Ke 37 ER ME ee eie RA OR EE RE OE RE N ees ed 38 432 Ie te ie EA OR ER RE N eens OE GR EE ee 39 4 3 3 UpdateAcliOm EE 39 ee Ai eie EE EE EE RE EE ee 40 Publisher s Guide Users Roles and Permissions User Manual Page 3 MIL Ex N Kaltura open source video 10 11 A325 MSTACTIOMN EE 41 4 3 6 getCurrentPermisSiOnS u iss dese dee AR AA AA Ge AA Ke ERA AA AA Re ee ee Ge AA ee AA ee RA ee 41 4 4 PERMISSIONITEMERVICE 42 AAT ACCA eie EO ER TE 42 4 4 2 ei EA ORE OE N EE ORE N 43 443 UpdateAcliOm se BEE E ee eebe ee ees 44 4AA EE EE A4 E Lett 45 ADDING A USER oi EE EE N EE aeiia EEA 47 S USEGASE ER AE ER ee GE een 47 5 2 MELEN Gees ee earns 47 CREATING A NEW ROLE BASED ON AN EXISTING ROLE 22 s cseeeeeeeeeeeeeeceeseeeseeeeeeneeeeseeees 49 Gil JUSE CASE EE EE EE EE 49 6 2 SANPLEC EE 49 MODIFYING A PERMISSION ese ees sesse eeste we eke se ee n Ee ve eek ede ee bede ees We de Geen ka ee ke Ak ke ee eed ERGE Ke ER Ke ee 51 Tl USEGASE DE Me ee ee ce ee De AE er De Ee ee on ee eee 51 7 2 SAMPLE GODE ss bod sesse di bei ees Wese dee bee
53. e default roles The other sections list the roles and permissions included in each default role 12 1 1 Understanding Default Roles The Kaltura system provides the following types of default roles e Partner 0 Roles Every partner may use the roles but cannot edit them e Template Partner 99 Roles The roles are copied to every partner when the partner is created Every partner may use and edit the roles e Admin Console Partner 2 Roles Only an Admin Console partner may use and edit the roles 12 1 2 Partner 0 Roles Role Permissions Basic User Session Role BASE_USER_SESSION_PERMISSION Publisher Administrator All permissions allowed for the current partner 12 1 3 Template Partner 99 Roles Role Permissions Manager KMC_ACCESS Publisher s Guide Users Roles and Permissions User Manual Page 59 NZ aw Kaltura open source video Role Permissions KMC_READ_ONLY CONTENT_INGEST_UPLOAD CONTENT_INGEST_BULK_UPLOAD CONTENT_INGEST_FEED CONTENT_MANAGE_DISTRIBUTION_BASE CONTENT_MANAGE_DISTRIBUTION_WHERE CONTENT_MANAGE_DISTRIBUTION_SEND CONTENT_MANAGE_DISTRIBUTION_REMOVE CONTENT_MANAGE_DISTRIBUTION_PROFILE_MODIFY CONTENT_MANAGE_VIRUS_SCAN CONTENT_MANAGE_MIX CONTENT_MANAGE_BASE CONTENT_MANAGE_METADATA CONTENT_MANAGE_ASSIGN_CATEGORIES CONTENT_MANAGE_THUMBNAIL CONTENT_MANAGE_SCHEDULE CONTENT_MANAGE_ACCESS_CONTROL CONTENT_MANAGE_CUSTOM_DATA CONTENT_MANA
54. e includes an object property that requires special permission only if the user has the permission item that allows reading the property Publisher s Guide Users Roles and Permissions User Manual Page 57 Ze LJ AN Kaltura open source video 11 UNDERSTANDING APPLICATION DATA FLOWS 11 1 KMC This section describes the basic data flow of the KMC for users roles and permissions 1 A user logs into the KMC 2 Using an API request the KMC requests a list of permissions associated with the user from the server 3 The KMC displays and hides specific UI objects according to the user s permissions 11 2 ADMIN CONSOLE This section describes the basic data flow of the Admin Console for users roles and permissions 1 A user logs into the Admin Console 2 Using an API request the Admin Console requests a list of permissions associated with the user from the server 3 According to the user s permissions the Admin Console e Displays and hides specific UI objects e Enables and blocks Admin Console actions 11 3 KALTURA MEDIASPACE TBD Publisher s Guide Users Roles and Permissions User Manual Page 58 We PA Za Kaltura open source video 12 APPENDIX A SYSTEM DEFAULTS This section describes the system defaults for Mapping Roles to Permission Names Mapping Permission Names to Permission Items 12 1 MAPPING ROLES TO PERMISSION NAMES Understanding Default Roles defines th
55. ed USER_WRONG_PASSWORD The user password is incorrect INVALID_PARTNER_ ID The partner ID name is not valid LOGIN_RETRIES_EXCEEDED You tried logging in too many times Your account is locked and will not be available for 24 hours LOGIN_BLOCKED Your account is locked PASSWORD_EXPIRED Your password expired USER_IS_BLOCKED The user is blocked 4 1 10 updateLoginDataAction Updates a user s login data e Email e Password e Name public function updateLoginDataAction SoldLoginId Spassword SnewLoginId SnewPassword SnewFirstName null SnewLastName ml MMII Name Input Output Type Description oldLoginId Input String The user s current email address that identified the user for login password Input String The user s existing password newLoginId Input String The user s email address that will Optional identify the user for login Publisher s Guide Users Roles and Permissions User Manual Page 27 MIL i N Kaltura open source video Name Input Output Type Description newPassword Input String The user s new password Optional newFirstName Input String The user s new first name Optional newLastName Input String The user s new last name Optional Errors Name Description INVALID_FIELD_VALUE LOGIN_DATA_NOT_FOUND WRONG_OLD_PASSWORD PASSWORD_STRUCTURE_
56. ermission Items API Actions DISTRIBUTION SEND Service Actions contentdistribution_entrydistribution submitadd submitupdate submitfetchreport retrysubmit 12 2 69 CONTENT MANAGE Partner ID 0 Permission Items API Actions ASSIGN CATEGORIES Service Actions document_documents update media update data update baseentry update category get list Publisher s Guide Users Roles and Permissions User Manual Page 90 Me AN Kaltura open source video Service Actions document update Permission Items API Parameters Object Properties KalturaBaseEntry categories categorieslds categorieslds 12 2 70 CONTENT MANAGE THUMBNAIL Partner ID 0 Permission Items API Actions Service Actions document_documents update media update updatethumbnail updatethumbnailjpeg updatethumbnailfromurl updatethumbnailfromsourceentry livestream updateofflinethumbnailjpeg updateofflinethumbnailfromurl data update baseentry update updatethumbnailjpeg Publisher s Guide Users Roles and Permissions User Manual Page 91 Me AN Kaltura open source video Service Actions updatethumbnailfromurl updatethumbnailfromsourceentry thumbparams add get update delete list getbyconversionprofileid
57. ient gt userRole gt cloneAction originalRoleId Publisher s Guide Users Roles and Permissions User Manual Page 50 V Soe AN Kaltura open source video 7 MODIFYING A PERMISSION 7 1 USE CASE To modify a permission 1 Log on to the Kaltura system 2 AKS is generated to identify and authenticate the user 3 Send the following API request to the server PermissionService updateAction e Specify the following o The current permission name o The properties to update as a KalturaPermission object 4 The server processes the API request and returns the updated permission object 7 2 SAMPLE CODE Include the KalturaClient class require_once KalturaClient php Initiate a new KalturaClient object with the partner details SpartnerId lt PARTNER_ID_HERE gt replace with your partner ID Sconfig new KalturaConfiguration Spartnerid Sconfig gt serviceUrl http www kaltura com set serviceUrl if different Sclient new KalturaClient Sconfig Set user login variables and call user gt loginByLoginId action SloginId lt USER_LOGIN_EMAIL_HERE gt replace with user s login email Spassword lt USER_LOGIN_PASSWORD_HERE gt replace with user s login password ks client gt user gt loginByLoginId loginId password S partnerId ese rneer EE EE Publisher s Guide Users Roles and Permissions User Manual Page 51 V o Oo A Kalt
58. ified hash key is expired The specified hash key is not valid The password you chose has already been used An internal server error occurred Publisher s Guide Users Roles and Permissions User Manual Page 30 Me AN Kaltura open source video 4 1 13 enableLoginAction Enables a user to log into a partner account using an email address and a password public function enableLoginAction SuserId loginId Spassword null Parameters Name Input Output Type Description userId Input String The user s unique identifier in the partner s system login d Input String The user s email address that identifies the user for login password Input String The user s password Optional Return Value The user object represented by the user and login IDs Errors Name Description USER_LOGIN_ALREADY_ENABLED The user already is allowed to log in USER_NOT_FOUND The user cannot be located ADMIN_LOGIN_USERS_QUOTA_EXCEEDED PASSWORD_STRUCTURE_INVALID The permitted number of user logins has been reached No more logins are permitted for this partner account The password you entered is not valid Passwords must e Contain between 8 and 14 characters e Not contain your name Publisher s Guide Users Roles and Permissions User Manual Page 31 MIL Ex N Kaltura open source video Name Description e Contain
59. ig new KalturaConfiguration Spartnerid Sconfig gt serviceUrl http www kaltura com set serviceUrl if different Sclient new KalturaClient config Set user login variables and call user gt loginByLoginId action SloginId lt USER_LOGIN_EMAIL_HERE gt replace with user s login email Spassword lt USER_LOGIN_PASSWORD_HERE gt replace with user s login password Ska client gt user gt loginByLoginId loginId password S partnerId ExT See ede eiiens do se tie KS had Hs uct urned 248 Publisher s Guide Users Roles and Permissions User Manual Page 53 We Oo A Kaltura open source video client gt setKs ks Set a KalturaPermissionItemFilter object optional Sfilter new KalturaPermissionItemFilter Sfilter typeln KalturaPermissionItemType API_ACTION_ITEM example of listing only action permission items Set a KalturaFilterPager object optional Spager new KalturaFilterPager Spager pagelndex 1 get only page 1 Spager pageSize 20 page size must be 20 Call the permissionItem gt list action SpermissionItemList client gt permissionItem gt listAction filter Spager Publisher s Guide Users Roles and Permissions User Manual Page 54 V Soe AN Kaltura open source video 9 APPLYING A ROLE TO A USER 9 1 USE CASE To apply a role to a user 1 Log on to the Kaltura system 2 A
60. importjob freeexclusiveimportjob cleanexclusivejobs addbulkuploadresult getbulkuploadlastresult updatebulkuploadresults addmediainfo getexclusivepostconvertjobs updateexclusivepostconvertjob freeexclusivepostconvertjob getexclusiveextractmediajobs updateexclusiveextractmediajob Publisher s Guide Users Roles and Permissions User Manual Page 110 MIL i N Kaltura open source video Service Actions freeexclusiveextractmediajob getexclusivestorageexportjobs getexclusivestoragedeletejobs updateexclusivestorageexportjob updateexclusivestoragedeletejob freeexclusivestorageexportjob freeexclusivestoragedeletejob getexclusivebulkuploadjobs getexclusiveconvertcollectionjobs getexclusiveprovisionprovidejobs getexclusiveprovisiondeletejobs updateexclusivebulkuploadjob updateexclusiveconvertcollectionjob updateexclusiveprovisionprovidejob updateexclusiveprovisiondeletejob freeexclusivebulkuploadjob freeexclusiveconvertcollectionjob freeexclusiveprovisionprovidejob freeexclusiveprovisiondeletejob getexclusiveconvertjobs updateexclusiveconvertjob freeexclusiveconvertjob getexclusivenotificationjobs updateexclusivenotificationjob Publisher s Guide Users Roles and Permissions User Manual Page 111 MIL i N Kaltura o
61. inAction Logs a user into a partner account with a partner ID a partner user ID puser and a user password loginByLoginldAction Logs a user into a partner account with a user login ID and a user password updateLoginDataAction Updates a user s login data Publisher s Guide Users Roles and Permissions User Manual Page 18 Me AN Kaltura open source video Name Description e Email e Password e Name resetPasswordAction Resets a user s password and sends the user an email containing a link for setting up the new password setinitialPasswordAction Sets a user s password enableLoginAction Enables a user to log into a partner account using an email address and a password disableLoginAction Disables a user s ability to log into a partner account using an email address and a password 4 1 1 addAction Adds a new user to an existing account in the Kaltura database function addAction KalturaUser user Parameters Name Input Output Type Description user Input KalturaUser The new user Return Value Type Description KalturaUser The added user object Publisher s Guide Users Roles and Permissions User Manual Page 19 NUL GANS Kaltura open source video Errors Name Description DUPLICATE USER BY ID A user with the ID user id already exists in system PROPERTY VALIDA
62. le KMC the Kaltura Administration Console and Kaltura MediaSpace e Content based permissions 1 2 WHO SHOULD READ THIS DOCUMENT This document is intended for Kaltura employees partners community members and customers 1 3 ASSUMPTIONS To understand this document you need to be familiar with e Kaltura terminology e Kaltura server API architecture including services actions and objects e PHP programming language 1 4 RELATED INFORMATION e http www kaltura org e Understanding API Services TBD Publisher s Guide Users Roles and Permissions User Manual Page 10 We e E Za Kaltura open source video 2 GLOSSARY Term Definition Kaltura Administration Console An application for administering the Kaltura system including administration of multiple Kaltura accounts The Admin Console typically is accessed by Kaltura system administrators and the IT team Kaltura MediaSpace A fully customizable video portal KMC Kaltura Management Console An application for content management application creation and configuration content monetization distribution and syndication and account management and reporting The KMC is accessed by Kaltura partner administrators and the various users of a Kaltura account KS Kaltura session A unique string that identifies the session creator The KS is used to authenticate Kaltura API calls kuser Kaltura user Partner An individual o
63. lete getbyemailaddress addmediaentry 12 2 107 SYSTEM ADMIN CONTENT DISTRIBUTION BASE Partner ID 2 Publisher s Guide Users Roles and Permissions User Manual Page 124 Me AN Kaltura open source video Permission Items API Actions Service Actions contentdistribution_distributionprovider list contentdistribution_distributionprofile get list listoypartner contentdistribution_entrydistribution list contentdistribution_genericdistributionprovideraction get list getbyproviderid contentdistribution_genericdistributionprovider get list 12 2 108 SYSTEM ADMIN CONTENT DISTRIBUTION MODIF Y Partner ID 2 Permission Items API Actions Service Actions metadata_metadataprofile list listfields contentdistribution_distributionprofile add update updatestatus delete Publisher s Guide Users Roles and Permissions User Manual Page 125 Me AN Kaltura open source video Service Actions flavorparams list contentdistribution_genericdistributionprovider add update delete contentdistribution_genericdistributionprovideraction add addmrsstransform addmrsstransformfromfile addmrssvalidate addmrssvalidatefromfile addresultstransform addresultstransformfromfile update updatebyproviderid delete deletebypro
64. llowing symbols o 4 e Not contain the following characters lt or gt PASSWORD_ALREADY_USED The password you chose has already been used INVALID_FIELD_VALUE The value in field field namel is not valid LOGIN ID ALREADY USED The login ID is already in use 4 1 12 setlnitialPasswordAction Sets a user s password public function setInitialpasswordAction ShashKey SnewPassword Publisher s Guide Users Roles and Permissions User Manual Page 29 MIL Ex N Kaltura open source video Remarks The application uses this action internally Context Called to set a user s password after a resetPasswordAction request Parameters Name Input Output Type Description hashKey Input String The hash key used to identify the user newPassword Input String The new password to set for the user Errors Name Description LOGIN_DATA_NOT_FOUND The login ID cannot be located PASSWORD_STRUCTURE_INVALID PASSWORD_ALREADY_USED INTERNAL_SERVERL_ERROR NEW_PASSWORD_HASH_KEY_EXPIRED NEW_PASSWORD_HASH_KEY_INVALID The password you entered is not valid Passwords must e Contain between 8 and 14 characters e Not contain your name e Contain at least one lowercase letter a z e Contain at least one digit 0 9 e Contain at least one of the following symbols ORKAAN e Not contain the following characters lt or gt The spec
65. ltura open source video 12 2 43 STUDIO DELETE UIGONF Partner ID 0 Permission Items API Actions Service Actions uiconf delete 12 2 44 STUDIO UPDATE UICONF Partner ID 0 Permission Items API Actions Service Actions uiconf update 12 2 45 STUDIO ADD UIGONF Partner ID 0 Permission Items API Actions Service Actions uiconf add clone Publisher s Guide Users Roles and Permissions User Manual Page 80 Me e AN Kaltura open source video 12 2 46 STUDIO BASE Partner ID 0 Permission Items API Actions Service Actions uiconf get list listtemplates 12 2 47 SYNDICATION DELETE Partner ID 0 Permission Items API Actions Service Actions syndicationfeed delete 12 2 48 SYNDICATION UPDATE Partner ID 0 Permission Items API Actions Service Actions syndicationfeed update Publisher s Guide Users Roles and Permissions User Manual Page 81 Me AN Kaltura open source video 12 2 49 SYNDICATION ADD Partner ID 0 Permission Items API Actions Service Actions syndicationfeed add 12 2 50 SYNDICATION BASE Partner ID 0 Permission Items API Actions Service Actions syndicationfeed get list getentrycount requestconversion 12 2 51 PLAYLIST EMBED CODE Partner ID 0 12 2 5
66. o the permission Return Value KalturaPermission The retrieved permission object Errors Name Description INVALID_OBJECT_ID The object identifier is not valid 4 3 3 updateAction Updates an existing permission object public function updateAction SpermissionName KalturaPermission Spermission Parameters Name Input Output Type Description permissionName Input String The name assigned to the permission permission Input KalturaPermission The updated permission Publisher s Guide Users Roles and Permissions User Manual Page 39 Me e AN Kaltura open source video Return Value Type Description KalturaPermission The updated permission object Errors Name Description INVALID_OBJECT_ID The object identifier is not valid 4 3 4 deleteAction Deletes an existing permission object public function deleteAction permissionName Parameters Name Input Output Type Description permissionName Input String The name assigned to the permission Return Value Type Description KalturaPermission The deleted permission object Errors Name Description INVALID OBJECT ID The object identifier is not valid Publisher s Guide Users Roles and Permissions User Manual Page 40 MIL i N Kaltura open source video 4 3 5 listAction Lists
67. ole The retrieved user role object Publisher s Guide Users Roles and Permissions User Manual Page 34 Me e VAN Kaltura open source video Errors Name Description INVALID OBJECT ID The object identifier is not valid 4 2 3 updateAction Updates an existing user role object public function updateAction SuserRoleld KalturaUserRole SuserRole Parameters Name Input Output Type Description userRoleld Input Integer The user role s unique identifier userRole Input KalturaUserRole The role object that contains parameters to update Return Value Type Description KalturaUserRole The updated user role object Errors Name Description INVALID OBJECT ID The object identifier is not valid PERMISSION NOT FOUND A permission associated with the role cannot be located 4 2 4 deleteAction Deletes an existing user role object public function deleteAction SuserRolerd Publisher s Guide Users Roles and Permissions User Manual Page 35 Me e VAN Kaltura open source video Parameters Name Input Output Type Description userRoleild Input Integer The user role s unique identifier Return Value Type Description KalturaUserRole The deleted user role object Errors Name Description INVALID_OBJECT_ID The object identifier is not valid ROLE_IS_BEIN
68. ons User Manual Page 128 Me E Sam Kaltura open source video 0 Permission Items API Actions Service Actions permission add 12 2 114 ADMIN PERMISSION UPDATE Partner ID 0 Permission Items API Actions Service Actions permission update 12 2 115 ADMIN PERMISSION DELETE Partner ID 0 Permission Items API Actions Actions permission delete 12 2 116 SHORT LINK BASE Partner ID 0 Permission Items API Actions Publisher s Guide Users Roles and Permissions User Manual Page 129 Me AN Kaltura open source video Service Actions shortlink shortlink get list add update delete 12 2 117 SHORT LINK MODIFY Partner ID 0 Permission Items API Actions Service Actions shortlink_shortlink add update delete Publisher s Guide Users Roles and Permissions User Manual Page 130
69. ons e Special and Plugin Permissions e Partner Group Permissions A permission type may be one of the following e A user level permission which is associated with an individual user through a user role e Apartner level permission which applies only to a partner and is not associated with an individual user A user role does not contain partner level permissions Normal Permissions Normal permissions which are described in this document are user level permissions Normal permissions group permission items which may be included in a user role The user role is assigned to an individual user A user role may only contain normal permissions Special and Plugin Permissions Special and plugin permissions are partner level permissions Special and plugin permissions may define e A feature such as access to a specific plugin for example virus scan e A special service such as analytics Note Anormal permission that specifies access to an API action or object property that relates to a plugin usually applies only if the plugin is included in a partner level special permission Partner Group Permissions Partner group permissions are partner level permissions Partner group permissions include permission items Publisher s Guide Users Roles and Permissions User Manual Page 16 open source video Partner group permissions have a special partnerGroup parameter The partnerGroup parameter is a comma separated lis
70. pen source video Service Actions freeexclusivenotificationjob getexclusivemailjobs updateexclusivemailjob freeexclusivemailjob freeexclusiveconvertprofilejob freeexclusiveremoteconvertjob getexclusivebulkdownloadjobs updateexclusivebulkdownloadjob freeexclusivebulkdownloadjob getexclusivecapturethumbjobs updateexclusivecapturethumbjob freeexclusivecapturethumbjob logconversion resetjobexecutionattempts updateexclusiveconvertjobsubtype updateexclusiveconvertprofilejob getexclusivealmostdoneconvertjobs getexclusivealmostdoneconvertprofilejobs getexclusivealmostdonebulkuploadjobs getexclusivealmostdoneconvertcollectionjobs getexclusivealmostdoneprovisionprovidejobs getexclusivealmostdoneprovisiondeletejobs getexclusivealmostdoneremoteconvertjobs getexclusivealmostdonebulkdownloadjobs Publisher s Guide Users Roles and Permissions User Manual Page 112 MIL Ex N Kaltura open source video Service Actions batchcontrol configloaded reportstatus getcommand setcommandresult getfullstatus emailingestionprofile getbyemailaddress addmediaentry filesync filesync sync metadata metadatabatch getexclusiveimportmetadatajobs updateexclusiveimportmetadatajob freeexclusiveimportmetadatajob getexclusivetransformmetadat
71. permissions when the KS contains a user ID and a role is assigned to the user The KS session type determines permissions when one of the following occurs e The KS does not contain a user ID e The user is not assigned a role Partner User ID puser_id A puser ID uniquely identifies the user for a specific partner Kaltura User kuser A kuser e Is an object that represents a person who uses the Kaltura system e Contains metadata about the user such as name email and location e Is identified by a partner user ID puser id which must be unique among one partner s users e May be associated with more than one partner Note When a kuser is associated with multiple partners the user has multiple kuser objects one for each partner All of the multiple kuser objects use the same user_login_data record for system logins User Login Data Information about Kaltura user kuser logons is stored in the user_login_data database table The user login data includes e Email e Name e Password e Last partner whose account the user logged on to e Number of bad login retries Publisher s Guide Users Roles and Permissions User Manual Page 15 open source video e Password expiry date One data record may relate to multiple kusers This enables a user to use a single ID and password for multiple partner accounts 3 3 PERMISSION TYPES The Kaltura system provides the following types of permission e Normal Permissi
72. ploader KMC ACCESS KMC READ ONLY CONTENT INGEST UPLOAD CONTENT INGEST BULK UPLOAD CONTENT MANAGE BASE Content Moderator KMC ACCESS KMC READ ONLY CONTENT MODERATE APPROVE REJECT CONTENT MODERATE BASE CONTENT MODERATE METADATA CONTENT MODERATE CUSTOM DATA Player Designer KMC ACCESS KMC READ ONLY STUDIO BASE Publisher s Guide Users Roles and Permissions User Manual Page 62 NZ aw Kaltura open source video Role Permissions STUDIO_ADD_UICONF STUDIO_UPDATE_UICONF STUDIO_DELETE_UICONF STUDIO_BRAND_UICONF 12 1 4 Admin Console Partner 2 Roles Role Permissions System Administrator All Support Manager SYSTEM_ADMIN_BASE SYSTEM_ADMIN_PUBLISHER_BASE SYSTEM_ADMIN_PUBLISHER_KMC_ACCESS SYSTEM_ADMIN_PUBLISHER_CONFIG SYSTEM_ADMIN_PUBLISHER_BLOCK SYSTEM_ADMIN_PUBLISHER_ADD SYSTEM_ADMIN_PUBLISHER_USAGE SYSTEM_ADMIN_DEVELOPERS_TAB SYSTEM_ADMIN_BATCH_CONTROL SYSTEM_ADMIN_CONTENT_DISTRIBUTION_BASE SYSTEM_ADMIN_CONTENT_DISTRIBUTION_MODIFY Publishers Administrator SYSTEM_ADMIN_BASE SYSTEM_ADMIN_PUBLISHER_BASE SYSTEM_ADMIN_PUBLISHER_KMC_ACCESS SYSTEM_ADMIN_PUBLISHER_CONFIG SYSTEM_ADMIN_PUBLISHER_BLOCK SYSTEM_ADMIN_PUBLISHER_ADD SYSTEM_ADMIN_PUBLISHER_USAGE SYSTEM_ADMIN_DEVELOPERS_TAB Publisher s Guide Users Roles and Permissions User Manual Page 63 Me PA dm Sam Kaltura open source video Role Permissions
73. r organization with a Kaltura system account Partner ID A numeric identifier that uniquely identifies a partner in the Kaltura database Publisher See Partner puser ID Partner user identifier Publisher s Guide Users Roles and Permissions User Manual Page 11 We aw Kaltura open source video 3 UNDERSTANDING USERS ROLES AND PERMISSIONS 3 1 ROLES AND PERMISSIONS OVERVIEW 3 1 1 Introduction Roles and permissions enable organizations to define a user s ability to perform actions based on the user s responsibilities A publisher uses the roles and permissions infrastructure to specify actions that a user is allowed to perform 3 1 2 Server Infrastructure API actions and API object properties e An API action is not allowed unless a user has specific permission to execute it e All API actions have permission items e Only some API object properties have permission items e An API object parameter is allowed by default When an object parameter does require a permission a code comment specifies the permission item settings The comment is included in the code of the class that defines the object in the parameter s comment section The comment format is requiresPermission followed by the applicable permission item settings For example requiresPermission insert update Permission Item Permission and Role Overview Permission Item enables very granular settings for accessing a specific API and o
74. ription KalturaPermissionItem The retrieved permission item object Errors Description INVALID_OBJECT_ID The object identifier is not valid Publisher s Guide Users Roles and Permissions User Manual Page 43 MIL i N Kaltura open source video 4 4 3 updateAction Updates an existing permission item object public function updateAction permissionItemId KalturaPermissionItem SpermissionItem Remarks This action is available only to Kaltura system administrators Parameters Name imputiOutput Type Gescretor permissionItemid inn integer The permission item s unique identifier permissionItem Input KalturaPermissionItem The updated permission item Return Value Type Description KalturaPermissionItem The updated permission item object Errors Name Description INVALID OBJECT ID The object identifier is not valid 4 4 4 deleteAction Deletes an existing permission item object public function deleteAction SpermissionltemId Remarks This action is available only to Kaltura system administrators Publisher s Guide Users Roles and Permissions User Manual Page 44 Me AN Kaltura open source video Parameters Name Input Output Type Description permissionItemId Input Integer The permission item s unique identifier Return Value Type Description KalturaPermission
75. service API class that creates and manages user permissions Extends KalturaBaseService Publisher s Guide Users Roles and Permissions User Manual Page 37 Me AN Kaltura open source video Actions Name Description addAction Adds a new permission object to the account getAction Retrieves a permission object using its ID updateAction Updates an existing permission object deleteAction Deletes an existing permission object listAction Lists permission objects that are associated with an account getCurrentPermissions Retrieves a list of permissions that apply to the current KS 4 3 1 addAction Adds a new permission object to the account public function addAction KalturaPermission permission Parameters Input KalturaPermission The new permission Return Value Type Description KalturaPermission The added permission object Errors Name Description PROPERTY_VALIDATION_CANNOT_BE_NULL The property name cannot be NULL PROPERTY VALIDATION NOT _UPDATABLE The property name cannot be updated Publisher s Guide Users Roles and Permissions User Manual Page 38 Me E Sam Kaltura open source video 4 3 2 getAction Retrieves a permission object using its ID public function getAction SpermissionName Parameters Name Input Output Type Description permissionName Input String The name assigned t
76. t of partner IDs Note When the value of partnerGroup is an asterisk the parameter applies to all partners When a user is allowed to perform an action based on the user s role and the user s partner has a partner group permission the user is allowed to perform the action on all the partners listed in partnerGroup Publisher s Guide Users Roles and Permissions User Manual Page 17 We e E AN Kaltura open source video 4 APIS FOR USERS ROLES AND PERMISSIONS You can use Kaltura APIs to define and modify users roles and permissions 4 1 USERSERVICE A service API class that manages partner users Remarks userId is the unique identifier in the partner s system The partneriId userId couple constitutes a unique key in Kaltura s database Extends KalturaBaseUserService Note AdminUserService also extends KalturaBaseUserService for backward compatibility Do not use AdminUserService which is deprecated Actions Name Description addAction Adds a new user to an existing account in the Kaltura database updateAction Updates an existing user object getAction Retrieves a user object for a specified user ID getByLoginldAction Retrieves a user object for a user s login ID and partner ID deleteAction Deletes a user from a partner account listAction Lists user objects that are associated with an account notifyBan Notifies that a user is banned from an account log
77. turaClient object with the partner details SpartnerId lt PARTNER_ID_HERE gt replace with your partner ID Sconfig new KalturaConfiguration Spartnerid Sconfig gt serviceUrl http www kaltura com set serviceUrl if different Sclient new KalturaClient S config Set user login variables and call user gt loginByLoginId action SloginId lt USER_LOGIN_EMAIL_HERE gt replace with user s login email Spassword lt USER_LOGIN_PASSWORD_HERE gt replace with user s login password Ska client gt user gt loginByLoginId loginId password partnerId Vse thee lient do use rhe KS Eeer isi rerurnedik Sclient gt setKs Sks Create a new KalturaUser object to be added SnewUser new KalturaUser SnewUser gt id NEW_USER_ID Publisher s Guide Users Roles and Permissions User Manual Page 47 V o oO A Kaltura open source video newUser gt firstName first name SnewUser gt lastName last name SnewUser gt email new_user kaltura com SnewUser gt isAdmin true SnewUser gt roleIds 30 must match an existing user role ID Call the user gt add action with the new user object SaddedUser client gt user gt add newUser Publisher s Guide Users Roles and Permissions User Manual Page 48 V Soe AN Kaltura open source video 6 CREATING A NEw ROLE BASED ON AN EXISTING ROLE 6 1 USE CASE
78. ura open source video client gt setKs ks Set the existing permissions name SpermissionName lt PERMISSION_NAME_HERE gt must match an existing permission name Set a KalturaPermission object with the required parameters to update SupdatePermission new KalturaPermission SupdatePermission gt name NEW_PERMISSION_NAME SupdatePermission gt permissionItemsIds lt LIST_OF_PERMISSION_ITEM_IDS gt must match existing permission item IDs Call the permission gt update action SupdatedPermission client permission update S permissionName SupdatePermission Publisher s Guide Users Roles and Permissions User Manual Page 52 V Soe AN Kaltura open source video 8 LISTING AN ACCOUNT S PERMISSION ITEMS 8 1 USE CASE To list the permission items that are associated with an account 1 Log on to the Kaltura system 2 AKS is generated to identify and authenticate the user 3 Send the following API request to the server PermissionltemService listAction e You may specify o A filter o A limit on the number of records to display on a page 4 The server processes the API request and returns the list of permission item objects 8 2 SAMPLE CODE Include the KalturaClient class require_once KalturaClient php Initiate a new KalturaClient object with the partner details SpartnerId lt PARTNER_ID_HERE gt replace with your partner ID Sconf
79. viderid 12 2 109 SYSTEM ADMIN Partner ID 2 Permission Items API Actions PERMISSIONS MANAGE Actions Service add userrole delete get Publisher s Guide Users Roles and Permissions User Manual Page 126 Me AN Kaltura open source video Service Actions list update clone permission add delete update get list permissionitem add delete update 12 2 110 SYSTEM INTERNAL Partner ID 2 Permission Items API Actions Service Actions kalturainternaltools_kalturainternaltoolssystemhelper fromsecurestring iptocountry getremoteaddress 12 2 111 SYSTEM ADMIN ENTRY INVESTIGATION Partner ID 2 Publisher s Guide Users Roles and Permissions User Manual Page 127 Me AN Kaltura open source video Permission Items API Actions Service Actions contentdistribution_entrydistribution list flavorparams list thumbparams list flavorasset getbyentryid reconvert thumbasset getbyentryid regenerate adminconsole_entryadmin get gettracks adminconsole_flavorparamsoutput list list adminconsole_mediainfo list filesync_filesync list 12 2 112 SYSTEM FILESYNC Partner ID 2 Permission Items API Actions Service Actions filesync_filesync list 12 2 113 ADMIN PERMISSION ADD Partner ID Publisher s Guide Users Roles and Permissi

Publisher Guide Users Roles and Permissions User Manual

Contents

Download Pdf Manuals

Related Search

Related Contents