TCL / Zoom API / List roles
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://api.zoom.us/v2/roles" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "total_records": 3,
# "roles": [
# {
# "id": "0",
# "name": "Owner",
# "description": "Account owner has full privileges to access and manage a Zoom account.",
# "total_members": 1
# },
# {
# "id": "1",
# "name": "Admin",
# "description": "Admins have wide range privileges to access and manage a Zoom account.",
# "total_members": 0
# },
# {
# "id": "2",
# "name": "Member",
# "description": "Members have access to basic Zoom video meeting functions but no account management privileges.",
# "total_members": 1
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set total_records [CkJsonObject_IntOf $jResp "total_records"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "roles"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_stringOf $jResp "roles[i].id"]
set name [CkJsonObject_stringOf $jResp "roles[i].name"]
set description [CkJsonObject_stringOf $jResp "roles[i].description"]
set total_members [CkJsonObject_IntOf $jResp "roles[i].total_members"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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": ""
}
]
}