Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webex BroadWorks Enterprises API

The BroadWorks Enterprises API from Webex — 3 operation(s) for broadworks enterprises.

Webex BroadWorks Enterprises API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include BroadWorks Enterprises. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

5 operations 3 paths 5 schemas 2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Authentication
OAuth 2.0, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Webex BroadWorks Enterprises API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (bearer-key). It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — OAuth 2.0 Bearer token authentication

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

BroadWorks Enterprises 5
GET
/broadworks/enterprises
List BroadWorks Enterprises
List BroadWorks Enterprises 3 params → 200400401403404405409410
PUT
/broadworks/enterprises/{id}/broadworksDirectorySync
Update Directory Sync for a BroadWorks Enterprise
Update Directory Sync for a BroadWorks Enterprise 1 param body → 200400401403404405409410
POST
/broadworks/enterprises/{id}/broadworksDirectorySync
Trigger Directory Sync for an Enterprise
Trigger Directory Sync for an Enterprise 1 param body → 200400401403404405409410
GET
/broadworks/enterprises/{id}/broadworksDirectorySync
Get Directory Sync Status for an Enterprise
Get Directory Sync Status for an Enterprise 1 param → 200400401403404405409410
POST
/broadworks/enterprises/{id}/broadworksDirectorySync/externalUser
Trigger Directory Sync for a User
Trigger Directory Sync for a User 1 param body → 200400401403404405409410

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are EnterpriseListResponse (5 properties), GetDirectorySyncStatusResponse (2 properties), UpdateDirectorySyncResponse (2 properties), TriggerDirectorySyncResponse (2 properties). Each schema is shown below with its type and property counts.

TriggerUserDirectorySyncResponse
object
2 properties
EnterpriseListResponse
object
5 properties
TriggerDirectorySyncResponse
object
2 properties
UpdateDirectorySyncResponse
object
2 properties
GetDirectorySyncStatusResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-broadworks-enterprises-api-openapi.yml Raw ↑

Other APIs Webex publishes across the network.

Webex Address Book API
Webex Admin Audit Events API
Webex Agent Personal Greeting Files API
Webex Agent Summaries API
Webex Agent Wellbeing API
Webex Agents API
Webex AI Feature API
Webex API - Domain Management API
Webex Archive Users API
Webex Attachment Actions API
Webex Audio Files API
Webex Authorizations API