Unicode C++ / Zoom API / List roles
Back to Collection Items
void ChilkatSample(void)
{
http.put_AuthToken(L"<access_token>"); success = http.QuickGetSb(L"https://api.zoom.us/v2/roles",sbResponseBody); jResp.LoadSb(sbResponseBody); jResp.put_EmitCompact(false); jResp.put_I(i); id = jResp.stringOf(L"roles[i].id"); name = jResp.stringOf(L"roles[i].name"); description = jResp.stringOf(L"roles[i].description"); total_members = jResp.IntOf(L"roles[i].total_members"); i = i + 1;
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/roles
Postman Collection Item JSON
{
"name": "List roles",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"roles"
]
},
"description": "List [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) on your account\n\n**Scopes:** `role:read:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br>\n**Prerequisites** :\n* Pro or higher plan. \n* For setting the initial role, you must be the Account Owner. \n* For subsequent role management, you must be the Account Owner or user with role management permissions."
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nList of roles returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"roles"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"total_records\": 3,\n \"roles\": [\n {\n \"id\": \"0\",\n \"name\": \"Owner\",\n \"description\": \"Account owner has full privileges to access and manage a Zoom account.\",\n \"total_members\": 1\n },\n {\n \"id\": \"1\",\n \"name\": \"Admin\",\n \"description\": \"Admins have wide range privileges to access and manage a Zoom account.\",\n \"total_members\": 0\n },\n {\n \"id\": \"2\",\n \"name\": \"Member\",\n \"description\": \"Members have access to basic Zoom video meeting functions but no account management privileges.\",\n \"total_members\": 1\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400`<br>\nBad request<br>**Error Code:** `4700`<br>Invalid access token, does not contain role:read:admin scope.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"roles"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}