\n\nThere's an organization-level boolean flag called 'enforceVerifiedDomains'. If this flag is set to false, we won't put any user in the organization into a transient state when verifying or claiming a domain.\nCustomers can still create users within the organization who don't use the verified domains as their email. However, if "
},
{
"info": {
"name": "Unverify Domain",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/identity/organizations/:orgId/actions/unverifyDomain",
"params": [
{
"name": "orgId",
"value": "bf732c85-68ca-4867-94e4-937286ad2fd4",
"type": "path",
"description": "The Webex Identity-assigned organization identifier for a user's organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "After you unclaim the domain, it will still be verified. Domain enforcement will still apply to the organization. The unverify endpoint helps to remove the domain ownership verification for the organization.\n\n**Possible Error:**\n\n- 400: The request was a Bad Request. The domain cannot be unverified. This error occurs if the domain is still claimed.\n\n- 404: The request was Not Found. This error occurs if the domain is not associated with the organization.\n\n**Authorization:**\n\nAn 'OAuth' token iss"
},
{
"info": {
"name": "Unclaim Domain",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/identity/organizations/:orgId/actions/unclaimDomain",
"params": [
{
"name": "orgId",
"value": "bf732c85-68ca-4867-94e4-937286ad2fd4",
"type": "path",
"description": "The Webex Identity-assigned organization identifier for a user's organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This API is used to unclaim a domain for the organization. The domain will remain verified, and domain enforcement will still apply to the given organization.\n\n**Possible Error:**\n\n- 400: The request was a Bad Request. The domain cannot be unclaimed. This error occurs if the requested parameter is invalid.\n\n**Authorization:**\n\nAn 'OAuth' token issued by the 'Identity Broker' is required to access this endpoint. The token must include one of the following scopes:\n\n- `Identity:Organization`\n\n- `id"
}
]
},
{
"info": {
"name": "Identity Organization",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get an organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/identity/organizations/:orgId",
"params": [
{
"name": "orgId",
"value": "82adacf4-453f-4e2b-a406-2939fddcaad2",
"type": "path",
"description": "Webex Identity assigned organization identifier."
}
]
},
"docs": "
\n\n**Authorization**\n\nOAuth token rendered by identity broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:organizations_rw`\n\n- `identity:organizations_read`\n\n
"
},
{
"info": {
"name": "Update an organization",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/identity/organizations/:orgId",
"params": [
{
"name": "orgId",
"value": "82adacf4-453f-4e2b-a406-2939fddcaad2",
"type": "path",
"description": "Webex Identity assigned organization identifier."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
\n\n**Authorization**\n\nOAuth token rendered by identity broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:organizations_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n
\n\n**Usage**:\n\n1. Input JSON must contain schema: \"urn:cisco:codev:identity:organization:core:1.0\"."
},
{
"info": {
"name": "Generate OTP",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/identity/organizations/:orgId/users/:userId/actions/generateOtp",
"params": [
{
"name": "orgId",
"value": "bf732c85-68ca-4867-94e4-937286ad2fd4",
"type": "path",
"description": "The Webex Identity-assigned organization identifier for a user's organization."
},
{
"name": "userId",
"value": "73e0e4f2-66f6-417a-b074-d473ed537f58",
"type": "path",
"description": "The Common Identity-assigned user identifier for an existing user (`entryUUID`)."
}
]
},
"docs": "This API allows an admin to generate a One-Time Password (OTP) for user accounts with `userNameType` set as `partner-upn`. The OTP is used by users to log in to any Webex application, whereupon they are asked to change their password.\nThe OTP generated by this API has a default length of 6 digits and expires in 7 days.\n\nSeveral OTPs can be active for the same user. When the user successfully uses an OTP, all other OTPs are automatically revoked.\n\nThe creation of OTPs is logged in the [Admin Audi"
}
]
},
{
"info": {
"name": "Events",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Events",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/events",
"params": [
{
"name": "resource",
"value": "messages",
"type": "query",
"description": "List events with a specific resource type."
},
{
"name": "type",
"value": "created",
"type": "query",
"description": "List events with a specific event type."
},
{
"name": "actorId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80MDNlZmUwNy02Yzc3LTQyY2UtOWI4NC1lZjhjYzY1ZDA4NDI",
"type": "query",
"description": "List events performed by this person, by person ID."
},
{
"name": "from",
"value": "2018-01-01T00:00:00.000Z",
"type": "query",
"description": "List events which occurred after a specific date and time."
},
{
"name": "to",
"value": "2018-01-02T00:00:00.000Z",
"type": "query",
"description": "List events that occurred before a specific date and time. If not specified, events up to the present time will be listed. Cannot be set to a future date relative to the current time."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive."
},
{
"name": "serviceType",
"value": "calling",
"type": "query",
"description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`."
}
]
},
"docs": "List events in your organization. Several query parameters are available to filter the events returned in the response.\n\nLong result sets will be split into [pages](/docs/basics#pagination)."
},
{
"info": {
"name": "Get Event Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/events/:eventId",
"params": [
{
"name": "eventId",
"value": "Y2lzY29zcGFyazovL3VzL0VWRU5UL2JiY2ViMWFkLTQzZjEtM2I1OC05MTQ3LWYxNGJiMGM0ZDE1NAo",
"type": "path",
"description": "The unique identifier for the event."
}
]
},
"docs": "Shows details for an event, by event ID.\n\nSpecify the event ID in the `eventId` parameter in the URI."
}
]
},
{
"info": {
"name": "Groups",
"type": "folder"
},
"items": [
{
"info": {
"name": "List and Search Groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/groups",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter."
},
{
"name": "filter",
"value": "displayName eq \"Marketing Department\"",
"type": "query",
"description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results."
},
{
"name": "attributes",
"value": "displayName",
"type": "query",
"description": "The attributes to return."
},
{
"name": "sortBy",
"value": "displayName",
"type": "query",
"description": "Sort the results based by group `displayName`."
},
{
"name": "sortOrder",
"value": "ascending",
"type": "query",
"description": "Sort results alphabetically by group display name, in ascending or descending order."
},
{
"name": "includeMembers",
"value": "false",
"type": "query",
"description": "Optionally return group members in the response. The maximum number of members returned is 500."
},
{
"name": "startIndex",
"value": "1",
"type": "query",
"description": "The index to start for group pagination."
},
{
"name": "count",
"value": "100",
"type": "query",
"description": "Specifies the desired number of search results per page."
}
]
},
"docs": "List groups in your organization.\n\n* Set the `includeMembers` parameter to `true` to return group members. The total number of members returned is limited to 500.\n\n* Use the `startIndex` and `count` parameters to page through result set.\n\n* To search for a specific group use the `filter` parameter.\n\n* Use `sortBy` parameter to sort the responses by `id` or `displayName`."
},
{
"info": {
"name": "Create a Group",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/groups",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new group for a given organization. The group may optionally be created with group members."
},
{
"info": {
"name": "Get Group Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/groups/:groupId",
"params": [
{
"name": "groupId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvYzY1ZjdkODUtYjY5MS00MmI4LWEyMGItODUzMDY0ZTFkNThiOjM0OGFkYjgxLTI4ZjktNGFiNS1iMmQ2LWU5YjQ5NGU3MmEwNg",
"type": "path",
"description": "A unique identifier for the group."
},
{
"name": "includeMembers",
"value": "true",
"type": "query",
"description": "Include the members as part of the response."
}
]
},
"docs": "Get details for a group, by ID.\n\nOptionally, the members may be retrieved with this request. The maximum number of members returned is 500."
},
{
"info": {
"name": "Update a Group",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/groups/:groupId",
"params": [
{
"name": "groupId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvYzY1ZjdkODUtYjY5MS00MmI4LWEyMGItODUzMDY0ZTFkNThiOjM0OGFkYjgxLTI4ZjktNGFiNS1iMmQ2LWU5YjQ5NGU3MmEwNg",
"type": "path",
"description": "A unique identifier for the group."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the group details, by ID.\n\nSpecify the group ID in the `groupId` parameter in the URI."
},
{
"info": {
"name": "Delete a Group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/groups/:groupId",
"params": [
{
"name": "groupId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"type": "path",
"description": "A unique identifier for the group."
}
]
},
"docs": "Remove a group from the system.\n\nSpecify the group ID in the `groupId` parameter in the URI."
},
{
"info": {
"name": "Get Group Members",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/groups/:groupId/members",
"params": [
{
"name": "groupId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvYzY1ZjdkODUtYjY5MS00MmI4LWEyMGItODUzMDY0ZTFkNThiOjM0OGFkYjgxLTI4ZjktNGFiNS1iMmQ2LWU5YjQ5NGU3MmEwNg",
"type": "path",
"description": "A unique identifier for the group."
},
{
"name": "startIndex",
"value": "1",
"type": "query",
"description": "The index to start for group pagination."
},
{
"name": "count",
"value": "100",
"type": "query",
"description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500."
}
]
},
"docs": "Gets the members of a group.\n\n* The default maximum members returned is 500.\n\n* Control parameters is available to page through the members and to control the size of the results."
}
]
},
{
"info": {
"name": "Guest Management",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create a Guest",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/guests/token",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new token for a single guest user. The Service App that creates the guest must have the scope `guest-issuer:write`.\n\nGuests are implicitly created by retrieving the guest access token.\n\nRepeated calls to this API with the same `subject` will create additional tokens without invalidating previous ones. Tokens are valid until the `expiresIn`.\n\nGuests can be renamed by supplying the same `subject` and changing the `displayName.`\n\nTo retrieve a new token for an existing guest, please provid"
},
{
"info": {
"name": "Get Guest Count",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/guests/count"
},
"docs": "To retrieve the number of guests, the scopes `guest-issuer:read` or `guest-issuer:write` are needed."
}
]
},
{
"info": {
"name": "Historical Analytics APIs",
"type": "folder"
},
"items": [
{
"info": {
"name": "Historical Data related to Messaging",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/analytics/messagingMetrics/dailyTotals",
"params": [
{
"name": "from",
"value": "2020-08-01",
"type": "query",
"description": "UTC date starting from which the data needs to be returned."
},
{
"name": "to",
"value": "2020-08-03",
"type": "query",
"description": "UTC date up to which the data needs to be returned"
}
]
},
"docs": "Returns daily aggregates of various metrics related to Webex messaging.\n\nThe base URL for these APIs is **analytics.webexapis.com**, which does not work with the **Try It** feature.
"
},
{
"info": {
"name": "Historical Data related to Room Devices",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/analytics/roomDeviceMetrics/dailyTotals",
"params": [
{
"name": "from",
"value": "2020-08-01",
"type": "query",
"description": "Starting UTC Date from which historical data should be returned."
},
{
"name": "to",
"value": "2020-08-03",
"type": "query",
"description": "Ending UTC Date for which data should be returned."
}
]
},
"docs": "Returns daily aggregates of various metrics related to Room Devices.\n\nThe base URL for these APIs is **analytics.webexapis.com**, which does not work with the **Try It** feature.
"
},
{
"info": {
"name": "Historical Data related to Meetings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/analytics/meetingsMetrics/aggregates",
"params": [
{
"name": "siteUrl",
"value": "cisco.webex.com",
"type": "query",
"description": "URL of the Webex site for which historical data is requested."
},
{
"name": "from",
"value": "2020-08-01",
"type": "query",
"description": "UTC Date starting from which the data needs to be returned"
},
{
"name": "to",
"value": "2020-08-03",
"type": "query",
"description": "UTC Date up to which the data needs to be returned"
}
]
},
"docs": "Return aggregates of various metrics related to meetings for a given Webex site over a specified time range.\n\nThe base URL for these APIs is **analytics.webexapis.com**, which does not work with the **Try It** feature.
"
}
]
},
{
"info": {
"name": "Hybrid Clusters",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Hybrid Clusters",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/hybrid/clusters",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used."
}
]
},
"docs": "List hybrid clusters for an organization. If no `orgId` is specified, the default is the organization of the authenticated user.\n\nOnly an admin auth token with the `spark-admin:hybrid_clusters_read` scope can list clusters."
},
{
"info": {
"name": "Get Hybrid Cluster Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/hybrid/clusters/:hybridClusterId",
"params": [
{
"name": "hybridClusterId",
"value": "Y2lZY76123abbb",
"type": "path",
"description": "The ID of the cluster."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n"
}
]
},
"docs": "Shows details for a hybrid cluster, by ID.\n\nOnly an admin auth token with the `spark-admin:hybrid_clusters_read` scope can see cluster details."
}
]
},
{
"info": {
"name": "Hybrid Connectors",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Hybrid Connectors",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/hybrid/connectors",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used."
}
]
},
"docs": "List hybrid connectors for an organization. If no `orgId` is specified, the default is the organization of the authenticated user.\n\nOnly an admin auth token with the `spark-admin:hybrid_connectors_read` scope can list connectors."
},
{
"info": {
"name": "Get Hybrid Connector Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/hybrid/connectors/:connectorId",
"params": [
{
"name": "connectorId",
"value": "Y2lZY76123",
"type": "path",
"description": "The ID of the connector."
}
]
},
"docs": "Shows details for a hybrid connector, by ID.\n\nOnly an admin auth token with the `spark-admin:hybrid_connectors_read` scope can see connector details."
}
]
},
{
"info": {
"name": "Licenses",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Licenses",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/licenses",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List licenses for this organization."
}
]
},
"docs": "List all licenses for a given organization. If no `orgId` is specified, the default is the organization of the authenticated user.\n\nResponse properties that are not applicable to the license will not be present in the response."
},
{
"info": {
"name": "Get License Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/licenses/:licenseId",
"params": [
{
"name": "licenseId",
"value": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"type": "path",
"description": "The unique identifier for the license."
},
{
"name": "includeAssignedTo",
"value": "user",
"type": "query",
"description": "The type of object to whom the license is assigned to."
},
{
"name": "next",
"value": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0VfVVNFUl9QQUdJTkcvT1RaaFltTXlZV0V0TTJSall5MHhNV1UxTFdFeE5USXRabVV6TkRneE9XTmtZemxo",
"type": "query",
"description": "List the next set of users. Applicable only if `includeAssignedTo` is populated."
},
{
"name": "limit",
"value": "0",
"type": "query",
"description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300."
}
]
},
"docs": "Shows details for a license, by ID.\n\nSpecify the license ID in the `licenseId` parameter in the URI.\nUse the optional query parameter `includeAssignedTo` to get a list of all objects that are assigned with the license. The objects include but not limited to, users including external users. Long result sets will be split into [pages](/docs/basics#pagination).\n\nResponse properties that are not applicable to the license will not be present in the response."
},
{
"info": {
"name": "Assign Licenses to Users",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/licenses/users",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assign licenses and attendee `siteUrls` to existing users. Only an admin can assign licenses. Only existing users can be assigned a license. Assign meeting licenses to users outside your organization (Status will be pending until the user accepts the invite)\n\nAt least one of the following body parameters is required to assign license to the user: `email`, `personId`. For Calling license assignment, properties `phoneNumber` or `extension` are required. If `phoneNumber` is not provided then `locat"
}
]
},
{
"info": {
"name": "Live Monitoring",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Live Meeting metrics categorized by Country",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/livemonitoring/liveMeetingsByCountry",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Retrieve live meeting metrics categorized by country for a specific meeting site or for all meeting sites owned by the customer. \n\nTo retrieve live monitoring information, you must use an administrator token with the `analytics:read_all` [scope](/docs/integrations#scopes). The authenticated user must be a read-only or full administrator of the organization to which the meeting belongs and must not be an external administrator.\n\nTo use this endpoint, the org needs to be licensed for the Webex Pro"
}
]
},
{
"info": {
"name": "Meeting Qualities",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Meeting Qualities",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meeting/qualities",
"params": [
{
"name": "meetingId",
"value": "e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470",
"type": "query",
"description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of media sessions in the response."
},
{
"name": "offset",
"value": "0",
"type": "query",
"description": "Offset from the first result that you want to fetch."
}
]
},
"docs": "Get quality data for a meeting, by `meetingId`. Only organization administrators can retrieve meeting quality data."
}
]
},
{
"info": {
"name": "Organization Contacts",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create a Contact",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/contacts/organizations/:orgId/contacts",
"params": [
{
"name": "orgId",
"value": "0ae87ade-8c8a-4952-af08-318798958d0c",
"type": "path",
"description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creating a new contact for a given organization requires an org admin role.\n\nAt least one of the following body parameters: `phoneNumbers`, `emails`, `sipAddresses` is required to create a new contact for source \"CH\",\n`displayName` is required to create a new contact for source \"Webex4Broadworks\".\n\nUse the optional `groupIds` field to add group IDs in an array within the organisation contact. This will become a group contact."
},
{
"info": {
"name": "Get a Contact",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId",
"params": [
{
"name": "orgId",
"value": "d23736ac-8055-433e-b85a-0fc55c96ead8",
"type": "path",
"description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages."
},
{
"name": "contactId",
"value": "6847ee0f-5e9c-4403-9f0e-0aa8552f7828",
"type": "path",
"description": "The contact ID."
}
]
},
"docs": "Shows details for an organization contact by ID.\nSpecify the organization ID in the `orgId` parameter in the URI, and specify the contact ID in the `contactId` parameter in the URI.\n\n**NOTE**:\nThe `orgId` used in the path for this API are the org UUIDs. They follow a xxxx-xxxx-xxxx-xxxx pattern. If you have an orgId in base64 encoded format (starting with Y2.....) you need to base64 decode the id and extract the UUID from the slug, before you use it in your API call."
},
{
"info": {
"name": "Update a Contact",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId",
"params": [
{
"name": "orgId",
"value": "d23736ac-8055-433e-b85a-0fc55c96ead8",
"type": "path",
"description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages."
},
{
"name": "contactId",
"value": "6847ee0f-5e9c-4403-9f0e-0aa8552f7828",
"type": "path",
"description": "The contact ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update details for contact by ID. Only an admin can update a contact.\nSpecify the organization ID in the `orgId` parameter in the URI, and specify the contact ID in the `contactId` parameter in the URI.\n\nUse the optional `groupIds` field to update the group IDs by changing the existing array. You can add or remove one or all groups. To remove all associated groups, pass an empty array in the `groupIds` field."
},
{
"info": {
"name": "Delete a Contact",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/contacts/organizations/:orgId/contacts/:contactId",
"params": [
{
"name": "orgId",
"value": "d23736ac-8055-433e-b85a-0fc55c96ead8",
"type": "path",
"description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages."
},
{
"name": "contactId",
"value": "6847ee0f-5e9c-4403-9f0e-0aa8552f7828",
"type": "path",
"description": "The contact ID."
}
]
},
"docs": "Remove a contact from the organization. Only an admin can remove a contact.\n\nSpecify the organization ID in the `orgId` parameter in the URI, and specify the contact ID in the `contactId` parameter in the URI."
},
{
"info": {
"name": "List Contacts",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/contacts/organizations/:orgId/contacts/search",
"params": [
{
"name": "orgId",
"value": "d23736ac-8055-433e-b85a-0fc55c96ead8",
"type": "path",
"description": "The organization ID."
},
{
"name": "keyword",
"value": "john.andersen@example.com",
"type": "query",
"description": "List contacts with a keyword."
},
{
"name": "source",
"value": "CH",
"type": "query",
"description": "List contacts with source."
},
{
"name": "limit",
"value": "100",
"type": "query",
"description": "Limit the maximum number of contact in the response.\n + Default: 100\n"
},
{
"name": "groupIds",
"value": "9ac175bf-0249-4287-8fb3-e320e525fcf6,23b95024-7063-404c-9a3c-37532f53a9ce",
"type": "query",
"description": "Filter contacts based on groups."
}
]
},
"docs": "List contacts in the organization. The default limit is `100`.\n\n`keyword` can be the value of \"displayName\", \"firstName\", \"lastName\", \"email\". An empty string of `keyword` means get all contacts.\n\n`groupIds` is a comma separated list group IDs. Results are filtered based on those group IDs.\n\nLong result sets will be split into [pages](/docs/basics#pagination)."
},
{
"info": {
"name": "Bulk Create or Update Contacts",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk",
"params": [
{
"name": "orgId",
"value": "0ae87ade-8c8a-4952-af08-318798958d0c",
"type": "path",
"description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create or update contacts in bulk. Update an existing contact by specifying the contact ID in the `contactId` parameter in the request body."
},
{
"info": {
"name": "Bulk Delete Contacts",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/contacts/organizations/:orgId/contacts/bulk/delete",
"params": [
{
"name": "orgId",
"value": "0ae87ade-8c8a-4952-af08-318798958d0c",
"type": "path",
"description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Delete contacts in bulk."
}
]
},
{
"info": {
"name": "Organizations",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Organizations",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations"
},
"docs": "List all organizations visible by your account. The results will not be [paginated](/docs/basics#pagination)."
},
{
"info": {
"name": "Get Organization Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations/:orgId",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "path",
"description": "The unique identifier for the organization."
}
]
},
"docs": "Shows details for an organization, by ID.\n\nSpecify the org ID in the `orgId` parameter in the URI."
},
{
"info": {
"name": "Delete Organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/organizations/:orgId",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "path",
"description": "The unique identifier for the organization."
}
]
},
"docs": "Deletes an organization, by ID. It may take up to 10 minutes for the organization to be deleted after the response is returned.\n
\nSpecify the org ID in the `orgId` parameter in the URI.\n\nDeleting your organization permanently deletes all of the information associated with your organization and is irreversible.
\n\nDeleting an Organization may fail with a HTTP 409 Conflict response and encounter one or more of the errors described below. Resolve "
}
]
},
{
"info": {
"name": "Partner Administrators",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all customers managed by a partner admin",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/partner/organizations",
"params": [
{
"name": "managedBy",
"value": "Y2LZY29ZCGFYAZOVL3VZL1BFT1BMRS9JOTYWOTZIYI1KYTRHLTQ3NZETYTC2ZI1KNDEZODQWZWVM1TQ",
"type": "query",
"description": "List customer orgs associated with this person ID."
}
]
},
"docs": "Get all customer organizations managed by given partner admin, in the `managedBy` request parameter. The `managedBy` user typically has the role of a Partner Admin. In case where a Partner Full Admin or Partner Read-Only admin is selected an error like \"The user already has access to all customers managed by their partner organization.\" is shown as a Partner Admin (Full and Read-Only) is able to manage all customers by default. This does not include customers managed through Customer Groups.\n\nTh"
},
{
"info": {
"name": "Get all partner admins assigned to a customer",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmins",
"params": [
{
"name": "orgId",
"value": "Y2LZY29ZCGFYAZOVL3VZL09SR0FOSVPBVELPTI8XZWI2NWZKZI05NJQZLTQXN2YTOTK3NC1HZDCYY2FLM9UXMGY",
"type": "path",
"description": "List partner admins associated with this customer org ID."
}
]
},
"docs": "For a given customer, get all the partner admins with their role details. This does not include partner admins who have access through Customer Groups.\nThis API can be used by Partner Full Admins.\n\nSpecify the `orgId` in the path parameter."
},
{
"info": {
"name": "Assign partner admin to a customer",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/assign",
"params": [
{
"name": "orgId",
"value": "Y2LZY29ZCGFYAZOVL3VZL09SR0FOSVPBVELPTI85NMFIYZJHYS0ZZGNJLTEXZTUTYTE1MI1MZTM0ODE5Y2RJOWE",
"type": "path",
"description": "The ID of the customer organization."
},
{
"name": "personId",
"value": "Y2LZY29ZCGFYAZOVL3VZL1BFT1BMRS80ZGEZYTI0OC05YJBHLTQXMDGTODU0NC1INTQWMZEYZTU2M2E",
"type": "path",
"description": "User ID of the partner admin in the partners org."
}
]
},
"docs": "Assign a specific Partner Admin to a customer organization. The partner admin is a user that has the Partner Administrator role.\nOther partner roles, such as Partner Full Administrator are not applicable for this API, since this role manages all customer organizations.\n\nThis API can be used b a Partner Full Admin.\n\nSpecify the `orgId` and the `personId` in the path param."
},
{
"info": {
"name": "Unassign partner admin from a customer",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/partner/organizations/:orgId/partnerAdmin/:personId/unassign",
"params": [
{
"name": "orgId",
"value": "Y2LZY29ZCGFYAZOVL3VZL09SR0FOSVPBVELPTI85NMFIYZJHYS0ZZGNJLTEXZTUTYTE1MI1MZTM0ODE5Y2RJOWE",
"type": "path",
"description": "The ID of the customer organization."
},
{
"name": "personId",
"value": "Y2LZY29ZCGFYAZOVL3VZL1BFT1BMRS80ZGEZYTI0OC05YJBHLTQXMDGTODU0NC1INTQWMZEYZTU2M2E",
"type": "path",
"description": "User ID of the partner admin in the partners org."
}
]
},
"docs": "Unassign a specific partner admin from a customer organization. Unassigning a customer organization from a partner admin does not remove the role from the user. If a partner admin is also managing the customer organization through a Customer Group, they will continue to have access.\nThis API can be used by Partner Full Admin.\n\nSpecify the `orgId` and the `personId` in the path param."
},
{
"info": {
"name": "Revoke all partner admin roles for a given person ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/partner/organizations/partnerAdmin/:personId",
"params": [
{
"name": "personId",
"value": "Y2LZY29ZCGFYAZOVL3VZL1BFT1BMRS9JOTYWOTZIYI1KYTRHLTQ3NZETYTC2ZI1KNDEZODQWZWVM1TQ",
"type": "path",
"description": "ID of the user whose partner roles needs to be revoked."
}
]
},
"docs": "Revoke all partner administrator roles from a user, thereby revoking access to Partner Hub and all managed customer organizations.\nThis action does not grant or revoke Control Hub administrator roles (e.g. Full Administrator, User and Device Administrator, etc.).\nThis API can be used by Partner Full Admin.\nSpecify the `personId` in the path param."
}
]
},
{
"info": {
"name": "Partner Reports/Templates",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Reports",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/partner/reports",
"params": [
{
"name": "service",
"value": "Webex",
"type": "query",
"description": "List reports which use this service."
},
{
"name": "templateId",
"value": "5",
"type": "query",
"description": "List reports with this report template ID."
},
{
"name": "from",
"value": "2024-05-01",
"type": "query",
"description": "List reports that were created on or after this date."
},
{
"name": "to",
"value": "2024-05-05",
"type": "query",
"description": "List reports that were created before this date."
},
{
"name": "regionId",
"value": "US",
"type": "query",
"description": "Data in the report will be from organizations in this region, for example, US, CA, or EU."
},
{
"name": "onBehalfOfSubPartnerOrgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"type": "query",
"description": "The encoded organization ID for the sub partner."
}
]
},
"docs": "Lists all reports previously generated from a given region. Use query parameters to filter the response. The parameters are optional.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_read` and `identity:people_read` scopes.\n\nCSV reports for Webex suite services are only supported for organizations based in one region per API request. Organizations based in a different region will require a separate request with region specified.Reports are usually provided in zip format. A content-header application/zip or application/octet-stream does indicate the zip format. There is usually no .zip file extension.
"
},
{
"info": {
"name": "Delete a Report",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/partner/reports/:reportId",
"params": [
{
"name": "reportId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9SRVBPUlQvYWQwZDIwNTc1ZGEwNDVhNDhmYWQ0N2Q5NzRhYjQxZjI",
"type": "path",
"description": "The unique identifier for the report."
},
{
"name": "onBehalfOfSubPartnerOrgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"type": "query",
"description": "The encoded organization ID for the sub partner."
}
]
},
"docs": "Remove a report from the system.\n\nSpecify the report ID in the `reportId` parameter in the URI\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_write` scope."
},
{
"info": {
"name": "List Report Templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/partner/reports/templates",
"params": [
{
"name": "onBehalfOfSubPartnerOrgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"type": "query",
"description": "The encoded organization ID for the sub partner."
}
]
},
"docs": "List report templates. Report templates are available for use with the Partner Reports API.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_read` and `identity:people_read` [scopes](/docs/integrations#scopes). The authenticated user must be a Partner full administrator or Partner read-only administrator of the organization."
}
]
},
{
"info": {
"name": "People",
"type": "folder"
},
"items": [
{
"info": {
"name": "List People",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people",
"params": [
{
"name": "email",
"value": "john.andersen@example.com",
"type": "query",
"description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org."
},
{
"name": "displayName",
"value": "John Andersen",
"type": "query",
"description": "List people whose name starts with this string. For non-admin requests, either this or email are required."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"type": "query",
"description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter."
},
{
"name": "roles",
"value": "Y2lzY29zcGFyazovL3VzL1JPTEUvYXRsYXMtcG9ydGFsLnBhcnRuZXIuc2FsZXNhZG1pbg",
"type": "query",
"description": "List of roleIds separated by commas."
},
{
"name": "callingData",
"value": "true",
"type": "query",
"description": "Include Webex Calling user details in the response."
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"type": "query",
"description": "List people present in this location."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50."
},
{
"name": "excludeStatus",
"value": "true",
"type": "query",
"description": "Omit people status/availability to enhance query performance."
}
]
},
"docs": "List people in your organization. For most users, either the `email` or `displayName` parameter is required. Admin users can omit these fields and list all users in their organization.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be returned for people within your organization or an organization you manage. Presence information will not be returned if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6w"
},
{
"info": {
"name": "Create a Person",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/people",
"params": [
{
"name": "callingData",
"value": "true",
"type": "query",
"description": "Include Webex Calling user details in the response."
},
{
"name": "minResponse",
"value": "true",
"type": "query",
"description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new user account for a given organization. Only an admin can create a new user account.\n\nAt least one of the following body parameters is required to create a new user: `displayName`, `firstName`, `lastName`.\n\nCurrently, users may have only one email address associated with their account. The `emails` parameter is an array, which accepts multiple values to allow for future expansion, but currently only one email address will be used for the new user.\n\nAdmin users can include `Webex call"
},
{
"info": {
"name": "Get Person Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "callingData",
"value": "true",
"type": "query",
"description": "Include Webex Calling user details in the response."
}
]
},
"docs": "Shows details for a person, by ID.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be displayed for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/).\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`.\n\nSpecify the pe"
},
{
"info": {
"name": "Update a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "callingData",
"value": "true",
"type": "query",
"description": "Include Webex Calling user details in the response."
},
{
"name": "showAllTypes",
"value": "true",
"type": "query",
"description": "Include additional user data like `#attendee` role."
},
{
"name": "minResponse",
"value": "true",
"type": "query",
"description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update details for a person, by ID.\n\nSpecify the person ID in the `personId` parameter in the URI. Only an admin can update a person details.\n\nInclude all details for the person. This action expects all user details to be present in the request. A common approach is to first [GET the person's details](/docs/api/v1/people/get-person-details), make changes, then PUT both the changed and unchanged values.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifyi"
},
{
"info": {
"name": "Delete a Person",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/people/:personId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"type": "path",
"description": "A unique identifier for the person."
}
]
},
"docs": "Remove a person from the system.\n\n**Required Administrator Roles:**\n\nThe following administrators have permission to use this API:\n\n**Customer Organization:**\n- Full administrator\n- User administrator\n\n**Partner/External Access:**\n- External full administrator\n\n**Note:** External read-only administrators, provisioning administrators, and device administrators cannot delete users.\n\nSpecify the person ID in the `personId` parameter in the URI."
},
{
"info": {
"name": "Get My Own Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/me",
"params": [
{
"name": "callingData",
"value": "true",
"type": "query",
"description": "Include Webex Calling user details in the response."
}
]
},
"docs": "Get profile details for the authenticated user. This is the same as GET `/people/{personId}` using the Person ID associated with your Auth token.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true."
}
]
},
{
"info": {
"name": "Recording Report",
"type": "folder"
},
"items": [
{
"info": {
"name": "List of Recording Audit Report Summaries",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/recordingReport/accessSummary",
"headers": [
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "max",
"value": "",
"type": "query",
"description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`."
},
{
"name": "from",
"value": "2020-07-12T09:30:00+08:00",
"type": "query",
"description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days."
},
{
"name": "to",
"value": "2020-07-31T09:30:00+08:00",
"type": "query",
"description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user."
},
{
"name": "siteUrl",
"value": "example.webex.com",
"type": "query",
"description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API."
}
]
},
"docs": "Lists of recording audit report summaries. You can specify a date range and the maximum number of recording audit report summaries to return.\n\nOnly recording audit report summaries of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the recording audit report summaries of th"
},
{
"info": {
"name": "Get Recording Audit Report Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/recordingReport/accessDetail",
"headers": [
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "recordingId",
"value": "4f914b1dfe3c4d11a61730f18c0f5387",
"type": "query",
"description": "A unique identifier for the recording."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user."
},
{
"name": "max",
"value": "",
"type": "query",
"description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`."
}
]
},
"docs": "Retrieves details for a recording audit report with a specified recording ID.\n\nOnly recording audit report details of meetings hosted by or shared with the authenticated user may be retrieved.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined."
},
{
"info": {
"name": "List Meeting Archive Summaries",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/recordingReport/meetingArchiveSummaries",
"headers": [
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "max",
"value": "",
"type": "query",
"description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`."
},
{
"name": "from",
"value": "2020-07-12T09:30:00+08:00",
"type": "query",
"description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days."
},
{
"name": "to",
"value": "2020-07-31T09:30:00+08:00",
"type": "query",
"description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days."
},
{
"name": "siteUrl",
"value": "example.webex.com",
"type": "query",
"description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API."
}
]
},
"docs": "Lists of meeting archive summaries. You can specify a date range and the maximum number of meeting archive summaries to return.\n\nMeeting archive summaries are only available to full administrators, not even the meeting host.\n\nThe list returned is sorted in descending order by the date and time that the archives were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the meeting archive summaries of the specified site will be listed; otherwis"
},
{
"info": {
"name": "Get Meeting Archive Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId",
"headers": [
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "archiveId",
"value": "7d7ea5f42b921eace05386ca24ad730e_R_1000634462",
"type": "path",
"description": "A unique identifier for the meeting archive summary."
}
]
},
"docs": "Retrieves details for a meeting archive report with a specified archive ID, which contains recording metadata.\n\nMeeting archive details are only available to full administrators, not even the meeting host.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined."
}
]
},
{
"info": {
"name": "Recordings",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Recordings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/recordings",
"headers": [
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "max",
"value": "",
"type": "query",
"description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`."
},
{
"name": "from",
"value": "2020-07-12T09:30:00+08:00",
"type": "query",
"description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`."
},
{
"name": "to",
"value": "2020-07-31T09:30:00+08:00",
"type": "query",
"description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`."
},
{
"name": "meetingId",
"value": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"type": "query",
"description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user."
},
{
"name": "siteUrl",
"value": "example.webex.com",
"type": "query",
"description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API."
},
{
"name": "integrationTag",
"value": "dbaeceebea5c4a63ac9d5ef1edfe36b9",
"type": "query",
"description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\"."
},
{
"name": "topic",
"value": "John's Meeting",
"type": "query",
"description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner."
},
{
"name": "format",
"value": "ARF",
"type": "query",
"description": "Recording's file format. If specified, the API filters recordings by format."
},
{
"name": "serviceType",
"value": "MeetingCenter",
"type": "query",
"description": "The service type for recordings. If this item is specified, the API filters recordings by service-type."
},
{
"name": "status",
"value": "available",
"type": "query",
"description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified."
}
]
},
"docs": "Lists recordings. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nOnly recordings of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. **NOTE**: when `m"
},
{
"info": {
"name": "List Recordings For an Admin or Compliance Officer",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/admin/recordings",
"headers": [
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "max",
"value": "",
"type": "query",
"description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`."
},
{
"name": "from",
"value": "2020-07-12T09:30:00+08:00",
"type": "query",
"description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days."
},
{
"name": "to",
"value": "2020-07-31T09:30:00+08:00",
"type": "query",
"description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time."
},
{
"name": "meetingId",
"value": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"type": "query",
"description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored."
},
{
"name": "siteUrl",
"value": "example.webex.com",
"type": "query",
"description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API."
},
{
"name": "integrationTag",
"value": "dbaeceebea5c4a63ac9d5ef1edfe36b9",
"type": "query",
"description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\"."
},
{
"name": "topic",
"value": "John's Meeting",
"type": "query",
"description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner."
},
{
"name": "format",
"value": "ARF",
"type": "query",
"description": "Recording's file format. If specified, the API filters recordings by format."
},
{
"name": "serviceType",
"value": "MeetingCenter",
"type": "query",
"description": "The service type for recordings. If specified, the API filters recordings by service type."
},
{
"name": "status",
"value": "available",
"type": "query",
"description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin."
}
]
},
"docs": "List recordings for an admin or compliance officer. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. Please note that when `meetingId` is specified, parameters of `siteUrl`, `fr"
},
{
"info": {
"name": "Delete a Recording By an Admin",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/admin/recordings/:recordingId",
"params": [
{
"name": "recordingId",
"value": "4f914b1dfe3c4d11a61730f18c0f5387",
"type": "path",
"description": "A unique identifier for the recording."
}
]
},
"docs": "Removes a recording with a specified recording ID by an admin. The deleted recording cannot be recovered. It will be inaccessible to regular users (host, attendees and shared) or an admin, but it will be still available to the Compliance Officer.\n\nAny recording on a site which is managed by the admin can be deleted by him.\n\nThe `temporaryDirectDownloadLinks` of a recording which are retrieved by the [Get Recording Details](/docs/api/v1/recordings/get-recording-details) API are still available to"
},
{
"info": {
"name": "Get Recording Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/recordings/:recordingId",
"headers": [
{
"name": "timezone",
"value": "UTC"
},
{
"name": "siteUrl",
"value": "example.webex.com"
}
],
"params": [
{
"name": "recordingId",
"value": "4f914b1dfe3c4d11a61730f18c0f5387",
"type": "path",
"description": "A unique identifier for the recording."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user."
}
]
},
"docs": "Retrieves details for a recording with a specified recording ID.\n\nOnly recordings of meetings hosted by or shared with the authenticated user may be retrieved.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*\n\n* `siteUrl`: Optional request header parameter. If specified, retrieve the recording deta"
},
{
"info": {
"name": "Delete a Recording",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/recordings/:recordingId",
"params": [
{
"name": "recordingId",
"value": "4f914b1dfe3c4d11a61730f18c0f5387",
"type": "path",
"description": "A unique identifier for the recording."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Removes a recording with a specified recording ID. The deleted recording cannot be recovered. If a Compliance Officer deletes another user's recording, the recording will be inaccessible to regular users (host, attendees and shared), but will be still available to the Compliance Officer.\n\nOnly recordings of meetings hosted by the authenticated user can be deleted.\n\nThe `temporaryDirectDownloadLinks` of a recording which are retrieved by the [Get Recording Details](/docs/api/v1/recordings/get-rec"
},
{
"info": {
"name": "Move Recordings into the Recycle Bin",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/recordings/softDelete",
"params": [
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Move recordings into the recycle bin with recording IDs. Recordings in the recycle bin can be recovered by [Restore Recordings from Recycle Bin](/docs/api/v1/recordings/restore-recordings-from-recycle-bin) API. If you'd like to empty recordings from the recycle bin, you can use [Purge Recordings from Recycle Bin](/docs/api/v1/recordings/purge-recordings-from-recycle-bin) API to purge all or some of them.\n\nOnly recordings of meetings hosted by the authenticated user can be moved into the recycle "
},
{
"info": {
"name": "Restore Recordings from Recycle Bin",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/recordings/restore",
"params": [
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Restore all or some recordings from the recycle bin. Only recordings of meetings hosted by the authenticated user can be restored from recycle bin.\n\n* If `restoreAll` is `true`, `recordingIds` should be empty.\n\n* If `restoreAll` is `false`, `recordingIds` should not be empty and its maximum size is `100`.\n\n* All the IDs of `recordingIds` should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified."
},
{
"info": {
"name": "Purge Recordings from Recycle Bin",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/recordings/purge",
"params": [
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Purge recordings from recycle bin with recording IDs or purge all the recordings that are in the recycle bin.\n\nOnly recordings of meetings hosted by the authenticated user can be purged from recycle bin.\n\n* If `purgeAll` is `true`, `recordingIds` should be empty.\n\n* If `purgeAll` is `false`, `recordingIds` should not be empty and its maximum size is `100`.\n\n* All the IDs of `recordingIds` should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified."
},
{
"info": {
"name": "Share a Recording",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/recordings/:recordingId/accessList",
"params": [
{
"name": "recordingId",
"value": "4f914b1dfe3c4d11a61730f18c0f5387",
"type": "path",
"description": "A unique identifier for the recording."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Share or unshare a recording with other users by recording ID and email addresses."
},
{
"info": {
"name": "Share a Recording Link",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/recordings/accessList",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Share or unshare a recording with other users by recording link and email addresses."
},
{
"info": {
"name": "List Group Recordings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/group/recordings",
"headers": [
{
"name": "timezone",
"value": "UTC"
},
{
"name": "hostEmail",
"value": "john.andersen@example.com"
}
],
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk",
"type": "query",
"description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified."
},
{
"name": "max",
"value": "",
"type": "query",
"description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`."
},
{
"name": "from",
"value": "2020-07-12T09:30:00+08:00",
"type": "query",
"description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days."
},
{
"name": "to",
"value": "2020-07-31T09:30:00+08:00",
"type": "query",
"description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days."
},
{
"name": "siteUrl",
"value": "example.webex.com",
"type": "query",
"description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API."
},
{
"name": "integrationTag",
"value": "dbaeceebea5c4a63ac9d5ef1edfe36b9",
"type": "query",
"description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\"."
},
{
"name": "topic",
"value": "John's Meeting",
"type": "query",
"description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner."
},
{
"name": "format",
"value": "ARF",
"type": "query",
"description": "Recording's file format. If specified, the API filters recordings by format."
},
{
"name": "serviceType",
"value": "MeetingCenter",
"type": "query",
"description": "The service type for recordings. If specified, the API filters recordings by service type."
}
]
},
"docs": "List group recordings for a service app which has group recording access. You can specify a date range, the maximum number of recordings to return, and `personId` or `hostEmail` of whom the recordings will be retrieved.\n\n* The list returned is sorted in descending order by the date and time that the recordings were created.\n\n* Only recordings which are in the `available` status and not shared by others can be listed. Those in the `deleted` or `purged` status or shared by others can't be listed.\n"
},
{
"info": {
"name": "Get Group Recording Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/group/recordings/:recordingId",
"headers": [
{
"name": "timezone",
"value": "UTC"
},
{
"name": "hostEmail",
"value": "john.andersen@example.com"
}
],
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk",
"type": "query",
"description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified."
},
{
"name": "recordingId",
"value": "4f914b1dfe3c4d11a61730f18c0f5387",
"type": "path",
"description": "A unique identifier for the recording."
}
]
},
"docs": "Retrieves details for a group recording for a service app which has group recording access.\n\n* Only recordings which are in the `available` status and not shared by others can be listed. Those in the `deleted` or `purged` status or shared by others can't be listed.\n\n* One of the `personId` parameter and `hostEmail` header must be specified so that only recordings of meetings hosted by the person of `personId` or `hostEmail` will be returned.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https"
}
]
},
{
"info": {
"name": "Report Templates",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Report Templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/report/templates"
},
"docs": "List all the available report templates that can be generated.\n\nCSV (comma separated value) reports for Webex services are only supported for organizations based in the North American region. Organizations based in other regions will return blank CSV files for any Webex reports.\n\n#### Validation Fields\n\nEach template includes validation rules that specify which fields are required when generating a report using the [Reports API](/docs/api/v1/reports). The possible validation field values are:\n\n-"
}
]
},
{
"info": {
"name": "Reports",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Reports",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/reports",
"params": [
{
"name": "reportId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"type": "query",
"description": "List reports by ID."
},
{
"name": "service",
"value": "Webex",
"type": "query",
"description": "List reports which use this service."
},
{
"name": "templateId",
"value": "5",
"type": "query",
"description": "List reports with this report template ID."
},
{
"name": "from",
"value": "2020-05-01",
"type": "query",
"description": "List reports that were created on or after this date."
},
{
"name": "to",
"value": "2020-05-05",
"type": "query",
"description": "List reports that were created before this date."
}
]
},
"docs": "Lists all reports. Use query parameters to filter the response. The parameters are optional. However, `from` and `to` parameters should be provided together.\n\n**Notes**:\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.\n\nReports are usually provided in zip format. A Content-header `application/zip` or `application/octet-stream` does indicate the"
},
{
"info": {
"name": "Create a Report",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/reports",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new report. For each `templateId`, there are a set of validation rules that need to be followed. For example, for templates belonging to Webex, the user needs to provide `siteUrl`. These validation rules can be retrieved via the [Report Templates API](/docs/api/v1/report-templates).\n\nThe 'templateId' parameter is a number. However, it is a limitation of developer.webex.com platform that it is passed as a string when you try to test the API from here.\n\nCSV reports for Webex suite service"
},
{
"info": {
"name": "Get Report Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/reports/:reportId",
"params": [
{
"name": "reportId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"type": "path",
"description": "The unique identifier for the report."
}
]
},
"docs": "Shows details for a report, by report ID.\n\nSpecify the report ID in the `reportId` parameter in the URI.\n\n**Notes**:\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.\n\nReports are usually provided in zip format. A Content-header `application/zip` or `application/octet-stream` does indicate the zip format. There is usually no .zip file extens"
},
{
"info": {
"name": "Delete a Report",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/reports/:reportId",
"params": [
{
"name": "reportId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"type": "path",
"description": "The unique identifier for the report."
}
]
},
"docs": "Remove a report from the system.\n\nSpecify the report ID in the `reportId` parameter in the URI\n\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports."
}
]
},
{
"info": {
"name": "Resource Group Memberships",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Resource Group Memberships",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/resourceGroup/memberships",
"params": [
{
"name": "licenseId",
"value": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvMWNjYmJjMTctZDYxNi00ZDc0LTg2NGItYjFmM2IwNzAxZmJhOk1TXzAzMDRjMDkzLTFjM2MtNDRlMC1iYjBhLWU1ZDE2NDM2NmQ1OQ",
"type": "query",
"description": "List resource group memberships for a license, by ID."
},
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZWZiNWVkMC0wY2FmLTRiNTYtYmMxMS03MzhlOWRhMDU5MjM",
"type": "query",
"description": "List resource group memberships for a person, by ID."
},
{
"name": "personOrgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
"type": "query",
"description": "List resource group memberships for an organization, by ID."
},
{
"name": "status",
"value": "activated",
"type": "query",
"description": "Limit resource group memberships to a specific status."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of resource group memberships in the response."
}
]
},
"docs": "Lists all resource group memberships for an organization.\n\nUse query parameters to filter the response."
},
{
"info": {
"name": "List Resource Group Memberships V2",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/resourceGroup/memberships/v2",
"params": [
{
"name": "licenseId",
"value": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvMWNjYmJjMTctZDYxNi00ZDc0LTg2NGItYjFmM2IwNzAxZmJhOk1TXzAzMDRjMDkzLTFjM2MtNDRlMC1iYjBhLWU1ZDE2NDM2NmQ1OQ",
"type": "query",
"description": "List resource group memberships for a license, by ID."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZWZiNWVkMC0wY2FmLTRiNTYtYmMxMS03MzhlOWRhMDU5MjM",
"type": "query",
"description": "List resource group memberships by ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
"type": "query",
"description": "List resource group memberships for an organization, by ID."
},
{
"name": "status",
"value": "activated",
"type": "query",
"description": "Limit resource group memberships to a specific status."
},
{
"name": "type",
"value": "User",
"type": "query",
"description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of resource group memberships in the response."
}
]
},
"docs": "Lists all resource group memberships for an organization having filtering option based on entity type (User / Workspace).\n\nUse query parameters to filter the response."
},
{
"info": {
"name": "Get Resource Group Membership Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId",
"params": [
{
"name": "resourceGroupMembershipId",
"value": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQX01FTUJFUlNISVAvcGVyc29uSWQ6bGljZW5zZUlk",
"type": "path",
"description": "The unique identifier for the resource group membership."
}
]
},
"docs": "Shows details for a resource group membership, by ID.\n\nSpecify the resource group membership ID in the `resourceGroupMembershipId` URI parameter."
},
{
"info": {
"name": "Update a Resource Group Membership",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/resourceGroup/memberships/:resourceGroupMembershipId",
"params": [
{
"name": "resourceGroupMembershipId",
"value": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQX01FTUJFUlNISVAvcGVyc29uSWQ6bGljZW5zZUlk",
"type": "path",
"description": "The unique identifier for the resource group membership."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a resource group membership, by ID.\n\nSpecify the resource group membership ID in the `resourceGroupMembershipId` URI parameter.\n\nOnly the `resourceGroupId` can be changed with this action. Resource group memberships with a `status` of \"pending\" cannot be updated. For more information about resource group memberships, see the [Managing Hybrid Services](/docs/api/guides/managing-hybrid-services-licenses#webex-resource-groups) guide."
}
]
},
{
"info": {
"name": "Resource Groups",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Resource Groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/resourceGroups",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter."
}
]
},
"docs": "List resource groups.\n\nUse query parameters to filter the response."
},
{
"info": {
"name": "Get Resource Group Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/resourceGroups/:resourceGroupId",
"params": [
{
"name": "resourceGroupId",
"value": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQL2RlZmF1bHQ",
"type": "path",
"description": "The unique identifier for the resource group."
}
]
},
"docs": "Shows details for a resource group, by ID.\n\nSpecify the resource group ID in the `resourceGroupId` parameter in the URI."
}
]
},
{
"info": {
"name": "Roles",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Roles",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/roles"
},
"docs": "List all roles. Must be called by an admin user."
},
{
"info": {
"name": "Get Role Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/roles/:roleId",
"params": [
{
"name": "roleId",
"value": "Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"type": "path",
"description": "The unique identifier for the role."
}
]
},
"docs": "Shows details for a role, by ID.\n\nSpecify the role ID in the `roleId` parameter in the URI."
}
]
},
{
"info": {
"name": "Bulk Manage SCIM 2 Users and Groups",
"type": "folder"
},
"items": [
{
"info": {
"name": "User bulk API",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Bulk",
"params": [
{
"name": "orgId",
"value": "0ae87ade-8c8a-4952-af08-318798958d0c",
"type": "path",
"description": "Webex Identity assigned organization identifier for user's organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\n**Usage**:\n\n1. The input JSON must conform to the following schema: 'urn:ietf:params:scim:api:messages:2.0:BulkRequest'.\n\n1. The request must be accompanied with a body in JSON format according to the standard SCIM schema definition.\n The maximum number of operations in a request is 100; an error is thrown if the limit is exceeded.\n\n1. `failO"
}
]
},
{
"info": {
"name": "SCIM 2 Groups",
"type": "folder"
},
"items": [
{
"info": {
"name": "Search groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Groups",
"params": [
{
"name": "orgId",
"value": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"type": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used."
},
{
"name": "filter",
"value": "displayName Eq \"group1%40example.com \" or displayName Eq \"group2%40example.com \"",
"type": "query",
"description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n"
},
{
"name": "attributes",
"value": "displayName",
"type": "query",
"description": "The attributes to return."
},
{
"name": "excludedAttributes",
"value": "members",
"type": "query",
"description": "Attributes to be excluded from the return."
},
{
"name": "sortBy",
"value": "displayName",
"type": "query",
"description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort."
},
{
"name": "sortOrder",
"value": "ascending",
"type": "query",
"description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`."
},
{
"name": "startIndex",
"value": "1",
"type": "query",
"description": "An integer indicating the 1-based index of the first query result. The default is 1."
},
{
"name": "count",
"value": "10",
"type": "query",
"description": "An integer indicating the desired maximum number of query results per page. The default is 100."
},
{
"name": "includeMembers",
"value": "false",
"type": "query",
"description": "Default \"false\". If false, no members returned."
},
{
"name": "memberType",
"value": "user",
"type": "query",
"description": "Filter the members by member type. Sample data: `user`, `machine`, `group`."
}
]
},
"docs": "Retrieve a list of groups in the organization.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n
\n\n**Authorization**\n\nAn OAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`"
},
{
"info": {
"name": "Create a group",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Groups",
"params": [
{
"name": "orgId",
"value": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"type": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new group for a given organization. The group may optionally be created with group members.\n\n
\n\n**Authorization**\n\nOAuth token returned by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n
\n\n**Usage**:\n\n1. The input JSON must conform to one of the following schemas:\n - `urn:ietf:params:scim:schemas:core:2.0:Group`\n - `urn:scim:schema"
},
{
"info": {
"name": "Get a group",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId",
"params": [
{
"name": "orgId",
"value": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"type": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used."
},
{
"name": "groupId",
"value": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"type": "path",
"description": "A unique identifier for the group."
},
{
"name": "excludedAttributes",
"value": "members",
"type": "query",
"description": "Attributes to be excluded from the return."
}
]
},
"docs": "Retrieve details for a group, by ID.\n\nOptionally, members can be retrieved with this request. The maximum number of members returned is 500.\n\n
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`"
},
{
"info": {
"name": "Update a group with PUT",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId",
"params": [
{
"name": "orgId",
"value": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"type": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used."
},
{
"name": "groupId",
"value": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"type": "path",
"description": "A unique identifier for the group."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Replace the contents of the Group.\n\nSpecify the group ID in the `groupId` parameter in the URI.\n\n
\n\n**Authorization**\n\nOAuth token returned by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n
\n\n**Usage**:\n\n1. The input JSON must conform to one of the following schemas:\n - `urn:ietf:params:scim:schemas:core:2.0:Group`\n - `urn:scim:schemas:ext"
},
{
"info": {
"name": "Update a group with PATCH",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId",
"params": [
{
"name": "orgId",
"value": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"type": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used."
},
{
"name": "groupId",
"value": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"type": "path",
"description": "A unique identifier for the group."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update group attributes with PATCH.\n\nSpecify the group ID in the `groupId` parameter in the URI.\n\n
\n\n**Authorization**\n\nOAuth token returned by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n
\n\n**Usage**:\n\n1. The input JSON must conform to one of the following schemas:\n - `urn:ietf:params:scim:schemas:core:2.0:Group`\n - `urn:scim:schemas:ex"
},
{
"info": {
"name": "Delete a group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId",
"params": [
{
"name": "orgId",
"value": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"type": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used."
},
{
"name": "groupId",
"value": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"type": "path",
"description": "A unique identifier for the group."
}
]
},
"docs": "Remove a group from the system.\n\nSpecify the group ID in the `groupId` parameter in the URI.\n\n
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`"
},
{
"info": {
"name": "Get Group Members",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members",
"params": [
{
"name": "orgId",
"value": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"type": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used."
},
{
"name": "groupId",
"value": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"type": "path",
"description": "A unique identifier for the group."
},
{
"name": "startIndex",
"value": "1",
"type": "query",
"description": "The index to start for group pagination."
},
{
"name": "count",
"value": "100",
"type": "query",
"description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500."
},
{
"name": "memberType",
"value": "user",
"type": "query",
"description": "Filter the members by member type. Sample data: `user`, `machine`, `group`."
}
]
},
"docs": "Returns the members of a group.\n\n- The default maximum number of members returned is 500.\n\n- Control parameters are available to page through the members and to control the size of the results.\n\n- Long result sets are split into [pages](/docs/basics#pagination).\n\n**Note**\nLocation groups are different from SCIM groups. You cannot search for identities in a location via groups.\n\n
\n\n**Authorization**\n\nOAuth token returned by the Identity Broker.\n\n
\n\nOne of the following OAuth scopes is req"
}
]
},
{
"info": {
"name": "SCIM 2 Schemas",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Group Schema",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/Schemas/SCIM2/Group"
},
"docs": "This API allows the service client to get all the `Group` schemas information from CI.\n\n**Authorization:**\n\nOAuth token rendered by Identity Broker.\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:organizations_rw`\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`"
},
{
"info": {
"name": "Get User Schema",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/Schemas/SCIM2/User"
},
"docs": "This API allows the service client to get all the `User` schemas information from CI.\n\n**Authorization:**\n\nOAuth token rendered by Identity Broker.\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:organizations_rw`\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`"
},
{
"info": {
"name": "Get Schema using Group Schema ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/Schemas/SCIM2/:schemaId",
"params": [
{
"name": "schemaId",
"value": "urn:ietf:params:scim:schemas:core:2.0:Group",
"type": "path",
"description": "The Schema Id of Group/User Schema"
}
]
},
"docs": "This API allows the service client to get the Group/User Schema using `Schema Id` from CI.\n\nExample:\n\n- `urn:ietf:params:scim:schemas:core:2.0:Group` is one of the `Group Schema Id`. Using this particular ID, we can fetch all information related to it.\n\n- `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` is one of the `User Schema Id`. Using this particular ID, we can fetch all information related to it.\n\n**Authorization:**\n\nOAuth token rendered by Identity Broker.\n\nOne of the followi"
}
]
},
{
"info": {
"name": "SCIM 2 Users",
"type": "folder"
},
"items": [
{
"info": {
"name": "Search users",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Users",
"params": [
{
"name": "orgId",
"value": "0ae87ade-8c8a-4952-af08-318798958d0c",
"type": "path",
"description": "Webex Identity assigned organization identifier for user's organization."
},
{
"name": "filter",
"value": "userName%20Eq%20%22user1%40example.com%22%20or%20userName%20Eq%20%22user2%40example.com%22",
"type": "query",
"description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core** | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |"
},
{
"name": "attributes",
"value": "urn:ietf:params:scim:schemas:core:2.0:User",
"type": "query",
"description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned"
},
{
"name": "excludedAttributes",
"value": "nickName,userType",
"type": "query",
"description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned"
},
{
"name": "sortBy",
"value": "userName",
"type": "query",
"description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort."
},
{
"name": "sortOrder",
"value": "ascending",
"type": "query",
"description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'."
},
{
"name": "startIndex",
"value": "1",
"type": "query",
"description": "An integer for the 1-based index of the first query result. The default is 1."
},
{
"name": "count",
"value": "10",
"type": "query",
"description": "An integer for the maximum number of query results per page. The default is 100."
},
{
"name": "returnGroups",
"value": "false",
"type": "query",
"description": "Define whether the group information needs to be returned. The default is false."
},
{
"name": "includeGroupDetails",
"value": "false",
"type": "query",
"description": "Define whether the group information with details needs to be returned. The default is false."
},
{
"name": "groupUsageTypes",
"value": "``",
"type": "query",
"description": "Returns groups with details of the specified group type."
}
]
},
"docs": "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`\n\n
"
},
{
"info": {
"name": "Create a user",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Users",
"params": [
{
"name": "orgId",
"value": "0ae87ade-8c8a-4952-af08-318798958d0c",
"type": "path",
"description": "Webex Identity assigned organization identifier for user's organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The SCIM 2 /Users API provides a programmatic way to manage users in Webex Identity using The Internet Engineering Task Force standard SCIM 2.0 standard as specified by [RFC 7643 SCIM 2.0 Core Schema ](https://datatracker.ietf.org/doc/html/rfc7643) and [RFC 7644 SCIM 2.0 Core Protocol](https://datatracker.ietf.org/doc/html/rfc7644). The WebEx SCIM 2.0 APIs allow clients supporting the SCIM 2.0 standard to manage users, and groups within Webex. Webex supports the following SCIM 2.0 Schemas:\n\n•"
},
{
"info": {
"name": "Get a user",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId",
"params": [
{
"name": "orgId",
"value": "0ae87ade-8c8a-4952-af08-318798958d0c",
"type": "path",
"description": "Webex Identity assigned organization identifier for user's organization."
},
{
"name": "userId",
"value": "3426a8e3-d414-4bf0-a493-4f6787632a13",
"type": "path",
"description": "Webex Identity assigned user identifier."
}
]
},
"docs": "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`\n\n
"
},
{
"info": {
"name": "Update a user with PUT",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId",
"params": [
{
"name": "orgId",
"value": "0ae87ade-8c8a-4952-af08-318798958d0c",
"type": "path",
"description": "Webex Identity assigned organization identifier for user's organization."
},
{
"name": "userId",
"value": "3426a8e3-d414-4bf0-a493-4f6787632a13",
"type": "path",
"description": "Webex Identity assigned user identifier."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n
\n\n**Usage**:\n\n1. Input JSON must contain schema: \"urn:ietf:params:scim:schemas:core:2.0:User\".\n\n2. Support 3 schemas :\n - \"urn:ietf:params:scim:schemas:core:2.0:User\"\n - \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\"\n - \"urn:scim:sc"
},
{
"info": {
"name": "Update a user with PATCH",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId",
"params": [
{
"name": "orgId",
"value": "0ae87ade-8c8a-4952-af08-318798958d0c",
"type": "path",
"description": "Webex Identity assigned organization identifier for user's organization."
},
{
"name": "userId",
"value": "3426a8e3-d414-4bf0-a493-4f6787632a13",
"type": "path",
"description": "Webex Identity assigned user identifier."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n
\n\n**Usage**:\n\n1. The PATCH API replaces individual attributes and roles of the user's data in the request body.\n The PATCH API supports `add`, `remove`, and `replace` operations on any individual\n attribute or role allowing only specific attributes of"
},
{
"info": {
"name": "Delete a user",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId",
"params": [
{
"name": "orgId",
"value": "0ae87ade-8c8a-4952-af08-318798958d0c",
"type": "path",
"description": "Webex Identity assigned organization identifier for user's organization."
},
{
"name": "userId",
"value": "3426a8e3-d414-4bf0-a493-4f6787632a13",
"type": "path",
"description": "Webex Identity assigned user identifier."
}
]
},
"docs": "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n
"
},
{
"info": {
"name": "Get Me",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/identity/scim/v2/Users/me"
},
"docs": "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:people_read`\n\n
\n\nThe API can be used by any user to retrieve user information using their own access token.\n\n
"
}
]
},
{
"info": {
"name": "Security Audit Events",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Security Audit Events",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/admin/securityAudit/events",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List events in this organization, by ID."
},
{
"name": "startTime",
"value": "2018-01-01T13:12:11.789Z",
"type": "query",
"description": "List events which occurred after a specific date and time."
},
{
"name": "endTime",
"value": "2018-01-01T14:12:11.789Z",
"type": "query",
"description": "List events which occurred before a specific date and time."
},
{
"name": "actorId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iYzQ1YTdiMC00OTg1LTQzYzktYjI1OS00Y2MzOTgzYzY4NjQ",
"type": "query",
"description": "List events performed by this person, by ID."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of events in the response. The maximum value is `1000`."
},
{
"name": "eventCategories",
"value": "LOGINS",
"type": "query",
"description": "List events, by event categories."
}
]
},
"docs": "List Security Audit Events. This API currently returns user sign-in and sign-out data.\nTo call this API the `audit:events_read` scope must be selected for the Integration or Service App and authorized by a Full Admin.\n\nSeveral query parameters are available to filter the response.\n\nLong result sets will be split into multiple [pages](/docs/basics#pagination)\n\n**NOTE**: A maximum of one year of audit events can be returned per request."
}
]
},
{
"info": {
"name": "Send Activation Email",
"type": "folder"
},
"items": [
{
"info": {
"name": "Initiate Bulk Activation Email Resend Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yMDIwYTkyMC0zMTRjLTQ3NmUtYmNiMS1hNDJhNGI2YzM2MDM",
"type": "path",
"description": "Initiate job for this organization."
}
]
},
"docs": "Initiate a bulk activation email resend job that sends an activation email to all eligible users in an organization. Only a single instance of the job can be running for an organization.\n\nRequires a full or user administrator auth token with a scope of `spark-admin:people_write`."
},
{
"info": {
"name": "Get Bulk Activation Email Resend Job Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/status",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yMDIwYTkyMC0zMTRjLTQ3NmUtYmNiMS1hNDJhNGI2YzM2MDM",
"type": "path",
"description": "Check job status for this organization."
},
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC9lNzc4NWU3YS1mNmFiLTRjNTEtYWVjOS00YTg5NWQyOTdjMjc",
"type": "path",
"description": "Retrieve job status for this `jobId`."
}
]
},
"docs": "Get the details of an activation email resend job by its job ID.\n\nRequires a full or user administrator auth token with a scope of `spark-admin:people_write` or read-only administrator auth token with a scope of `spark-admin:people_read`."
},
{
"info": {
"name": "Get Bulk Activation Email Resend Job Errors",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errors",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yMDIwYTkyMC0zMTRjLTQ3NmUtYmNiMS1hNDJhNGI2YzM2MDM",
"type": "path",
"description": "Check job status for this organization."
},
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC9lNzc4NWU3YS1mNmFiLTRjNTEtYWVjOS00YTg5NWQyOTdjMjc",
"type": "path",
"description": "Retrieve job status for this `jobId`."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of errors in the response."
}
]
},
"docs": "Get errors of an activation email resend job by its job ID.\n\nRequires a full or user administrator auth token with a scope of `spark-admin:people_write` or read-only administrator auth token with a scope of `spark-admin:people_read`."
}
]
},
{
"info": {
"name": "Service Apps",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create Service App Access Token",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/applications/:applicationId/token",
"params": [
{
"name": "applicationId",
"value": "Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL0MyNzljYjMwYWI0OTQ3MGFhM2ViYTgwY2Q4MmYxMTc1",
"type": "path",
"description": "The unique identifier of the Service App"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://webexapis.com/v1/authorize",
"accessTokenUrl": "https://webexapis.com/v1/access_token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves an organization specific token pair for an already authorized Service App. Service Apps use machine accounts to make API calls on behalf of an organization, independent of individual user life cycles.\n\nThis endpoint allows you to programmatically retrieve access and refresh tokens after a Full Admin has authorized your Service App in Control Hub.\n\nTo call this endpoint, you need an integration with the spark:applications_token scope."
}
]
},
{
"info": {
"name": "Settings",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get an Organization Setting",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/settings/organizations/:orgId/settings/:settingKey",
"params": [
{
"name": "orgId",
"value": "1eb65fdf-9643-417f-9974-ad72cae0e10f",
"type": "path",
"description": "The Webex organization id in Control Hub UUID or API orgId format."
},
{
"name": "settingKey",
"value": "allow-admin-invite-emails",
"type": "path",
"description": "The key of the setting."
}
]
},
"docs": "This endpoint retrieves the specified setting for the given organization and is accessible with the scope 'identity:organizations_read'."
},
{
"info": {
"name": "Create or Update an Organization Setting",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/settings/organizations/:orgId/settings",
"params": [
{
"name": "orgId",
"value": "1eb65fdf-9643-417f-9974-ad72cae0e10f",
"type": "path",
"description": "The Webex organization id in Control Hub UUID or API orgId format."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This endpoint creates or updates the specified setting for the given organization; however, the 'name' of the setting cannot be modified. It is accessible with the scope 'identity:organizations_rw'."
}
]
},
{
"info": {
"name": "Partner Tags",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve all customer tags",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/partner/tags",
"params": [
{
"name": "type",
"value": "ORGANIZATION",
"type": "query",
"description": "List tags associated with an organization."
}
]
},
"docs": "Retrieves all tags which are being used by any customer organizations. Once a tag is unassigned from the last customer, it is automatically removed and is not returned by this API.\nThis API can be used by a partner full admin, a read-only partner, or an partner admin. \nThe `type` can have the value ORGANIZATION or SUBSCRIPTION. If not provided, the value is ORGANIZATION"
},
{
"info": {
"name": "Create or Replace existing customer tags with the provided ones",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jOTYwOTZiYi1kYTRhLTQ3NzEtYTc2Zi1kNDEzODQwZWVm1TQ",
"type": "path",
"description": "The unique identifier for the customer organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assign or replace tag(s) which for a customer organization. If the tag doesn't already exist, a new one is created and assigned to the customer automatically.\nThis API can be used by partner full admins and partner admins. \nEach tag has a character limit of 25. Currently, there is a limit of 5 tags per organization when creating tags. To remove all the tags, pass an empty array.\nSpecify the customer organization ID in the `orgId` parameter in the URI."
},
{
"info": {
"name": "Get customer organization's tags",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/partner/tags/organizations/:orgId",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jOTYwOTZiYi1kYTRhLTQ3NzEtYTc2Zi1kNDEzODQwZWVm1TQ",
"type": "path",
"description": "Fetch all customers and associated tags for the customer."
}
]
},
"docs": "Retrieve tags associated with a customer organization based on the `orgId` provided.\nThis API can be used by a partner full admin, a read-only partner, or an partner admin. \nSpecify the customer orgId in the `orgId` parameter in the URI."
},
{
"info": {
"name": "Fetch all customers for a given set of tags",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/partner/tags/organizations",
"params": [
{
"name": "tags",
"value": "Tag1,Tag2",
"type": "query",
"description": "A comma separated list of tags to filter by."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Value must be between 1 and 100, inclusive."
}
]
},
"docs": "For a set of tags, retrieve all customer organizations that match any one of the tags.\nThis API can be used by a partner full admin, a read-only partner, or an partner admin."
},
{
"info": {
"name": "Create or Replace existing subscription tags with the provided ones",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jOTYwOTZiYi1kYTRhLTQ3NzEtYTc2Zi1kNDEzODQwZWVm1TQ",
"type": "path",
"description": "The unique identifier for the customer organization."
},
{
"name": "subscriptionId",
"value": "subscriptionId",
"type": "path",
"description": "The unique identifier for the subscription."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assign or replace tags specific to each subscription for an organization. Each organization may have one or more subscriptions.\nThis API can be used by partner full admins and partner admins. \nCurrently there is a limit of 5 tags per subscription when creating tags. To remove all the tags, pass an empty array.\nSpecify the customer organization ID in the `orgId` parameter in the URI and subscription ID in `subscriptionId` parameter"
},
{
"info": {
"name": "Subscription List on a given tag name or a set of tags",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/partner/tags/subscriptions",
"params": [
{
"name": "tags",
"value": "Tag1,Tag2",
"type": "query",
"description": "A comma separated list of tags to filter by."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Value must be between 1 and 100, inclusive."
}
]
},
"docs": "For a partner organization fetch all it's subscriptions with their tag list for a given tag names.\nThis API can be used by partner full admins, partner admins and admin read-only partners."
},
{
"info": {
"name": "Fetch a Subscription",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jOTYwOTZiYi1kYTRhLTQ3NzEtYTc2Zi1kNDEzODQwZWVm1TQ",
"type": "path",
"description": "The unique identifier for the customer organization."
},
{
"name": "subscriptionId",
"value": "subscriptionId",
"type": "path",
"description": "The unique identifier for the subscription."
}
]
},
"docs": "For a given partner org, customer org and external subscription id, fetch subscription details with its associated tags.\nThis API can be used by partner full admins, partner admins and admin read-only partners."
}
]
},
{
"info": {
"name": "Workspace Locations",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Workspace Locations",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaceLocations",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter."
},
{
"name": "displayName",
"value": "Cisco Barcelona",
"type": "query",
"description": "Location display name."
},
{
"name": "address",
"value": "Carrer de Pere IV, Barcelona, Spain",
"type": "query",
"description": "Location address."
},
{
"name": "countryCode",
"value": "ES",
"type": "query",
"description": "Location country code (ISO 3166-1)."
},
{
"name": "cityName",
"value": "Barcelona",
"type": "query",
"description": "Location city name."
}
]
},
"docs": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nList workspace locations. Use query parameters to filter the response. The `orgId` parameter can only be used by admin users of another\norganization (such as partners). The `displayName`,"
},
{
"info": {
"name": "Create a Workspace Location",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/workspaceLocations",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nCreate a location. The `cityName` and `notes` parameters are optional, and omitting them will result in the creation of a location without values for those attributes.\nRequires an adminis"
},
{
"info": {
"name": "Get a Workspace Location Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaceLocations/:locationId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"type": "path",
"description": "A unique identifier for the location."
}
]
},
"docs": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nShows details for a location, by ID. Specify the location ID in the `locationId` parameter in the URI.\nRequires an administrator auth token with the `spark-admin:workspace_locations_read`"
},
{
"info": {
"name": "Update a Workspace Location",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/workspaceLocations/:locationId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"type": "path",
"description": "A unique identifier for the location."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nUpdates details for a location, by ID. Specify the location ID in the `locationId` parameter in the URI. The request should include all details for the location returned in a previous cal"
},
{
"info": {
"name": "Delete a Workspace Location",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/workspaceLocations/:locationId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"type": "path",
"description": "A unique identifier for the location."
}
]
},
"docs": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nDeletes a location, by ID. The workspaces associated to that location will no longer have a location, but a new location can be reassigned to them.\nRequires an administrator auth token wi"
},
{
"info": {
"name": "List Workspace Location Floors",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaceLocations/:locationId/floors",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"type": "path",
"description": "A unique identifier for the location."
}
]
},
"docs": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nList workspace location floors.\nRequires an administrator auth token with the `spark-admin:workspace_locations_read` scope."
},
{
"info": {
"name": "Create a Workspace Location Floor",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/workspaceLocations/:locationId/floors",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"type": "path",
"description": "A unique identifier for the location."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nCreate a new floor in the given location. The `displayName` parameter is optional, and omitting it will result in the creation of a floor without that value set.\nRequires an administrator"
},
{
"info": {
"name": "Get a Workspace Location Floor Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"type": "path",
"description": "A unique identifier for the location."
},
{
"name": "floorId",
"value": "xx",
"type": "path",
"description": "A unique identifier for the floor."
}
]
},
"docs": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nShows details for a floor, by ID. Specify the floor ID in the `floorId` parameter in the URI.\nRequires an administrator auth token with the `spark-admin:workspace_locations_read` scope."
},
{
"info": {
"name": "Update a Workspace Location Floor",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"type": "path",
"description": "A unique identifier for the location."
},
{
"name": "floorId",
"value": "xx",
"type": "path",
"description": "A unique identifier for the floor."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nUpdates details for a floor, by ID. Specify the floor ID in the `floorId` parameter in the URI. Include all details for the floor returned by a previous call to [Get Workspace Location Fl"
},
{
"info": {
"name": "Delete a Workspace Location Floor",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"type": "path",
"description": "A unique identifier for the location."
},
{
"name": "floorId",
"value": "xx",
"type": "path",
"description": "A unique identifier for the floor."
}
]
},
"docs": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nDeletes a floor, by ID.\nRequires an administrator auth token with the `spark-admin:workspace_locations_write` scope."
}
]
},
{
"info": {
"name": "Workspace Metrics",
"type": "folder"
},
"items": [
{
"info": {
"name": "Workspace Metrics",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaceMetrics",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the workspace to get metrics for."
},
{
"name": "metricName",
"value": "temperature",
"type": "query",
"description": "The type of data to extract."
},
{
"name": "aggregation",
"value": "hourly",
"type": "query",
"description": "Time unit over which to aggregate measurements."
},
{
"name": "from",
"value": "2020-10-21T13:33:37.789Z",
"type": "query",
"description": "List only data points after a specific date and time (ISO 8601 timestamp)"
},
{
"name": "to",
"value": "2020-10-31T16:00:00.532Z",
"type": "query",
"description": "List data points before a specific date and time (ISO 8601 timestamp)"
},
{
"name": "unit",
"value": "celsius",
"type": "query",
"description": "Output data unit (only a valid parameter if `metricName` is `temperature`)."
},
{
"name": "sortBy",
"value": "newestFirst",
"type": "query",
"description": "Sort results."
}
]
},
"docs": "Get metric data for the specified workspace and metric name, optionally aggregated over a specified time period.\n\n* The `workspaceId` and `metricName` parameters indicate which workspace to fetch metrics for and what kind of metrics to get.\n\n* When executing an aggregated query, the result bucket start times will be truncated to the start of an hour or a day, depending on\nthe aggregation interval. However, the buckets will not contain data from outside the requested time range. For example, when"
},
{
"info": {
"name": "Workspace Duration Metrics",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaceDurationMetrics",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the workspace to get metrics for."
},
{
"name": "aggregation",
"value": "hourly",
"type": "query",
"description": "Unit of time over which to aggregate measurements."
},
{
"name": "measurement",
"value": "timeBooked",
"type": "query",
"description": "The measurement to return duration for."
},
{
"name": "from",
"value": "2020-10-21T13:33:37.789Z",
"type": "query",
"description": "Include data points after a specific date and time (ISO 8601 timestamp)."
},
{
"name": "to",
"value": "2020-10-31T16:00:00.532Z",
"type": "query",
"description": "Include data points before a specific date and time (ISO 8601 timestamp)."
}
]
},
"docs": "Get metrics for how much time a workspace has been in the state given by the `measurement` parameter.\n\nFor example, if the measurement is `timeBooked` then the duration for which the workspace has been booked is returned. The `workspaceId` parameter indicates which workspace to fetch metrics for. If no `measurement` is given, the default value is `timeUsed`.\n\n* When executing a query, the result bucket start times will default to the start of an hour or a day, depending on\nthe aggregation inter"
}
]
}
],
"bundled": true
}