Managing Users and Privileges
These APIs are invoked on the Zoom Web Management Server. Default TCP port: 8443. The role needed to execute these APIS: Project Admin or Super Admin unless otherwise stated.
Form request data refers to the Http Form data that must be sent either as a URL-encoded query parameter or in a POST.
Below is a list of a few our web administration APIs. Please refer to the Zoom Web Administration Reference guide for an exhaustive list of the APIs on our support site.
GET USER PROFILE
Description:
Get the current logged in user’s profile.
Role required:
Any authenticated user can access their profile
Request URL:
Sample Response JSON:
{
“success”: true,
“username”: “rahul”,
“firstname”: “Rahul”,
“lastname”: “Bhargava”,
“email”: “rahul@evolphin.com”,
“fullname”: “Rahul Bhargava”,
“rate”: 0,
“projectlist”: “Project With Jobs, Shared-Project, Perich, Job 7.2, FAAC, Job 7.1 Retail Chain Ad, Job 8.1, defproj”,
“password”: “rahul”,
“note”: “”,
“allowProfileEdit”: true
}
GET USER ACCOUNT LIST
Description:
List all user profiles. Some filtering can be done through the control of request parameters, such as getting users starting from a specific list index, limiting the number of users in the response, and, getting only those users whose usernames start with the specified letters.
Request URL:
Form Request Data
start: <index in user table>
limit: <number of users to return>
query: <prefix string – to get only those users whose usernames start with the given prefix string, if any>
onlyName: <true – if only user name fields requested: displayname, username, lastname, firstname>
Sample Response JSON:
{
“success”: true,
“nentries”: “12”,
“entries”: [
{
“username”: “gary”,
“lastname”: “Harr”,
“firstname”: “Gary”,
“email”: “”,
“password”: “gary.harr982”,
“note”: “”,
“rate”: “0”
},
{
“username”: “min”,
“lastname”: “Min”,
“firstname”: “Min”,
“email”: “”,
“password”: “min”,
“note”: “”,
“rate”: “0”
},
……………..
}
ADD OR MODIFY USER PROFILE
Description:
Add a new user or edit the user’s profile of the specified user
Request URL:
Add user:
http://zoom-server-address:8443/jsp/users/modifyuserform.jsp
Edit user:
http://zoom-server-address:8443/jsp/users/modifyuserform.jsp?edit=true&username=<user id>
Form Request Data:
lastname:Cathy
firstname:Batee
password:cathy
cpassword:cathy
email:batee.cathy@evolphin.com
rate:0
note:
Sample Response JSON:
{
“success”: “true”,
“info”: “User account updated!”
}
DELETE USER ACCOUNTS
Description:
Delete the user accounts for the specified list of usernames. The response contains the list of user accounts, after the deletion has been performed. The request parameters for getting the user account list can be specified additionally, to control the response user list, as described above.
Request URL:
Form Request Data
delData: <list of usernames to be deleted, if any>
LIST AVAILABLE ROLES
Description:
List roles already setup in the Zoom server for managing permissions
Request URL:
Sample Response JSON:
[
},
{
},
},
{