Chilkat Online Tools

DataFlex / Zoom API / List roles

Back to Collection Items

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sId
    String sName
    String sDescription
    Integer iTotal_members
    Integer iTotal_records
    Integer i
    Integer iCount_i
    String sTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // Adds the "Authorization: Bearer <access_token>" header.
    Set ComAuthToken Of hoHttp To "<access_token>"

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComQuickGetSb Of hoHttp "https://api.zoom.us/v2/roles" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComLastStatus Of hoHttp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComLastHeader Of hoHttp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_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

    Get ComIntOf Of hoJResp "total_records" To iTotal_records
    Move 0 To i
    Get ComSizeOfArray Of hoJResp "roles" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "roles[i].id" To sId
        Get ComStringOf Of hoJResp "roles[i].name" To sName
        Get ComStringOf Of hoJResp "roles[i].description" To sDescription
        Get ComIntOf Of hoJResp "roles[i].total_members" To iTotal_members
        Move (i + 1) To i
    Loop



End_Procedure

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