SQL Server / Zoom API / List roles
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.zoom.us/v2/roles', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- 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
DECLARE @id nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @description nvarchar(4000)
DECLARE @total_members int
DECLARE @total_records int
EXEC sp_OAMethod @jResp, 'IntOf', @total_records OUT, 'total_records'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'roles'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'roles[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'roles[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'roles[i].description'
EXEC sp_OAMethod @jResp, 'IntOf', @total_members OUT, 'roles[i].total_members'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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": ""
}
]
}
