Chilkat Online Tools

lianja / Zoom API / Get role information

Back to Collection Items

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

loHttp = createobject("CkHttp")

// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://api.zoom.us/v2/roles/:roleId",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "id": "in fugiat ad magna irure",
//   "name": "deserunt pariatur Duis",
//   "description": "dolor minim commodo non laborum",
//   "total_members": 28969635,
//   "privileges": [
//     "eiusmod dolor",
//     "qui occaecat"
//   ],
//   "sub_account_privileges": {
//     "second_level": -33281927
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

lcId = loJResp.StringOf("id")
lcName = loJResp.StringOf("name")
lcDescription = loJResp.StringOf("description")
lnTotal_members = loJResp.IntOf("total_members")
lnSecond_level = loJResp.IntOf("sub_account_privileges.second_level")
i = 0
lnCount_i = loJResp.SizeOfArray("privileges")
do while i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("privileges[i]")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/roles/:roleId

Postman Collection Item JSON

{
  "name": "Get role information",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/roles/:roleId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "roles",
        ":roleId"
      ],
      "variable": [
        {
          "key": "roleId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) Role Id. "
        }
      ]
    },
    "description": "Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list of privileges.\n\nUse this API to get information including specific privileges assigned to a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control).<br>\n**Pre-requisite:**<br>\n* A Pro or higher plan.<br>\n* For role management and updates, you must be the Account Owner or user with role management permissions.\n\n**Scopes:** `role:read:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
  },
  "response": [
    {
      "name": "**Status Code:** `200`<br>\nInformation about a specific role returned.\n\n**Error Code:** `200`<br>\nYou do not have the permission to retrieve role information.\n",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/roles/:roleId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "roles",
            ":roleId"
          ],
          "variable": [
            {
              "key": "roleId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Role Id. "
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"id\": \"in fugiat ad magna irure\",\n \"name\": \"deserunt pariatur Duis\",\n \"description\": \"dolor minim commodo non laborum\",\n \"total_members\": 28969635,\n \"privileges\": [\n  \"eiusmod dolor\",\n  \"qui occaecat\"\n ],\n \"sub_account_privileges\": {\n  \"second_level\": -33281927\n }\n}"
    },
    {
      "name": "**Error Code:** `300`<br>\nRole not found.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/roles/:roleId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "roles",
            ":roleId"
          ],
          "variable": [
            {
              "key": "roleId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Role Id. "
            }
          ]
        }
      },
      "status": "Multiple Choices",
      "code": 300,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}