ID: 1866

Zoom User Administration API

These APIs are invoked on the Zoom Web Administration server. Default TCP port: 8443. 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 send 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.

Description:

Get the current logged in user’s profile.

Role required:

Any authenticated user can access their profile

Request URL:

http://zoom-server-address:8443/jsp/login/getuser.jsp?fullprofile=true|false

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:

http://zoom-server-address:8443/jsp/users/usr-json.jsp

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”

        },

    ……………..

}

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!”

}

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:

http://zoom-server-address:8443/jsp/users/usr-json.jsp

Form Request Data

delData: <list of usernames to be deleted, if any>

Description:

List roles already setup in the Zoom server for managing permissions

Request URL:

http://zoom-server-address:8443/jsp/security/rolelist-json.jsp

Sample Response JSON:

[

{
id: "developerdesigner",
project: "*",
note: "Developer / Designer",
perm: "CONTRIBUTE",
uiProvider: "col",
iconCls: "icon-role-list",
qtip: "Can read all project items and add new items",
projEditable: true

},

{

id: "webapprover",
project: "*",
note: "Zoom Default Web Approver",
perm: "REVIEW",
uiProvider: "col",
iconCls: "icon-role-wa",
qtip: "Can read those project items that have been marked for review",
projEditable: true

},

{
id: "reader",
project: "*",
note: "Reader",
perm: "READ",
uiProvider: "col",
iconCls: "icon-role-list",
qtip: "Can read all project items",
projEditable: true

},

{

id: "projectadmin",
project: "*",
note: "Project Admin",
perm: "EDIT_ALL",
uiProvider: "col",
iconCls: "icon-role-list",
qtip: "Can read/write/delete all items",
projEditable: true
},
...
]