Chilkat Online Tools

Powershell / Zoom API / Assign a role

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

$req = New-Object Chilkat.HttpRequest
$req.HttpVerb = "POST"
$req.Path = "/v2/roles/:roleId/members"
$req.ContentType = "multipart/form-data"

$jsonFormData1 = New-Object Chilkat.JsonArray

$jsonFormData1.AddObjectAt(-1)
$jsonObj_1 = $jsonFormData1.ObjectAt($jsonFormData1.Size - 1)
$jsonObj_1.UpdateString("id","laboris mollit do quis anim")
$jsonObj_1.UpdateString("email","9t7JYT@NQHyqsJCrzyPoITCOEvXbTD.tcx")

$jsonFormData1.AddObjectAt(-1)
$jsonObj_1 = $jsonFormData1.ObjectAt($jsonFormData1.Size - 1)
$jsonObj_1.UpdateString("id","Ut consectetur pariatur commodo")
$jsonObj_1.UpdateString("email","cul@eZgh.bjh")

$req.AddParam("members",$jsonFormData1.Emit())

$req.AddHeader("Authorization","Bearer <access_token>")

$resp = $http.SynchronousRequest("api.zoom.us",443,$true,$req)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")

    exit
}

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

# {
#   "ids": "elit enim",
#   "add_at": "1986-11-30T15:13:03.662Z"
# }

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

$ids = $jResp.StringOf("ids")
$add_at = $jResp.StringOf("add_at")

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: multipart/form-data"
	--form 'members=[{"id":"laboris mollit do quis anim","email":"9t7JYT@NQHyqsJCrzyPoITCOEvXbTD.tcx"},{"id":"Ut consectetur pariatur commodo","email":"cul@eZgh.bjh"}]'
https://api.zoom.us/v2/roles/:roleId/members

Postman Collection Item JSON

{
  "name": "Assign a role",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "members",
          "value": "[{\"id\":\"laboris mollit do quis anim\",\"email\":\"9t7JYT@NQHyqsJCrzyPoITCOEvXbTD.tcx\"},{\"id\":\"Ut consectetur pariatur commodo\",\"email\":\"cul@eZgh.bjh\"}]",
          "description": "Array of userId/user email of users to whom you would like to assign this role. Upto 30 users can be assigned a role at once.",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{baseUrl}}/roles/:roleId/members",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "roles",
        ":roleId",
        "members"
      ],
      "variable": [
        {
          "key": "roleId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The role ID"
        }
      ]
    },
    "description": "User [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to [assign a role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control#h_748b6fd8-5057-4cf4-bbfd-787909c09db0) to members.\n\n**Scopes:** `role:write:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br>\n**Prerequisites:**<br>\n* A Pro or a higher plan."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `201`<br>Members Added",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "members",
              "value": "[{\"id\":\"laboris mollit do quis anim\",\"email\":\"9t7JYT@NQHyqsJCrzyPoITCOEvXbTD.tcx\"},{\"id\":\"Ut consectetur pariatur commodo\",\"email\":\"cul@eZgh.bjh\"}]",
              "description": "Array of userId/user email of users to whom you would like to assign this role. Upto 30 users can be assigned a role at once.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/roles/:roleId/members",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "roles",
            ":roleId",
            "members"
          ],
          "variable": [
            {
              "key": "roleId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The role ID"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Location",
          "value": "quis officia in reprehenderit",
          "description": "Location of created members"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"ids\": \"elit enim\",\n \"add_at\": \"1986-11-30T15:13:03.662Z\"\n}"
    },
    {
      "name": "**HTTP Status Code:** `400`<br>\n\n**Error Code:** `1034`\nRole does not exist.<br><br>\n**Error Code:** `300`<br>\nRoleId required.<br>\nCan’t delete or add members for Normal/Owner roles.<br><br>",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "members",
              "value": "[{\"id\":\"laboris mollit do quis anim\",\"email\":\"9t7JYT@NQHyqsJCrzyPoITCOEvXbTD.tcx\"},{\"id\":\"Ut consectetur pariatur commodo\",\"email\":\"cul@eZgh.bjh\"}]",
              "description": "Array of userId/user email of users to whom you would like to assign this role. Upto 30 users can be assigned a role at once.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/roles/:roleId/members",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "roles",
            ":roleId",
            "members"
          ],
          "variable": [
            {
              "key": "roleId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The role ID"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}