Objective-C / Zoom API / Assign a role
Back to Collection Items
#import <CkoHttp.h>
#import <CkoHttpRequest.h>
#import <CkoJsonArray.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
CkoHttpRequest *req = [[CkoHttpRequest alloc] init];
req.HttpVerb = @"POST";
req.Path = @"/v2/roles/:roleId/members";
req.ContentType = @"multipart/form-data";
CkoJsonArray *jsonFormData1 = [[CkoJsonArray alloc] init];
[jsonFormData1 AddObjectAt: [NSNumber numberWithInt: -1]];
CkoJsonObject *jsonObj_1 = [jsonFormData1 ObjectAt: [NSNumber numberWithInt: ([jsonFormData1.Size intValue] - 1)]];
[jsonObj_1 UpdateString: @"id" value: @"laboris mollit do quis anim"];
[jsonObj_1 UpdateString: @"email" value: @"9t7JYT@NQHyqsJCrzyPoITCOEvXbTD.tcx"];
[jsonFormData1 AddObjectAt: [NSNumber numberWithInt: -1]];
jsonObj_1 = [jsonFormData1 ObjectAt: [NSNumber numberWithInt: ([jsonFormData1.Size intValue] - 1)]];
[jsonObj_1 UpdateString: @"id" value: @"Ut consectetur pariatur commodo"];
[jsonObj_1 UpdateString: @"email" value: @"cul@eZgh.bjh"];
[req AddParam: @"members" value: [jsonFormData1 Emit]];
[req AddHeader: @"Authorization" value: @"Bearer <access_token>"];
CkoHttpResponse *resp = [http SynchronousRequest: @"api.zoom.us" port: [NSNumber numberWithInt: 443] ssl: YES req: req];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// 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
NSString *ids = [jResp StringOf: @"ids"];
NSString *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": ""
}
]
}
