phpAx / Zoom API / Get user permissions
Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://api.zoom.us/v2/users/:userId/permissions',$sbResponseBody);
if ($success == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $http->LastHeader . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "permissions": [
// "IMGroups:Edit",
// "Security:Edit",
// "IMGroups:Read",
// "BillingSubscription:Edit",
// "SingleSignOn:Edit",
// "WebinarSetting:Edit",
// "Branding:Read",
// "UsageReport:Read",
// "BillingSubscription:Read",
// "CrossHybrid:Read",
// "UserActivitiesReport:Read",
// "Branding:Edit",
// "SingleSignOn:Read",
// "Security:Read",
// "Dashboard:Read",
// "AccountProfile:Read",
// "MarketPlace:Edit",
// "ZoomRooms:Edit",
// "PbxAdmin:Read",
// "Meeting:Edit",
// "IMChatHistory:Read",
// "RoomConnector:Read",
// "IMChatBot:Edit",
// "CrossHybrid:Edit",
// "AccountProfile:Edit",
// "RoomConnector:Edit",
// "Group:Edit",
// "BillingInformation:Edit",
// "LyncConnector:Edit",
// "LyncConnector:Read",
// "Integration:Read",
// "User:Edit",
// "BillingInformation:Read",
// "AccountSetting:Edit",
// "SubAccount:Read",
// "IMSetting:Read",
// "MeetingConnector:Read",
// "ThirdPartyConference:Read",
// "Meeting:Join",
// "CallInContacts:Read",
// "ZoomDevelopers:Read",
// "Recording:Read",
// "Role:Edit",
// "Recording:Edit",
// "DigitalSignage:Read",
// "ScheduleTrackingFields:Read",
// "ThirdPartyConference:Edit",
// "Group:Read",
// "AccountSetting:Read",
// "MeetingConnector:Edit",
// "Integration:Edit",
// "CallInContacts:Edit",
// "DigitalSignage:Edit",
// "MarketPlace:Read",
// "PbxAdmin:Edit",
// "ZoomRooms:Read",
// "MobileDeviceManagement:Read",
// "RecordingContent:Read",
// "User:Read",
// "ScheduleTrackingFields:Edit",
// "WebinarSetting:Read"
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$i = 0;
$count_i = $jResp->SizeOfArray('permissions');
while ($i < $count_i) {
$jResp->I = $i;
$strVal = $jResp->stringOf('permissions[i]');
$i = $i + 1;
}
?>
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/users/:userId/permissions
Postman Collection Item JSON
{
"name": "Get user permissions",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/users/:userId/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"permissions"
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
},
"description": "Use this API to get permissions that have been granted to the user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\nUsers can be assigned a set of permissions that allows them to access only the pages/information that a user needs to view or edit.\n\n**Scopes:** `user:read:admin`, `user:read`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nUser permissions returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"permissions"
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"permissions\": [\n \"IMGroups:Edit\",\n \"Security:Edit\",\n \"IMGroups:Read\",\n \"BillingSubscription:Edit\",\n \"SingleSignOn:Edit\",\n \"WebinarSetting:Edit\",\n \"Branding:Read\",\n \"UsageReport:Read\",\n \"BillingSubscription:Read\",\n \"CrossHybrid:Read\",\n \"UserActivitiesReport:Read\",\n \"Branding:Edit\",\n \"SingleSignOn:Read\",\n \"Security:Read\",\n \"Dashboard:Read\",\n \"AccountProfile:Read\",\n \"MarketPlace:Edit\",\n \"ZoomRooms:Edit\",\n \"PbxAdmin:Read\",\n \"Meeting:Edit\",\n \"IMChatHistory:Read\",\n \"RoomConnector:Read\",\n \"IMChatBot:Edit\",\n \"CrossHybrid:Edit\",\n \"AccountProfile:Edit\",\n \"RoomConnector:Edit\",\n \"Group:Edit\",\n \"BillingInformation:Edit\",\n \"LyncConnector:Edit\",\n \"LyncConnector:Read\",\n \"Integration:Read\",\n \"User:Edit\",\n \"BillingInformation:Read\",\n \"AccountSetting:Edit\",\n \"SubAccount:Read\",\n \"IMSetting:Read\",\n \"MeetingConnector:Read\",\n \"ThirdPartyConference:Read\",\n \"Meeting:Join\",\n \"CallInContacts:Read\",\n \"ZoomDevelopers:Read\",\n \"Recording:Read\",\n \"Role:Edit\",\n \"Recording:Edit\",\n \"DigitalSignage:Read\",\n \"ScheduleTrackingFields:Read\",\n \"ThirdPartyConference:Edit\",\n \"Group:Read\",\n \"AccountSetting:Read\",\n \"MeetingConnector:Edit\",\n \"Integration:Edit\",\n \"CallInContacts:Edit\",\n \"DigitalSignage:Edit\",\n \"MarketPlace:Read\",\n \"PbxAdmin:Edit\",\n \"ZoomRooms:Read\",\n \"MobileDeviceManagement:Read\",\n \"RecordingContent:Read\",\n \"User:Read\",\n \"ScheduleTrackingFields:Edit\",\n \"WebinarSetting:Read\"\n ]\n}"
},
{
"name": "**HTTP Status Code:** `404` **Not Found**<br><br>\n**Error Code:** `1001`<br>\nUser does not exist: $userId.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"permissions"
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
