delphiDll / Zoom API / Assign a role
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
req: HCkHttpRequest;
jsonFormData1: HCkJsonArray;
jsonObj_1: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
ids: PWideChar;
add_at: PWideChar;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
req := CkHttpRequest_Create();
CkHttpRequest_putHttpVerb(req,'POST');
CkHttpRequest_putPath(req,'/v2/roles/:roleId/members');
CkHttpRequest_putContentType(req,'multipart/form-data');
jsonFormData1 := CkJsonArray_Create();
CkJsonArray_AddObjectAt(jsonFormData1,-1);
jsonObj_1 := CkJsonArray_ObjectAt(jsonFormData1,CkJsonArray_getSize(jsonFormData1) - 1);
CkJsonObject_UpdateString(jsonObj_1,'id','laboris mollit do quis anim');
CkJsonObject_UpdateString(jsonObj_1,'email','9t7JYT@NQHyqsJCrzyPoITCOEvXbTD.tcx');
CkJsonObject_Dispose(jsonObj_1);
CkJsonArray_AddObjectAt(jsonFormData1,-1);
jsonObj_1 := CkJsonArray_ObjectAt(jsonFormData1,CkJsonArray_getSize(jsonFormData1) - 1);
CkJsonObject_UpdateString(jsonObj_1,'id','Ut consectetur pariatur commodo');
CkJsonObject_UpdateString(jsonObj_1,'email','cul@eZgh.bjh');
CkJsonObject_Dispose(jsonObj_1);
CkHttpRequest_AddStringForUpload2(req,'members','',jsonFormData1,'utf-8','application/json');
CkHttpRequest_AddHeader(req,'Authorization','Bearer <access_token>');
resp := CkHttp_SynchronousRequest(http,'api.zoom.us',443,True,req);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// 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 := CkJsonObject__stringOf(jResp,'ids');
add_at := CkJsonObject__stringOf(jResp,'add_at');
CkHttp_Dispose(http);
CkHttpRequest_Dispose(req);
CkJsonArray_Dispose(jsonFormData1);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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": ""
}
]
}
