Chilkat Online Tools

VB6 / Zoom API / List roles

Back to Collection Items

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New ChilkatHttp
Dim success As Long

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://api.zoom.us/v2/roles",sbResponseBody)
If (success = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

' 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

Dim id As String
Dim name As String
Dim description As String
Dim total_members As Long

Dim total_records As Long
total_records = jResp.IntOf("total_records")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("roles")
Do While i < count_i
    jResp.I = i
    id = jResp.StringOf("roles[i].id")
    name = jResp.StringOf("roles[i].name")
    description = jResp.StringOf("roles[i].description")
    total_members = jResp.IntOf("roles[i].total_members")
    i = i + 1
Loop

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": ""
    }
  ]
}