{ "opencollection": "1.0.0", "info": { "name": "Kaltura OTT accessControl user API", "version": "3.6.287.20720" }, "items": [ { "info": { "name": "user", "type": "folder" }, "items": [ { "info": { "name": "user.add", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/add", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Adds a new user to an existing account in the Kaltura database.\n\nInput param $id is the unique identifier in the partner's system." }, { "info": { "name": "user.addFromBulkUpload", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/addFromBulkUpload", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "bulkUploadData[objectType]", "value": "", "type": "query" }, { "name": "bulkUploadData[fileName]", "value": "", "type": "query", "description": "Friendly name of the file, used to be recognized later in the logs." }, { "name": "bulkUploadData[objectData][objectType]", "value": "", "type": "query" }, { "name": "bulkUploadData[emailRecipients]", "value": "", "type": "query", "description": "Recipients of the email for bulk upload success/failure" }, { "name": "bulkUploadData[numOfErrorObjects]", "value": "", "type": "query", "description": "Number of objects that finished on error status" }, { "name": "bulkUploadData[privileges]", "value": "", "type": "query", "description": "privileges for the job" }, { "name": "bulkUploadUserData[objectType]", "value": "", "type": "query" } ] } }, { "info": { "name": "user.checkLoginDataExists", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/checkLoginDataExists", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Action which checks whther user login" }, { "info": { "name": "user.delete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/delete", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Deletes a user from a partner account." }, { "info": { "name": "user.disableLogin", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/disableLogin", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Disables a user's ability to log into a partner account using an email address and a password.\n\nYou may use either a userId or a loginId parameter for this action." }, { "info": { "name": "user.enableLogin", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/enableLogin", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Enables a user to log into a partner account using an email address and a password" }, { "info": { "name": "user.exportToCsv", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/exportToCsv", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Creates a batch job that sends an email with a link to download a CSV containing a list of users" }, { "info": { "name": "user.generateQrCode", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/generateQrCode", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "get QR image content" }, { "info": { "name": "user.get", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/get", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Retrieves a user object for a specified user ID." }, { "info": { "name": "user.getByLoginId", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/getByLoginId", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Retrieves a user object for a user's login ID and partner ID.\n\nA login ID is the email address used by a user to log into the system." }, { "info": { "name": "user.index", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/index", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Index an entry by id." }, { "info": { "name": "user.list", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/list", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Lists user objects that are associated with an account.\n\nBlocked users are listed unless you use a filter to exclude them.\n\nDeleted users are not listed unless you use a filter to include them." }, { "info": { "name": "user.login", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/login", "params": [ { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Logs a user into a partner account with a partner ID, a partner user ID (puser), and a user password." }, { "info": { "name": "user.loginByKs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/loginByKs", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Logs a user to the destination account provided the KS' user ID is associated with the destination account and the loginData ID matches" }, { "info": { "name": "user.loginByLoginId", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/loginByLoginId", "params": [ { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Logs a user into a partner account with a user login ID and a user password." }, { "info": { "name": "user.loginDataResetPassword", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/loginDataResetPassword", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Resets user login password" }, { "info": { "name": "user.notifyBan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/notifyBan", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Notifies that a user is banned from an account." }, { "info": { "name": "user.resetPassword", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/resetPassword", "params": [ { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Reset user's password and send the user an email to generate a new one." }, { "info": { "name": "user.serveCsv", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/serveCsv", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Will serve a requested CSV" }, { "info": { "name": "user.setInitialPassword", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/setInitialPassword", "params": [ { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Set initial user password" }, { "info": { "name": "user.update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/update", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Updates an existing user object.\n\nYou can also use this action to update the userId." }, { "info": { "name": "user.updateLoginData", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/updateLoginData", "params": [ { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Updates a user's login data: email, password, name." }, { "info": { "name": "user.validateHashKey", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/user/action/validateHashKey", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Validate hash key" } ] } ], "bundled": true }