DataFlex / Zoom API / Create a role
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vReq
Handle hoReq
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sTemp1
Boolean bTemp1
// 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
Get Create (RefClass(cComChilkatHttpRequest)) To hoReq
If (Not(IsComObjectCreated(hoReq))) Begin
Send CreateComObject of hoReq
End
Set ComHttpVerb Of hoReq To "POST"
Set ComPath Of hoReq To "/v2/roles"
Set ComContentType Of hoReq To "multipart/form-data"
Send ComAddParam To hoReq "do ut" ""
Send ComAddParam To hoReq "description" "do utin"
Send ComAddParam To hoReq "privileges" 'do utin["Ut consectetur id","fugiat in non"]'
Send ComAddHeader To hoReq "Authorization" "Bearer <access_token>"
Get pvComObject of hoReq to vReq
Get ComSynchronousRequest Of hoHttp "api.zoom.us" 443 True vReq To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
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 ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
End_Procedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'name=do ut'
--form 'description=do utin'
--form 'privileges=do utin["Ut consectetur id","fugiat in non"]'
https://api.zoom.us/v2/roles
Postman Collection Item JSON
{
"name": "Create a role",
"request": {
"auth": {
"type": "oauth2"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "do ut",
"description": "Name of the role.",
"type": "text"
},
{
"key": "description",
"value": "in",
"description": "Description of the role.",
"type": "text"
},
{
"key": "privileges",
"value": "[\"Ut consectetur id\",\"fugiat in non\"]",
"description": "Privileges assigned to the role. Can be one or a combination of [these permissions](https://marketplace.zoom.us/docs/api-reference/other-references/privileges).",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"roles"
]
},
"description": "Each Zoom user automatically has a role which can either be owner, administrator, or a member. \n\n**Pre-requisite:**<br>\n* Pro or higher plan.\n* For setting the initial role, you must be the Account Owner.<br>\n* For subsequent role management, you must be the Account Owner or user with role management permissions.<br>\n**Scopes:** `role:write: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>\nYou do not have the permission to create a role.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "ea nostrud",
"description": "Name of the role.",
"type": "text"
},
{
"key": "description",
"value": "pariatur fugiat",
"description": "Description of the role.",
"type": "text"
},
{
"key": "privileges",
"value": "[\"aliq\",\"Duis nostrud exercitation irure dolore\"]",
"description": "Privileges assigned to the role. Can be one or a combination of [these permissions](https://marketplace.zoom.us/docs/api-reference/other-references/privileges).",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"roles"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{}"
},
{
"name": "**Status Code:** `201`<br>\nRole created.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "ea nostrud",
"description": "Name of the role.",
"type": "text"
},
{
"key": "description",
"value": "pariatur fugiat",
"description": "Description of the role.",
"type": "text"
},
{
"key": "privileges",
"value": "[\"aliq\",\"Duis nostrud exercitation irure dolore\"]",
"description": "Privileges assigned to the role. Can be one or a combination of [these permissions](https://marketplace.zoom.us/docs/api-reference/other-references/privileges).",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"roles"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": \"esse qui Lorem voluptate\",\n \"name\": \"nostrud laboris\",\n \"description\": \"cillum ipsum\",\n \"total_members\": 28079344,\n \"privileges\": [\n \"elit\",\n \"sint culpa cillum\"\n ]\n}"
},
{
"name": "**Error Code:** `300`<br>\nThe name field cannot be empty.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "ea nostrud",
"description": "Name of the role.",
"type": "text"
},
{
"key": "description",
"value": "pariatur fugiat",
"description": "Description of the role.",
"type": "text"
},
{
"key": "privileges",
"value": "[\"aliq\",\"Duis nostrud exercitation irure dolore\"]",
"description": "Privileges assigned to the role. Can be one or a combination of [these permissions](https://marketplace.zoom.us/docs/api-reference/other-references/privileges).",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/roles",
"host": [
"{{baseUrl}}"
],
"path": [
"roles"
]
}
},
"status": "Multiple Choices",
"code": 300,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
