{ "info": { "_postman_id": "beba6b1c-a834-f8a3-951c-29678666d198", "name": "Webex Admin API", "description": "Cisco Webex includes administration APIs that allow administrators to perform actions such as provisioning a user and managing devices. \n\nBy automating administration, user management and provisioning can be centralized in an existing tool, rather than using the Webex Control Hub. For example, a partner selling multiple Collaboration tools to customers can use these APIs to enable Webex Teams provisioning through a centralized portal.\n\n## What's possible with Admin APIs?\n\nCurrently, administration is focused on User Provisioning. Using these APIs, an admin can:\n\n- Create a user\n- Update a user\n- View license usage of an organization\n- View available roles of an organization\n- Manage Hybrid Services licenses and users\n\nMore information available at:\nhttps://developer.webex.com/docs/api/guides/admin-api\n", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "AdminAudit Events", "item": [ { "name": "List Organizations", "event": [ { "listen": "test", "script": { "id": "03ef7ae1-9057-42ce-8ff2-e807b1acf159", "exec": [ "if (responseCode.code != 200) {", " tests[\"List organizations : failed\"] = false;", "}", "else {", " tests[\"List organizations: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.items === undefined) {", " tests[\"List organizations: cannot retreive result\"] = false", " }", " else {", " var orgId = jsonData.items[0].id;", " postman.setEnvironmentVariable(\"_organization\", orgId);", " tests[\"List organizations: retreived one with id:\" + orgId] = true", " }", "}" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/organizations", "host": [ "{{WEBEXAPI}}" ], "path": [ "organizations" ] }, "description": "List all organizations visible by your account.\n\nhttps://developer.webex.com/endpoint-organizations-get.html\n\nExample Response:\n``` json\n{\n 'items' : [ {\n 'id' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\n 'displayName' : 'Acme, Inc.',\n 'created' : '2015-10-18T14:26:16+00:00'\n } ]\n}\n```" }, "response": [] }, { "name": "List Admin Audit Events", "event": [ { "listen": "test", "script": { "id": "ba7a72b3-768b-47ef-a821-076162ef34c3", "exec": [ "if (responseCode.code != 200) {", " tests[\"List devices : failed\"] = false;", "}", "else {", " tests[\"List devices: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.items === undefined) {", " tests[\"List devices: cannot retreive result\"] = false", " }", " else {", " var deviceId = jsonData.items[0].id;", " postman.setEnvironmentVariable(\"_device\", deviceId);", " tests[\"List devices: retreived one device with id:\" + deviceId] = true", " }", "}", "" ], "type": "text/javascript" } }, { "listen": "prerequest", "script": { "id": "67190aaf-64ee-4f4e-a637-35497c28ed40", "exec": [ "var now = new Date(Date.now());", "postman.setEnvironmentVariable(\"_now\", now.toISOString());", "", "var yesterday = now;", "yesterday.setHours(now.getHours()-24);", "postman.setEnvironmentVariable(\"_yesterday\", yesterday.toISOString());" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/adminAudit/events?orgId={{_organization}}&from={{_yesterday}}&to={{_now}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "adminAudit", "events" ], "query": [ { "key": "orgId", "value": "{{_organization}}" }, { "key": "from", "value": "{{_yesterday}}" }, { "key": "to", "value": "{{_now}}" } ] }, "description": "List admin audit events in your organization. Several query parameters are available to filter the response.\r\n\r\nLong result sets will be split into pages.\r\n\r\nhttps://developer.webex.com/docs/api/v1/admin-audit-events/list-admin-audit-events" }, "response": [] }, { "name": "List Admin Audit Events (max)", "event": [ { "listen": "test", "script": { "id": "ba7a72b3-768b-47ef-a821-076162ef34c3", "exec": [ "if (responseCode.code != 200) {", " tests[\"List devices : failed\"] = false;", "}", "else {", " tests[\"List devices: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.items === undefined) {", " tests[\"List devices: cannot retreive result\"] = false", " }", " else {", " var deviceId = jsonData.items[0].id;", " postman.setEnvironmentVariable(\"_device\", deviceId);", " tests[\"List devices: retreived one device with id:\" + deviceId] = true", " }", "}", "" ], "type": "text/javascript" } }, { "listen": "prerequest", "script": { "id": "67190aaf-64ee-4f4e-a637-35497c28ed40", "exec": [ "var now = new Date(Date.now());", "postman.setEnvironmentVariable(\"_now\", now.toISOString());", "", "var yesterday = now;", "yesterday.setHours(now.getHours()-24);", "postman.setEnvironmentVariable(\"_yesterday\", yesterday.toISOString());" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/adminAudit/events?orgId={{_organization}}&from={{_yesterday}}&to={{_now}}&max=5", "host": [ "{{WEBEXAPI}}" ], "path": [ "adminAudit", "events" ], "query": [ { "key": "orgId", "value": "{{_organization}}" }, { "key": "from", "value": "{{_yesterday}}" }, { "key": "to", "value": "{{_now}}" }, { "key": "max", "value": "5" } ] }, "description": "List admin audit events in your organization. Several query parameters are available to filter the response.\r\n\r\nLong result sets will be split into pages.\r\n\r\nhttps://developer.webex.com/docs/api/v1/admin-audit-events/list-admin-audit-events" }, "response": [] } ], "description": "Admin Audit Events are available to full administrators for certain events performed in Webex Control Hub.\r\n\r\nAdministrators with accounts created before 2019 will need to log into Webex Control Hub before using this API.\r\n\r\nhttps://developer.webex.com/docs/api/v1/admin-audit-events\r\n", "event": [ { "listen": "prerequest", "script": { "id": "9a9d749e-1bc2-419c-9048-9879fda6a8fd", "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "id": "af2980bf-9922-47ed-a092-e594300f5dd4", "type": "text/javascript", "exec": [ "" ] } } ], "protocolProfileBehavior": {} }, { "name": "DeviceConfigurations", "item": [ { "name": "List Devices", "event": [ { "listen": "test", "script": { "id": "176d227b-7a46-4752-b30a-aea11a55e078", "exec": [ "", "if (responseCode.code != 200) {", " tests[\"List devices : failed\"] = false;", "}", "else {", " tests[\"List devices: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.items === undefined) {", " tests[\"List devices: cannot retreive result\"] = false", " }", " else {", " var deviceId = jsonData.items[0].id;", " postman.setEnvironmentVariable(\"_device\", deviceId);", " tests[\"List devices: retreived one device with id:\" + deviceId] = true", "", " visualize(jsonData.items);", " }", "}", "", "function visualize(devices) {", " ", " // Configure the template", " var template = `", " ", "", " ", "", " `;", "", " // Set the visualizer template", " pm.visualizer.set(template, { ", " labels: [ ", " \"count\", ", " \"connected\", ", " \"connected_with_issues\", ", " \"disconnected\"],", " data: [ ", " devices.length, ", " devices.filter((device) => { return (device.connectionStatus === \"connected\") }).length,", " devices.filter((device) => { return (device.connectionStatus === \"connected_with_issues\") }).length,", " devices.filter((device) => { return (device.connectionStatus === \"disconnected\") }).length]", " });", "}", "", "", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/devices", "host": [ "{{WEBEXAPI}}" ], "path": [ "devices" ] }, "description": "Lists all active Webex devices associated with the authenticated user, such as devices activated in personal mode, or devices to which the user is actively paired or using. Administrators can list all devices within an organization.\n\nhttps://developer.webex.com/docs/api/v1/devices/list-devices" }, "response": [] }, { "name": "Get Device Details", "event": [ { "listen": "test", "script": { "id": "f4c489f2-1daa-4550-9e86-658da0352dce", "exec": [ "if (responseCode.code != 200) {", " tests[\"Get device details: failed\"] = false;", "}", "else {", " tests[\"Get device details: success\"] = true;", "}", "", "", " " ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/devices/{{_device}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "devices", "{{_device}}" ] }, "description": "Shows details for a device, by ID.\r\nSpecify the device ID in the deviceId parameter in the URI.\r\n\r\nhttps://developer.webex.com/docs/api/v1/devices/get-device-details" }, "response": [] }, { "name": "Get Device Configurations Details", "event": [ { "listen": "test", "script": { "id": "a4801557-52db-40da-b000-e12f4b1af230", "exec": [ "if (responseCode.code != 200) {", " tests[\"Get Devices Configurations Details: failed\"] = false;", "}", "else {", " tests[\"Get Devices Configurations Details: success\"] = true;", "}", "", "", " " ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/deviceConfigurations?deviceId={{_device}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "deviceConfigurations" ], "query": [ { "key": "deviceId", "value": "{{_device}}" } ] }, "description": "Lists all device configurations associated with the given device ID. Administrators can list configurations for all devices within an organization.\r\n\r\nhttps://developer.webex.com/docs/api/v1/device-configurations/list-device-configurations-for-device" }, "response": [] }, { "name": "Get Device Configurations Details (with key)", "event": [ { "listen": "test", "script": { "id": "bdeaaa14-116b-48b2-86a0-a531224183bb", "exec": [ "if (responseCode.code != 200) {", " tests[\"Get Devices Configurations Details: failed\"] = false;", "}", "else {", " tests[\"Get Devices Configurations Details: success\"] = true;", "}", "", "", " " ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/deviceConfigurations?deviceId={{_device}}&key=Audio.Ultrasound.*", "host": [ "{{WEBEXAPI}}" ], "path": [ "deviceConfigurations" ], "query": [ { "key": "deviceId", "value": "{{_device}}" }, { "key": "key", "value": "Audio.Ultrasound.*" } ] }, "description": "Lists all device configurations associated with the given device ID. Administrators can list configurations for all devices within an organization.\r\n\r\nhttps://developer.webex.com/docs/api/v1/device-configurations/list-device-configurations-for-device" }, "response": [] }, { "name": "Update Device Configurations", "event": [ { "listen": "test", "script": { "id": "333a7503-0e3b-4a17-a30c-fe5dff927221", "exec": [ "if (responseCode.code != 200) {", " tests[\"Update Device Configurations: failed\"] = false;", "}", "else {", " tests[\"Update Device Configurations: success\"] = true;", "}", "", "", " " ], "type": "text/javascript" } } ], "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json-patch+json", "type": "text" } ], "body": { "mode": "raw", "raw": "[\r\n {\r\n \"op\" : \"replace\",\r\n \"path\" : \"Audio.Ultrasound.MaxVolume/sources/configured/value\",\r\n \"value\" : 70\r\n }\r\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{WEBEXAPI}}/deviceConfigurations?deviceId={{_device}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "deviceConfigurations" ], "query": [ { "key": "deviceId", "value": "{{_device}}" } ] }, "description": "Update device configurations by device ID. Update requests use [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.\r\n\r\nhttps://developer.webex.com/docs/api/v1/device-configurations/update-device-configurations" }, "response": [] } ], "event": [ { "listen": "prerequest", "script": { "id": "76e09291-8dc1-411c-afff-90759a76dbea", "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "id": "a90ac3cc-801b-4f24-a32e-437a3379c5ed", "type": "text/javascript", "exec": [ "" ] } } ], "protocolProfileBehavior": {} }, { "name": "Devices", "item": [ { "name": "List Devices", "event": [ { "listen": "test", "script": { "id": "ba7a72b3-768b-47ef-a821-076162ef34c3", "exec": [ "", "if (responseCode.code != 200) {", " tests[\"List devices : failed\"] = false;", "}", "else {", " tests[\"List devices: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.items === undefined) {", " tests[\"List devices: cannot retreive result\"] = false", " }", " else {", " var deviceId = jsonData.items[0].id;", " postman.setEnvironmentVariable(\"_device\", deviceId);", " tests[\"List devices: retreived one device with id:\" + deviceId] = true", "", " visualize(jsonData.items);", " }", "}", "", "function visualize(devices) {", " ", " // Configure the template", " var template = `", " ", "", " ", "", " `;", "", " // Set the visualizer template", " pm.visualizer.set(template, { ", " labels: [ ", " \"count\", ", " \"connected\", ", " \"connected_with_issues\", ", " \"disconnected\"],", " data: [ ", " devices.length, ", " devices.filter((device) => { return (device.connectionStatus === \"connected\") }).length,", " devices.filter((device) => { return (device.connectionStatus === \"connected_with_issues\") }).length,", " devices.filter((device) => { return (device.connectionStatus === \"disconnected\") }).length]", " });", "}", "", "", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/devices", "host": [ "{{WEBEXAPI}}" ], "path": [ "devices" ] }, "description": "Lists all active Webex devices associated with the authenticated user, such as devices activated in personal mode, or devices to which the user is actively paired or using. Administrators can list all devices within an organization.\n\nhttps://developer.webex.com/docs/api/v1/devices/list-devices" }, "response": [] }, { "name": "Get Device Details", "event": [ { "listen": "test", "script": { "id": "ba7a72b3-768b-47ef-a821-076162ef34c3", "exec": [ "if (responseCode.code != 200) {", " tests[\"Get device details: failed\"] = false;", "}", "else {", " tests[\"Get device details: success\"] = true;", "}", "", "", " " ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/devices/{{_device}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "devices", "{{_device}}" ] }, "description": "Shows details for a device, by ID.\r\nSpecify the device ID in the deviceId parameter in the URI.\r\n\r\nhttps://developer.webex.com/docs/api/v1/devices/get-device-details" }, "response": [] }, { "name": "Delete a Device", "event": [ { "listen": "test", "script": { "id": "ba7a72b3-768b-47ef-a821-076162ef34c3", "exec": [ "if (responseCode.code != 204) {", " tests[\"Delete device: failed\"] = false;", "}", "else {", " tests[\"Delete device: success\"] = true;", "}" ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/devices/{{_device}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "devices", "{{_device}}" ] }, "description": "Deletes a device, by ID.\r\nSpecify the device ID in the deviceId parameter in the URI.\r\n\r\nhttps://developer.webex.com/docs/api/v1/devices/delete-a-device" }, "response": [] } ], "description": "Devices represent cloud-registered Webex RoomOS devices, as well as actively-connected Webex soft clients on mobile or desktop. Devices may be associated with Places.\r\n\r\nSearching and viewing details for your devices requires an auth token with the spark:devices_read scope. Updating or deleting your devices requires an auth token with the spark:devices_write scope. Viewing the list of all devices in an organization requires an administrator auth token with the spark-admin:devices_read scope. Adding, updating, or deleting all devices in an organization requires an administrator auth token with the spark-admin:devices_write scope.\r\n\r\nhttps://developer.webex.com/docs/api/v1/devices", "event": [ { "listen": "prerequest", "script": { "id": "88297cc6-7660-4dd4-b6c1-c24df125a102", "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "id": "6f19bcb6-6a75-4f6c-a8fe-2cfc52a7a319", "type": "text/javascript", "exec": [ "" ] } } ], "protocolProfileBehavior": {} }, { "name": "Events", "item": [ { "name": "List Events", "event": [ { "listen": "test", "script": { "id": "395bcbd0-de24-4e34-9bdf-839f203a4a7f", "exec": [ "if (responseCode.code != 200) {", " tests[\"List events: failed\"] = false;", "}", "else {", " tests[\"List events: success\"] = true;", "}" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/events?max=10", "host": [ "{{WEBEXAPI}}" ], "path": [ "events" ], "query": [ { "key": "max", "value": "10" } ] }, "description": "List events in your organization. Several query parameters are available to filter the response.\nLong result sets will be split into pages.\n\nhttps://developer.webex.com/endpoint-events-get.html" }, "response": [] }, { "name": "List Events (new messages)", "event": [ { "listen": "test", "script": { "id": "4057ff95-f27c-4174-b376-91faf6802cdf", "exec": [ "if (responseCode.code != 200) {", " tests[\"List events (new messages): failed\"] = false;", "}", "else {", " tests[\"List events (new messages): success\"] = true;", "}" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/events?resource=messages&type=created", "host": [ "{{WEBEXAPI}}" ], "path": [ "events" ], "query": [ { "key": "resource", "value": "messages" }, { "key": "type", "value": "created" } ] }, "description": "List events in your organization. Several query parameters are available to filter the response.\nLong result sets will be split into pages.\n\nhttps://developer.webex.com/endpoint-events-get.html" }, "response": [] }, { "name": "List Events (last hour)", "event": [ { "listen": "prerequest", "script": { "id": "11a52960-9773-49b6-bff6-00cde3614fa7", "exec": [ "var now = new Date(Date.now());", "postman.setEnvironmentVariable(\"_now\", now.toISOString());", "", "var one_hour_ago = now;", "one_hour_ago.setHours(one_hour_ago.getHours()-1);", "postman.setEnvironmentVariable(\"_one_hour_ago\", one_hour_ago.toISOString());", "", "", "", "", "", "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "id": "a5e0ec03-aa99-469f-9f7a-ad9bec9b315a", "exec": [ "if (responseCode.code != 200) {", " tests[\"List events (last hour): failed\"] = false;", "}", "else {", " tests[\"List events (last hour): success\"] = true;", "}" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/events?from={{_one_hour_ago}}&to={{_now}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "events" ], "query": [ { "key": "from", "value": "{{_one_hour_ago}}" }, { "key": "to", "value": "{{_now}}" } ] }, "description": "List events in your organization. Several query parameters are available to filter the response.\nLong result sets will be split into pages.\n\nhttps://developer.webex.com/endpoint-events-get.html" }, "response": [] }, { "name": "List Events (new messages last hour)", "event": [ { "listen": "prerequest", "script": { "id": "2eb89e7a-3b92-4e43-aa38-e67b12bdd2f0", "exec": [ "var now = new Date(Date.now());", "postman.setEnvironmentVariable(\"_now\", now.toISOString());", "", "var one_hour_ago = now;", "one_hour_ago.setHours(one_hour_ago.getHours()-1);", "postman.setEnvironmentVariable(\"_one_hour_ago\", one_hour_ago.toISOString());", "", "", "", "", "", "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "id": "0a7cf68f-fb8f-4352-a25d-df21fe9e2f04", "exec": [ "if (responseCode.code != 200) {", " tests[\"List events (new messages last hour): failed\"] = false;", "}", "else {", " tests[\"List events (new messages last hour): success\"] = true;", "", " var jsonData = JSON.parse(responseBody);", " if (jsonData.items.length === 0) {", " tests[\"List events (new messages last hour): no new messages\"] = true", " }", " else {", " var pickedEvent = jsonData.items[0];", " postman.setEnvironmentVariable(\"_event\", pickedEvent.id);", " tests[\"List events (new messages last hour): stored event:\" + pickedEvent.id] = true", " }", "}" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/events?resource=messages&type=created&from={{_one_hour_ago}}&to={{_now}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "events" ], "query": [ { "key": "resource", "value": "messages" }, { "key": "type", "value": "created" }, { "key": "from", "value": "{{_one_hour_ago}}" }, { "key": "to", "value": "{{_now}}" } ] }, "description": "List events in your organization. Several query parameters are available to filter the response.\nLong result sets will be split into pages.\n\nhttps://developer.webex.com/endpoint-events-get.html" }, "response": [] }, { "name": "Get Events Details", "event": [ { "listen": "test", "script": { "id": "4909694c-00ab-46d8-9aef-3a322cb851ef", "exec": [ "if (responseCode.code != 200) {", " tests[\"Get event details: failed\"] = false;", "}", "else {", " tests[\"Get event details: success\"] = true;", "}" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/events/{{_event}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "events", "{{_event}}" ] }, "description": "Shows details for an event, by event ID.\r\nSpecify the event ID in the eventId parameter in the URI.\r\n\r\nhttps://developer.webex.com/endpoint-events-eventId-get.html" }, "response": [] } ], "description": "Events are generated when actions take place within Cisco Spark, such as when someone creates or deletes a message. Use the Events API to retrieve events related to your account. Compliance Officers may retrieve events for all users within an organization. See the Compliance Guide for more information.\nhttps://developer.ciscospark.com/docs/api/guides/compliance.html\n\nThe resource endpoints such as /rooms, /messages, /memberships, etc. represent the current state of data in Spark. The /events resource represents the log of state changes which led to the current state of these resources; it details when a resource changed and who made the change.\n\nFor example, when a user posts a message in a room, this will result in a new message, available via the /messages resource. It will also result in a new event, available on the /events resource. If the user then deletes their message, this will result in the message no longer being returned on the /messages resource but it will result in a new event for the message deletion on the /events resource.\n\nEvents are available for the following resources when they are created, updated, or deleted:\n- messages\n- memberships\n\nhttps://developer.ciscospark.com/resource-events.html", "protocolProfileBehavior": {} }, { "name": "Licenses", "item": [ { "name": "List Licenses", "event": [ { "listen": "test", "script": { "id": "dbad80d1-ea20-4b4b-a01c-4c6c52afadd0", "exec": [ "if (responseCode.code != 200) {", " tests[\"List licenses : failed\"] = false;", "}", "else {", " tests[\"List licenses: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.items === undefined) {", " tests[\"List licenses: cannot retreive result\"] = false", " }", " else {", " var licenseId = jsonData.items[0].id;", " postman.setEnvironmentVariable(\"_license\", licenseId);", " tests[\"List licenses: retreived one with id:\" + licenseId] = true", " }", "}" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/licenses", "host": [ "{{WEBEXAPI}}" ], "path": [ "licenses" ] }, "description": "List all licenses for a given organization. If no orgId is specified, the default is the organization of the authenticated user.\n\nhttps://developer.webex.com/endpoint-licenses-get.html\n\nExample of a response:\n``` json\n{\n 'items' : [ {\n 'id' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\n 'displayName' : 'Spark Calling',\n 'totalUnits' : '42',\n 'consumedUnits' : '8'\n } ]\n}\n```" }, "response": [] }, { "name": "Get License Details", "event": [ { "listen": "test", "script": { "id": "600884ce-c64f-4776-8fcb-9787eaa1165f", "exec": [ "if (responseCode.code != 200) {", " tests[\"Get license details: failed\"] = false;", "}", "else {", " tests[\"Get license details: success\"] = true;", "}", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/licenses/{{_license}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "licenses", "{{_license}}" ] }, "description": "Shows details for a license, by ID.\r\n\r\nSpecify the license ID in the licenseId parameter in the URI.\r\n\r\nhttps://developer.webex.com/endpoint-licenses-licenseId-get.html\r\n\r\nExample Response:\r\n``` json\r\n{\r\n 'id' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\r\n 'displayName' : 'Spark Calling',\r\n 'totalUnits' : '42',\r\n 'consumedUnits' : \"8'\r\n}\r\n```" }, "response": [] }, { "name": "Create a Person (random)", "event": [ { "listen": "prerequest", "script": { "id": "85612fb5-76aa-4f84-a676-6bf6c11b49e1", "exec": [ "var random = Math.round(Math.random()*1000);", "", "postman.setEnvironmentVariable(\"_random\", random);" ], "type": "text/javascript" } }, { "listen": "test", "script": { "id": "e589a71e-b11f-432c-92f1-7a8b596d08fc", "exec": [ "if (responseCode.code != 200) {", " tests[\"Create a person: failed\"] = false;", "}", "else {", " tests[\"Create a person: success\"] = true;", "", " var jsonData = JSON.parse(responseBody);", " if (jsonData.id === undefined) {", " tests[\"Create a person: cannot retreive result\"] = false", " }", " else {", " var personID = jsonData.id;", " postman.setEnvironmentVariable(\"_person\", personID);", " tests[\"Create a person: retreived with id:\" + personID] = true", " ", " var orgId = jsonData.orgId;", " postman.setEnvironmentVariable(\"_organization\", orgId);", " tests[\"Create a person: retreived org with id:\" + orgId] = true", " ", " var email = jsonData.emails[0];", " postman.setEnvironmentVariable(\"_email\", email);", " tests[\"Create a person: retreived email:\" + email] = true", " }", " ", "}", " ", " " ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"emails\": [\r\n \"{{_random}}@{{_domain}}\"\r\n ],\r\n \"firstName\": \"User\",\r\n \"lastName\": \"FromPostman\"\r\n}" }, "url": { "raw": "{{WEBEXAPI}}/people", "host": [ "{{WEBEXAPI}}" ], "path": [ "people" ] }, "description": "Create a new user account for a given organization. Only an admin can create a new user account.\n\nhttps://developer.webex.com/endpoint-people-post.html\n\nExample Request:\n``` json\n{\n 'emails' : [ 'johnny.chang@foomail.com', 'jchang@barmail.com' ],\n 'displayName' : 'John Andersen',\n 'firstName' : 'John',\n 'lastName' : 'Andersen',\n 'avatar' : 'https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600',\n 'orgId' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\n 'roles' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ],\n 'licenses' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ]\n}\n\nExample Response:\n{\n 'id' : 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY',\n 'emails' : [ 'johnny.chang@foomail.com', 'jchang@barmail.com' ],\n 'displayName' : 'John Andersen',\n 'firstName' : 'John',\n 'lastName' : 'Andersen',\n 'avatar' : 'https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600',\n 'orgId' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\n 'roles' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ],\n 'licenses' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ],\n 'created' : '2015-10-18T14:26:16+00:00',\n 'timezone' : 'America/Denver'\n}\n```" }, "response": [] }, { "name": "Get Person Details (fetch displayName & orgId)", "event": [ { "listen": "test", "script": { "id": "7046ca1a-128d-4d14-8619-d3edaeb5bebf", "exec": [ "if (responseCode.code != 200) {", " tests[\"Get person details: failed\"] = false;", "}", "else {", " tests[\"Get person details: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.id === undefined) {", " tests[\"Get person details: cannot retreive result\"] = false", " }", " else {", " ", " var orgId = jsonData.orgId;", " postman.setEnvironmentVariable(\"_organization\", orgId);", " tests[\"Get person details: retreived org with id:\" + orgId] = true", "", " var displayName = jsonData.displayName;", " postman.setEnvironmentVariable(\"_displayName\", displayName);", " tests[\"Get person details: retreived displayName:\" + displayName] = true", "", " var email = jsonData.emails[0];", " postman.setEnvironmentVariable(\"_email\", email);", " tests[\"Get person details: retreived email:\" + email] = true", " }", "}", "", "", " " ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/people/{{_person}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "people", "{{_person}}" ] }, "description": "Shows details for a person, by ID.\nSpecify the person ID in the personId parameter in the URI.\n\nhttps://developer.webex.com/endpoint-people-personId-get.html" }, "response": [] }, { "name": "Update a Person (set license)", "event": [ { "listen": "test", "script": { "id": "8a48a3ba-8fa8-4232-a798-e9121b1ad631", "exec": [ "if (responseCode.code != 200) {", " tests[\"Update person: failed\"] = false;", "}", "else {", " tests[\"Update person: success\"] = true;", "}" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"orgId\" : \"{{_organization}}\",\r\n \"displayName\" : \"{{_displayName}}\",\r\n \"licenses\": [ \"{{_license}}\" ]\r\n}\r\n\r\n\r\n " }, "url": { "raw": "{{WEBEXAPI}}/people/{{_person}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "people", "{{_person}}" ] }, "description": "Update details for a person, by ID.\r\n\r\nSpecify the person ID in the personId parameter in the URI. Only an admin can update a person details.\r\n\r\nhttps://developer.webex.com/endpoint-people-personId-put.html\r\n\r\nExample Request:\r\n``` json\r\n{\r\n 'emails\" : [ 'johnny.chang@foomail.com', 'jchang@barmail.com' ],\r\n 'displayName' : 'John Andersen',\r\n 'firstName' : 'John',\r\n 'lastName' : 'Andersen',\r\n 'avatar' : 'https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600',\r\n 'orgId' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\r\n 'roles' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ],\r\n 'licenses' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ]\r\n}\r\n```" }, "response": [] } ], "description": "An allowance for features and services that are provided to users on a Webex Teams services subscription. Cisco and its partners manage the amount of licenses provided to administrators and users. This license resource can be accessed only by an admin.\n\nTo learn about how to allocate Hybrid Services licenses, see the Managing Hybrid Services guide.\n\nhttps://developer.webex.com/resource-licenses.html", "event": [ { "listen": "prerequest", "script": { "id": "22b12f22-89d8-42d9-9dc3-e937edb67908", "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "id": "ba43e23c-74ce-40a5-9fd8-f8e1246d56dc", "type": "text/javascript", "exec": [ "" ] } } ], "protocolProfileBehavior": {} }, { "name": "Organizations", "item": [ { "name": "List Organizations", "event": [ { "listen": "test", "script": { "id": "05f98352-2cf6-43b7-aa63-854c009aed49", "exec": [ "if (responseCode.code != 200) {", " tests[\"List organizations : failed\"] = false;", "}", "else {", " tests[\"List organizations: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.items === undefined) {", " tests[\"List organizations: cannot retreive result\"] = false", " }", " else {", " var orgId = jsonData.items[0].id;", " postman.setEnvironmentVariable(\"_organization\", orgId);", " tests[\"List organizations: retreived one with id:\" + orgId] = true", " }", "}" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/organizations", "host": [ "{{WEBEXAPI}}" ], "path": [ "organizations" ] }, "description": "List all organizations visible by your account.\n\nhttps://developer.webex.com/endpoint-organizations-get.html\n\nExample Response:\n``` json\n{\n 'items' : [ {\n 'id' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\n 'displayName' : 'Acme, Inc.',\n 'created' : '2015-10-18T14:26:16+00:00'\n } ]\n}\n```" }, "response": [] }, { "name": "Get Organization Details", "event": [ { "listen": "test", "script": { "id": "99746113-4e28-4286-9237-60cfc210abac", "exec": [ "if (responseCode.code != 200) {", " tests[\"Get organization details: failed\"] = false;", "}", "else {", " tests[\"Get organization details: success\"] = true;", "}" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/organizations/{{_organization}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "organizations", "{{_organization}}" ] }, "description": "Shows details for an organization, by ID.\r\n\r\nSpecify the org ID in the orgId parameter in the URI.\r\n\r\nhttps://developer.webex.com/endpoint-organizations-orgId-get.html\r\n\r\nExample Response:\r\n``` json\r\n{\r\n 'id' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\r\n 'displayName' : 'Acme, Inc.',\r\n 'created' : '2015-10-18T14:26:16+00:00'\r\n}\r\n```" }, "response": [] } ], "description": "A set of people in Webex Teams. Organizations may manage other organizations or be managed themselves. This organizations resource can be accessed only by an admin.\n\nhttps://developer.webex.com/resource-organizations.html\n\n", "event": [ { "listen": "prerequest", "script": { "id": "75b5851d-579d-4562-a2a7-4ed4a9420a85", "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "id": "eab9171a-374c-4260-a774-532a75dc2eb8", "type": "text/javascript", "exec": [ "" ] } } ], "protocolProfileBehavior": {} }, { "name": "People", "item": [ { "name": "Get Person Details (me)", "event": [ { "listen": "test", "script": { "id": "74bc245f-0686-4669-ac38-4bad3a1dc927", "exec": [ "if (responseCode.code != 200) {", " tests[\"Get person details: failed\"] = false;", "}", "else {", " tests[\"Get person details: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.id === undefined) {", " tests[\"Create a person: cannot retreive result\"] = false", " }", " else {", " var email = jsonData.emails[0];", " var parsed = email.match(/\\@(.*)$/);", " var domain = parsed[1];", " postman.setEnvironmentVariable(\"_domain\", domain);", " tests[\"Create a person: retreived domain: \" + domain] = true", " }", "}", "", "", " " ], "type": "text/javascript" } }, { "listen": "prerequest", "script": { "id": "263d0744-ec80-4b24-a3ad-2e2bc62bca25", "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{WEBEXAPI}}/people/me", "host": [ "{{WEBEXAPI}}" ], "path": [ "people", "me" ] }, "description": "Show the profile for the authenticated user.\n\nhttps://developer.webex.com/endpoint-people-me-get.html" }, "response": [] }, { "name": "List People", "event": [ { "listen": "test", "script": { "id": "ba7a72b3-768b-47ef-a821-076162ef34c3", "exec": [ "if (responseCode.code != 200) {", " tests[\"Get person details: failed\"] = false;", "}", "else {", " tests[\"Get person details: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.id === undefined) {", " tests[\"Get person details: cannot retreive result\"] = false", " }", " else {", " ", " var orgId = jsonData.orgId;", " postman.setEnvironmentVariable(\"_organization\", orgId);", " tests[\"Get person details: retreived org with id:\" + orgId] = true", " ", " var email = jsonData.emails[0];", " postman.setEnvironmentVariable(\"_email\", email);", " tests[\"Get person details: retreived email:\" + email] = true", " }", "}", "", "", " " ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/people", "host": [ "{{WEBEXAPI}}" ], "path": [ "people" ] } }, "response": [] }, { "name": "Create a Person (random)", "event": [ { "listen": "prerequest", "script": { "id": "74bab97c-c127-4085-9172-f9546d963d96", "exec": [ "var random = Math.round(Math.random()*1000);", "", "postman.setEnvironmentVariable(\"_random\", random);" ], "type": "text/javascript" } }, { "listen": "test", "script": { "id": "70b33ad3-d860-45c7-ba45-1d3eead960bd", "exec": [ "if (responseCode.code != 200) {", " tests[\"Create a person: failed\"] = false;", "}", "else {", " tests[\"Create a person: success\"] = true;", "", " var jsonData = JSON.parse(responseBody);", " if (jsonData.id === undefined) {", " tests[\"Create a person: cannot retreive result\"] = false", " }", " else {", " var personID = jsonData.id;", " postman.setEnvironmentVariable(\"_person\", personID);", " tests[\"Create a person: retreived with id:\" + personID] = true", " ", " var orgId = jsonData.orgId;", " postman.setEnvironmentVariable(\"_organization\", orgId);", " tests[\"Create a person: retreived org with id:\" + orgId] = true", " ", " var email = jsonData.emails[0];", " postman.setEnvironmentVariable(\"_email\", email);", " tests[\"Create a person: retreived email:\" + email] = true", " }", " ", "}", " ", " " ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"emails\": [\r\n \"{{_random}}@{{_domain}}\"\r\n ],\r\n \"firstName\": \"User\",\r\n \"lastName\": \"FromPostman\"\r\n}" }, "url": { "raw": "{{WEBEXAPI}}/people", "host": [ "{{WEBEXAPI}}" ], "path": [ "people" ] }, "description": "Create a new user account for a given organization. Only an admin can create a new user account.\n\nhttps://developer.webex.com/endpoint-people-post.html\n\nExample Request:\n``` json\n{\n 'emails' : [ 'johnny.chang@foomail.com', 'jchang@barmail.com' ],\n 'displayName' : 'John Andersen',\n 'firstName' : 'John',\n 'lastName' : 'Andersen',\n 'avatar' : 'https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600',\n 'orgId' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\n 'roles' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ],\n 'licenses' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ]\n}\n\nExample Response:\n{\n 'id' : 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY',\n 'emails' : [ 'johnny.chang@foomail.com', 'jchang@barmail.com' ],\n 'displayName' : 'John Andersen',\n 'firstName' : 'John',\n 'lastName' : 'Andersen',\n 'avatar' : 'https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600',\n 'orgId' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\n 'roles' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ],\n 'licenses' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ],\n 'created' : '2015-10-18T14:26:16+00:00',\n 'timezone' : 'America/Denver'\n}\n```" }, "response": [] }, { "name": "Get Person Details", "event": [ { "listen": "test", "script": { "id": "ba7a72b3-768b-47ef-a821-076162ef34c3", "exec": [ "if (responseCode.code != 200) {", " tests[\"Get person details: failed\"] = false;", "}", "else {", " tests[\"Get person details: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.id === undefined) {", " tests[\"Get person details: cannot retreive result\"] = false", " }", " else {", " ", " var orgId = jsonData.orgId;", " postman.setEnvironmentVariable(\"_organization\", orgId);", " tests[\"Get person details: retreived org with id:\" + orgId] = true", " ", " var email = jsonData.emails[0];", " postman.setEnvironmentVariable(\"_email\", email);", " tests[\"Get person details: retreived email:\" + email] = true", " }", "}", "", "", " " ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/people/{{_person}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "people", "{{_person}}" ] }, "description": "Shows details for a person, by ID.\nSpecify the person ID in the personId parameter in the URI.\n\nhttps://developer.webex.com/endpoint-people-personId-get.html" }, "response": [] }, { "name": "List people (with exact email)", "event": [ { "listen": "test", "script": { "id": "70aaa3a3-77f3-4630-887e-4a04fa43d55f", "exec": [ "if (responseCode.code != 200) {", " tests[\"List people (exact email): failed\"] = false;", "}", "else {", " tests[\"List people (exact email): success\"] = true;", "}", "", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/people?email={{_email}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "people" ], "query": [ { "key": "email", "value": "{{_email}}" } ] }, "description": "List people in your organization.\n\nhttps://developer.webex.com/endpoint-people-get.html" }, "response": [] }, { "name": "Get roles (to fetch a role id)", "event": [ { "listen": "test", "script": { "id": "434540e2-b696-4518-8a92-562e5ee8f4a2", "exec": [ "if (responseCode.code != 200) {", " tests[\"List roles: failed\"] = false;", "}", "else {", " tests[\"List roles: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.items === undefined) {", " tests[\"List roles: cannot retreive result\"] = false", " }", " else {", " var roleId = jsonData.items[0].id;", " postman.setEnvironmentVariable(\"_role\", roleId);", " tests[\"List roles: retreived with id:\" + roleId] = true", " }", "}" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/roles", "host": [ "{{WEBEXAPI}}" ], "path": [ "roles" ] }, "description": "List all roles.\n\nhttps://developer.webex.com/endpoint-roles-get.html\n\nExample Response:\n``` json\n{\n 'items' : [ {\n 'id' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\n 'displayName' : 'Full Administrator'\n } ]\n}\n```" }, "response": [] }, { "name": "Update a Person", "event": [ { "listen": "test", "script": { "id": "797a6d18-77fc-49f1-b019-7703a7cbf5b0", "exec": [ "if (responseCode.code != 200) {", " tests[\"Update person: failed\"] = false;", "}", "else {", " tests[\"Update person: success\"] = true;", "}" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"orgId\":\"{{_organization}}\",\r\n \"emails\": [\r\n \"{{_email}}\"\r\n ],\r\n \"displayName\": \"User updated\",\r\n \"roles\": [\"{{_role}}\"]\r\n}\r\n\r\n\r\n " }, "url": { "raw": "{{WEBEXAPI}}/people/{{_person}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "people", "{{_person}}" ] }, "description": "Update details for a person, by ID.\r\n\r\nSpecify the person ID in the personId parameter in the URI. Only an admin can update a person details.\r\n\r\nhttps://developer.webex.com/endpoint-people-personId-put.html\r\n\r\nExample Request:\r\n``` json\r\n{\r\n 'emails\" : [ 'johnny.chang@foomail.com', 'jchang@barmail.com' ],\r\n 'displayName' : 'John Andersen',\r\n 'firstName' : 'John',\r\n 'lastName' : 'Andersen',\r\n 'avatar' : 'https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600',\r\n 'orgId' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\r\n 'roles' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ],\r\n 'licenses' : [ 'Y2lzY29zcGFyazovL3VzL1JPT00vOGNkYzQwYzQtZjA5ZS0zY2JhLThjMjYtZGQwZTcwYWRlY2Iy', 'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX' ]\r\n}\r\n```" }, "response": [] }, { "name": "Get Person Details", "event": [ { "listen": "test", "script": { "id": "1130c12d-ebae-4a68-8b82-71ba86cb778a", "exec": [ "if (responseCode.code != 200) {", " tests[\"Get person details: failed\"] = false;", "}", "else {", " tests[\"Get person details: success\"] = true;", "}", "", "", " " ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/people/{{_person}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "people", "{{_person}}" ] }, "description": "Shows details for a person, by ID.\nSpecify the person ID in the personId parameter in the URI.\n\nhttps://developer.webex.com/endpoint-people-personId-get.html" }, "response": [ { "name": "person details (Stève)", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{spark_token}}", "enabled": true }, { "key": "Content-Type", "value": "application/json", "enabled": true, "description": "The mime type of this content" } ], "url": { "raw": "https://api.ciscospark.com/v1/people/me", "protocol": "https", "host": [ "api", "ciscospark", "com" ], "path": [ "v1", "people", "me" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "javascript", "header": [ { "key": "Cache-Control", "value": "no-cache", "name": "Cache-Control", "description": "" }, { "key": "Content-Encoding", "value": "gzip", "name": "Content-Encoding", "description": "" }, { "key": "Content-Length", "value": "540", "name": "Content-Length", "description": "" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8", "name": "Content-Type", "description": "" }, { "key": "Date", "value": "Wed, 09 Nov 2016 12:39:38 GMT", "name": "Date", "description": "" }, { "key": "Server", "value": "Redacted", "name": "Server", "description": "" }, { "key": "Trackingid", "value": "NA_e996fd8b-5abe-46f8-867b-a26732771b1e", "name": "Trackingid", "description": "" }, { "key": "Vary", "value": "Accept-Encoding", "name": "Vary", "description": "" }, { "key": "X-Cf-Requestid", "value": "512dc7ed-54dd-41f3-4338-2815604cd323", "name": "X-Cf-Requestid", "description": "" } ], "cookie": [ { "expires": "Fri Sep 18 2026 14:34:17 GMT+0200 (Central European Summer Time)", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": false, "value": "oeu1474374857983r0.14725724747852298", "key": "optimizelyEndUserId" }, { "expires": "Tue Sep 21 2021 17:16:39 GMT+0200 (Central European Summer Time)", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": false, "value": "7FADA00A51DA6DC2-19EB0A83469897EF", "key": "s_fid" }, { "expires": "Invalid Date", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": true, "value": "1", "key": "AMCVS_5C0A123F5245AEEA0A490D45%40AdobeOrg" }, { "expires": "Sat Nov 26 2016 20:09:32 GMT+0100 (Central European Standard Time)", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": false, "value": "Prospect", "key": "user_segment" }, { "expires": "Invalid Date", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": true, "value": "direct", "key": "offerFlag" }, { "expires": "Invalid Date", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": true, "value": "rsp%3Dmatch%26cData%3D864409%253ACisco%2520Systems%2520Inc%253ATelecommunications%253AEquipment%2520%2526%2520Services%253AEnterprise%253AGreater%2520th%253AEnterprise%2520Business%253ATelecommunications%26cDataCustom%3DAdUpgrades%253ASan%2520Jose%253ACA%253A%255Bn%2Fa%255D%253A%255Bn%2Fa%255D%253A%255Bn%2Fa%255D%253A%255Bn%2Fa%255D%253A%255Bn%2Fa%255D%26sentAA%3DT%26sentAT%3DT", "key": "s_dmdbase" }, { "expires": "Invalid Date", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": true, "value": "offer-page", "key": "TrialFlag" }, { "expires": "Tue Nov 09 2021 09:41:52 GMT+0100 (Central European Standard Time)", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": false, "value": "%5B%5B%27other%27%2C%271474797461486%27%5D%2C%5B%27direct%27%2C%271478680912377%27%5D%5D", "key": "spark_lst3" }, { "expires": "Thu Nov 09 2017 10:55:00 GMT+0100 (Central European Standard Time)", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": false, "value": "%7B%22distinct_id%22%3A%20%226b856818bc3ccf2b0c09fa74a2eb8ab84016c085e681428df4faadf8017a504a%22%2C%22%24initial_referrer%22%3A%20%22%24direct%22%2C%22%24initial_referring_domain%22%3A%20%22%24direct%22%2C%22__mps%22%3A%20%7B%7D%2C%22__mpso%22%3A%20%7B%7D%2C%22__mpa%22%3A%20%7B%7D%2C%22__mpu%22%3A%20%7B%7D%2C%22__mpap%22%3A%20%5B%5D%7D", "key": "mp_87246332384760c6f27c021cf964be46_mixpanel" }, { "expires": "Thu Nov 10 2016 10:55:00 GMT+0100 (Central European Standard Time)", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": false, "value": "0", "key": "mp_mixpanel__c" }, { "expires": "Fri Nov 09 2018 13:03:28 GMT+0100 (Central European Standard Time)", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": false, "value": "-1176276602%7CMCIDTS%7C17114%7CMCMID%7C69089778980261905934220490212596711080%7CMCAAMLH-1478858364%7C6%7CMCAAMB-1479297808%7CNRX38WO0n5BH8Th-nqAG_A%7CMCOPTOUT-1478700208s%7CNONE%7CMCAID%7C2B6C2745050120E0-400001136000C2AA", "key": "AMCV_5C0A123F5245AEEA0A490D45%40AdobeOrg" }, { "expires": "Fri Dec 09 2016 13:04:21 GMT+0100 (Central European Standard Time)", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": false, "value": "1478693061363-Repeat", "key": "s_nr" }, { "expires": "Sat Nov 09 2019 13:04:21 GMT+0100 (Central European Standard Time)", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": false, "value": "1478693061364", "key": "s_lv" }, { "expires": "Thu Dec 01 2016 00:00:00 GMT+0100 (Central European Standard Time)", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": false, "value": "1480546800357%26vn%3D2", "key": "s_vnum" }, { "expires": "Invalid Date", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": true, "value": "1", "key": "siteEntry" }, { "expires": "Invalid Date", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": true, "value": "%5B%5BB%5D%5D", "key": "SC_LINKS" }, { "expires": "Invalid Date", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": true, "value": "%3A", "key": "v76" }, { "expires": "Invalid Date", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": true, "value": "wx%253Aus%253Aen_US%253ADisplayAccountOrderListPage%2C100%2C100%2C253%2C0%2C253%2C1920%2C1080%2C1%2CL", "key": "s_ppvl" }, { "expires": "Invalid Date", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": true, "value": "wx%253Aus%253Aen_US%253ADisplayAccountOrderListPage%2C100%2C100%2C792%2C1714%2C792%2C1920%2C1080%2C1%2CP", "key": "s_ppv" }, { "expires": "Wed Nov 09 2016 14:04:26 GMT+0100 (Central European Standard Time)", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": false, "value": "\"9lky1LUlDaAk0wNMLGQZDqeHijTSbknr3ey//5I8xq16T2VW4m8APfMKvlUTPoCvC71CJU31GeI901eE/eg=\"", "key": "webexToken" }, { "expires": "Tue Feb 07 2017 13:04:27 GMT+0100 (Central European Standard Time)", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": false, "value": "PC#1456324639084-656899.28_28#1486469067|check#true#1478693127|session#1478693060450-425931#1478694927", "key": "mbox" }, { "expires": "Fri Nov 09 2018 13:28:19 GMT+0100 (Central European Standard Time)", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": false, "value": "GA1.2.354628933.1456392661", "key": "_ga" }, { "expires": "Thu Nov 09 2017 13:28:20 GMT+0100 (Central European Standard Time)", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": false, "value": "25019306.1308965199.1458575275042.1478693238438", "key": "_actmu" }, { "expires": "Wed Nov 09 2016 13:58:20 GMT+0100 (Central European Standard Time)", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": false, "value": "1478693238438", "key": "_actms" }, { "expires": "Sat Nov 07 2026 13:32:40 GMT+0100 (Central European Standard Time)", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": false, "value": "%7B%226148830417%22%3A%22gc%22%2C%226176172291%22%3A%22none%22%2C%226153610436%22%3A%22referral%22%2C%226132590950%22%3A%22false%22%7D", "key": "optimizelySegments" }, { "expires": "Sat Nov 07 2026 13:32:43 GMT+0100 (Central European Standard Time)", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": false, "value": "%7B%227495520894%22%3A%227475976205%22%2C%227548736597%22%3A%227574622917%22%2C%227717362716%22%3A%227714322794%22%7D", "key": "optimizelyBuckets" }, { "expires": "Invalid Date", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": true, "value": "true", "key": "s_cc" }, { "expires": "Invalid Date", "hostOnly": false, "httpOnly": false, "domain": ".ciscospark.com", "path": "/", "secure": false, "session": true, "value": "%5B%5BB%5D%5D", "key": "s_sq" } ], "body": "{\"id\":\"Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wM2ZiZTEwOS0yM2Y2LTQ1OWItODFlNS02YzYxM2JhMWNhZTE\",\"emails\":[\"steve.sfartz@gmail.com\"],\"displayName\":\"Stève Sfartz\",\"firstName\":\"Stève\",\"lastName\":\"Sfartz\",\"avatar\":\"https://c74213ddaf67eb02dabb-04de5163e3f90393a9f7bb6f7f0967f1.ssl.cf1.rackcdn.com/V1~efa32f72522b5f61176ce069d9163a43~ZOzopPn4Q3edMJrRLI-FMA==~1600\",\"orgId\":\"Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi82NWQ0N2MzNS1lNzg1LTRjZTMtOWM0NC1hNGM0OGViZTQyYmE\",\"roles\":[\"Y2lzY29zcGFyazovL3VzL1JPTEUvaWRfZnVsbF9hZG1pbg\"],\"licenses\":[\"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvNjVkNDdjMzUtZTc4NS00Y2UzLTljNDQtYTRjNDhlYmU0MmJhOk1TXzA3NTMwNzAxLTlkM2YtNDFmOC04Y2NkLTY4YzY1NmU2ZGMwMQ\"],\"created\":\"2015-12-22T10:36:52.660Z\",\"timeZone\":\"Europe/Paris\"}" } ] }, { "name": "Delete a Person", "event": [ { "listen": "test", "script": { "id": "22817ba7-fd97-4e57-b266-7967133398e7", "exec": [ "if (responseCode.code != 204) {", " tests[\"Delete person: failed\"] = false;", "}", "else {", " tests[\"Delete person: success\"] = true;", "}", " ", " " ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/people/{{_person}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "people", "{{_person}}" ] }, "description": "Remove a person from the system. Only an admin can remove a person.\n\nSpecify the person ID in the personId parameter in the URI.\n\nhttps://developer.webex.com/endpoint-people-personId-delete.html" }, "response": [] } ], "description": "People are registered users of Webex Teams. Searching and viewing People requires an auth token with a scope of spark:people_read. Viewing the list of all People in your Organization requires an administrator auth token with spark-admin:people_read scope. Adding, updating, and removing People requires an administrator auth token with the spark-admin:people_write scope.\r\n\r\nTo learn more about managing people in a room see the Memberships API. For information about how to allocate Hybrid Services licenses to people, see the Managing Hybrid Services guide.\r\n\r\nhttps://developer.webex.com/resource-people.html", "event": [ { "listen": "prerequest", "script": { "id": "c1e0d80e-1c21-4b2b-90fd-2da78b0539cc", "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "id": "9873f57e-4a14-4d6c-97e9-b1c333c793cd", "type": "text/javascript", "exec": [ "" ] } } ], "protocolProfileBehavior": {} }, { "name": "Places", "item": [ { "name": "List Places", "event": [ { "listen": "test", "script": { "id": "ba7a72b3-768b-47ef-a821-076162ef34c3", "exec": [ "if (responseCode.code != 200) {", " tests[\"List places : failed\"] = false;", "}", "else {", " tests[\"List places: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.items === undefined) {", " tests[\"List places: cannot retreive result\"] = false", " }", " else {", " var placeId = jsonData.items[0].id;", " postman.setEnvironmentVariable(\"_place\", placeId);", " tests[\"List places: retreived one place with id:\" + placeId] = true", " }", "}", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/places", "host": [ "{{WEBEXAPI}}" ], "path": [ "places" ] }, "description": "List places.\nUse query parameters to filter the response.\n\nhttps://developer.webex.com/docs/api/v1/places/list-places" }, "response": [] }, { "name": "Create a Place", "event": [ { "listen": "test", "script": { "id": "ba7a72b3-768b-47ef-a821-076162ef34c3", "exec": [ "if (responseCode.code != 200) {", " tests[\"Create a place: failed\"] = false;", "}", "else {", " tests[\"Create a place: success\"] = true;", "", " var jsonData = JSON.parse(responseBody);", " if (jsonData.id === undefined) {", " tests[\"Create a place: cannot retreive result\"] = false", " }", " else {", " var placeId = jsonData.id;", " postman.setEnvironmentVariable(\"_place\", placeId);", " tests[\"Create a place: created with id:\" + placeId] = true", " }", " ", "}", " ", " " ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{ \r\n\t\"displayName\" : \"DevNetZone\",\r\n\t\"type\" : \"room_device\"\r\n}" }, "url": { "raw": "{{WEBEXAPI}}/places", "host": [ "{{WEBEXAPI}}" ], "path": [ "places" ] }, "description": "Create a place.\n\nhttps://developer.webex.com/docs/api/v1/places/create-a-place" }, "response": [] }, { "name": "Get Place Details", "event": [ { "listen": "test", "script": { "id": "ba7a72b3-768b-47ef-a821-076162ef34c3", "exec": [ "if (responseCode.code != 200) {", " tests[\"Get place details: failed\"] = false;", "}", "else {", " tests[\"Get place details: success\"] = true;", "}", "", "", " " ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/places/{{_place}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "places", "{{_place}}" ] }, "description": "Shows details for a place, by ID.\r\nSpecify the place ID in the placeId parameter in the URI.\r\n\r\nhttps://developer.webex.com/docs/api/v1/places/get-place-details" }, "response": [] }, { "name": "Update a Place", "event": [ { "listen": "test", "script": { "id": "ba7a72b3-768b-47ef-a821-076162ef34c3", "exec": [ "if (responseCode.code != 200) {", " tests[\"Update place: failed\"] = false;", "}", "else {", " tests[\"Update place: success\"] = true;", "}" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{ \r\n\t\"displayName\" : \"home\",\r\n\t\"type\" : \"room_device\"\r\n}" }, "url": { "raw": "{{WEBEXAPI}}/places/{{_place}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "places", "{{_place}}" ] }, "description": "Updates details for a place, by ID.\r\nSpecify the place ID in the placeId parameter in the URI.\r\n\r\nhttps://developer.webex.com/docs/api/v1/places/update-a-place" }, "response": [] }, { "name": "Create a Device Activation Code", "event": [ { "listen": "test", "script": { "id": "ba7a72b3-768b-47ef-a821-076162ef34c3", "exec": [ "if (responseCode.code != 200) {", " tests[\"Create an activation code: failed\"] = false;", "}", "else {", " tests[\"Create an activation code: success\"] = true;", "", " var jsonData = JSON.parse(responseBody);", " if (jsonData.code === undefined) {", " tests[\"Create an activation code: cannot retreive result\"] = false", " }", " else {", " var code = jsonData.code;", " postman.setEnvironmentVariable(\"_code\", code);", " tests[\"Create an activation code: \" + code] = true", " }", "}", " ", " " ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n\t\"placeId\" : \"{{_place}}\"\n}" }, "url": { "raw": "{{WEBEXAPI}}/devices/activationCode", "host": [ "{{WEBEXAPI}}" ], "path": [ "devices", "activationCode" ] }, "description": "Generate an activation code for a device in a specific place by placeId. Currently, activation codes may only be generated for shared places--personal mode is not supported.\n\nhttps://developer.webex.com/docs/api/v1/devices/create-a-device-activation-code" }, "response": [] }, { "name": "Delete a Place", "event": [ { "listen": "test", "script": { "id": "ba7a72b3-768b-47ef-a821-076162ef34c3", "exec": [ "if (responseCode.code != 204) {", " tests[\"Delete place: failed\"] = false;", "}", "else {", " tests[\"Delete place: success\"] = true;", "}", " ", " " ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/places/{{_place}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "places", "{{_place}}" ] }, "description": "Deletes a place, by ID. Will also delete all devices associated with the place.\r\nSpecify the place ID in the placeId parameter in the URI.\r\n\r\nhttps://developer.webex.com/docs/api/v1/places/delete-a-place" }, "response": [] } ], "description": "Places represent where people work, such as conference rooms, meeting spaces, lobbies, and lunch rooms. Devices may be associated with places.\r\n\r\nViewing details for places you have access to requires an auth token with a scope of spark:places_read. Updating or deleting your places requires an auth token with the spark:places_write scope. Viewing the list of all places in an organization requires an administrator auth token with the spark-admin:places_read scope. Adding, updating, or deleting all places in an organization requires an administrator auth token with the spark-admin:places_write scope.\r\n\r\nhttps://developer.webex.com/docs/api/v1/places", "event": [ { "listen": "prerequest", "script": { "id": "4334833c-35d2-4f03-80f3-39e3bd406a1a", "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "id": "d74c7738-c88f-48ba-ba4a-ded1565a8bf4", "type": "text/javascript", "exec": [ "" ] } } ], "protocolProfileBehavior": {} }, { "name": "Roles", "item": [ { "name": "List Roles", "event": [ { "listen": "test", "script": { "id": "8b97bbb6-93e0-4b7f-9216-7c6b71ec8301", "exec": [ "if (responseCode.code != 200) {", " tests[\"List roles: failed\"] = false;", "}", "else {", " tests[\"List roles: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.items === undefined) {", " tests[\"List roles: cannot retreive result\"] = false", " }", " else {", " var roleId = jsonData.items[0].id;", " postman.setEnvironmentVariable(\"_role\", roleId);", " tests[\"List roles: retreived with id:\" + roleId] = true", " }", "}" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/roles", "host": [ "{{WEBEXAPI}}" ], "path": [ "roles" ] }, "description": "List all roles.\n\nhttps://developer.webex.com/endpoint-roles-get.html\n\nExample Response:\n``` json\n{\n 'items' : [ {\n 'id' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\n 'displayName' : 'Full Administrator'\n } ]\n}\n```" }, "response": [] }, { "name": "Get Role Details", "event": [ { "listen": "test", "script": { "id": "521663b9-91b4-41b3-81b6-e3d7bbc5de6c", "exec": [ "if (responseCode.code != 200) {", " tests[\"Get role details: failed\"] = false;", "}", "else {", " tests[\"Get role details: success\"] = true;", "}", " " ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/roles/{{_role}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "roles", "{{_role}}" ] }, "description": "Shows details for a role, by ID.\n\nSpecify the role ID in the roleId parameter in the URI.\n\nhttps://developer.webex.com/endpoint-roles-roleId-get.html\n\nExample Response:\n``` json\n{\n 'id' : 'OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh',\n 'displayName' : 'Full Administrator'\n}\n```" }, "response": [] } ], "description": "A persona for an authenticated user, corresponding to a set of privileges within an organization. This roles resource can be accessed only by an admin.\n\nhttps://developer.webex.com/resource-roles.html", "event": [ { "listen": "prerequest", "script": { "id": "b9076309-ce8a-4aba-a089-26b2dd7f8818", "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "id": "66f81f7f-393b-4b26-af9f-1d4eb20e0e6b", "type": "text/javascript", "exec": [ "" ] } } ], "protocolProfileBehavior": {} }, { "name": "xAPI", "item": [ { "name": "List Devices", "event": [ { "listen": "test", "script": { "id": "ad058baa-277b-4889-9294-2e17a825961d", "exec": [ "", "if (responseCode.code != 200) {", " tests[\"List devices : failed\"] = false;", "}", "else {", " tests[\"List devices: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.items === undefined) {", " tests[\"List devices: cannot retreive result\"] = false", " }", " else {", " var deviceId = jsonData.items[0].id;", " postman.setEnvironmentVariable(\"_device\", deviceId);", " tests[\"List devices: retreived one device with id:\" + deviceId] = true", "", " visualize(jsonData.items);", " }", "}", "", "function visualize(devices) {", " ", " // Configure the template", " var template = `", " ", "", " ", "", " `;", "", " // Set the visualizer template", " pm.visualizer.set(template, { ", " labels: [ ", " \"count\", ", " \"connected\", ", " \"connected_with_issues\", ", " \"disconnected\"],", " data: [ ", " devices.length, ", " devices.filter((device) => { return (device.connectionStatus === \"connected\") }).length,", " devices.filter((device) => { return (device.connectionStatus === \"connected_with_issues\") }).length,", " devices.filter((device) => { return (device.connectionStatus === \"disconnected\") }).length]", " });", "}", "", "", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/devices", "host": [ "{{WEBEXAPI}}" ], "path": [ "devices" ] }, "description": "Lists all active Webex devices associated with the authenticated user, such as devices activated in personal mode, or devices to which the user is actively paired or using. Administrators can list all devices within an organization.\n\nhttps://developer.webex.com/docs/api/v1/devices/list-devices" }, "response": [] }, { "name": "Get Device Details", "event": [ { "listen": "test", "script": { "id": "ac958aca-3823-4460-a6f8-4454b038cdff", "exec": [ "if (responseCode.code != 200) {", " tests[\"Get device details: failed\"] = false;", "}", "else {", " tests[\"Get device details: success\"] = true;", "}", "", "", " " ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/devices/{{_device}}", "host": [ "{{WEBEXAPI}}" ], "path": [ "devices", "{{_device}}" ] }, "description": "Shows details for a device, by ID.\r\nSpecify the device ID in the deviceId parameter in the URI.\r\n\r\nhttps://developer.webex.com/docs/api/v1/devices/get-device-details" }, "response": [] }, { "name": "Query Status (audio.volume)", "event": [ { "listen": "test", "script": { "id": "fff27071-4a37-4a27-ba05-f864cb957117", "exec": [ "if (responseCode.code != 200) {", " tests[\"List roles: failed\"] = false;", "}", "else {", " tests[\"List roles: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.items === undefined) {", " tests[\"List roles: cannot retreive result\"] = false", " }", " else {", " var roleId = jsonData.items[0].id;", " postman.setEnvironmentVariable(\"_role\", roleId);", " tests[\"List roles: retreived with id:\" + roleId] = true", " }", "}" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{WEBEXAPI}}/xapi/status?deviceId={{_device}}&name=audio.volume", "host": [ "{{WEBEXAPI}}" ], "path": [ "xapi", "status" ], "query": [ { "key": "deviceId", "value": "{{_device}}" }, { "key": "name", "value": "audio.volume" } ] }, "description": "Query the current status of the Webex RoomOS Device.\n\nSpecify the target device in the deviceId parameter in the URI.\n\nThe target device is queried for statuses according to the expression in the name parameter.\n\nSee the xAPI Guide for a description of status expressions.\n\nhttps://developer.webex.com/docs/api/v1/xapi/query-status" }, "response": [] }, { "name": "Execute Command (standby.deactivate)", "event": [ { "listen": "test", "script": { "id": "25963f6e-8094-448f-bfcf-fb54d1d7d90e", "exec": [ "if (responseCode.code != 200) {", " tests[\"List roles: failed\"] = false;", "}", "else {", " tests[\"List roles: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.items === undefined) {", " tests[\"List roles: cannot retreive result\"] = false", " }", " else {", " var roleId = jsonData.items[0].id;", " postman.setEnvironmentVariable(\"_role\", roleId);", " tests[\"List roles: retreived with id:\" + roleId] = true", " }", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "body": { "mode": "raw", "raw": "{\r\n \"deviceId\" : \"{{_device}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{WEBEXAPI}}/xapi/command/standby.deactivate", "host": [ "{{WEBEXAPI}}" ], "path": [ "xapi", "command", "standby.deactivate" ] }, "description": "Execute a command on the Webex RoomOS Device.\n\nSpecify the command to execute in the commandName parameter in the URI.\n\nSee the xAPI Guide for a description of command expressions.\n\nhttps://developer.webex.com/docs/api/v1/xapi/execute-command" }, "response": [] }, { "name": "Execute Command (message.alert)", "event": [ { "listen": "test", "script": { "id": "6d09dc28-c8af-4894-ac5d-8d2022720f32", "exec": [ "if (responseCode.code != 200) {", " tests[\"List roles: failed\"] = false;", "}", "else {", " tests[\"List roles: success\"] = true;", " ", " var jsonData = JSON.parse(responseBody);", " if (jsonData.items === undefined) {", " tests[\"List roles: cannot retreive result\"] = false", " }", " else {", " var roleId = jsonData.items[0].id;", " postman.setEnvironmentVariable(\"_role\", roleId);", " tests[\"List roles: retreived with id:\" + roleId] = true", " }", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"deviceId\": \"{{_device}}\",\r\n \"arguments\": {\r\n \"Duration\": 10,\r\n \"Title\": \"xAPI Cloud Test\",\r\n \"Text\": \"This is posted from Postman ;-) Change me!\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{WEBEXAPI}}/xapi/command/userinterface.message.alert.display", "host": [ "{{WEBEXAPI}}" ], "path": [ "xapi", "command", "userinterface.message.alert.display" ] }, "description": "Execute a command on the Webex RoomOS Device.\n\nSpecify the command to execute in the commandName parameter in the URI.\n\nSee the xAPI Guide for a description of command expressions.\n\nhttps://developer.webex.com/docs/api/v1/xapi/execute-command" }, "response": [] } ], "protocolProfileBehavior": {} } ], "event": [ { "listen": "prerequest", "script": { "id": "0d3602d6-7436-47d8-a84d-3c1e9f0164c6", "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "id": "4e2d13ee-6ff9-46d7-bc35-97b06d2d31cf", "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "id": "60dc6ff1-e95d-4544-8a01-b87d823cc124", "key": "WEBEXAPI", "value": "https://webexapis.com/v1" } ], "protocolProfileBehavior": {} }