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 Auxiliary Code API

The Auxiliary Code API from Webex — 7 operation(s) for auxiliary code.

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

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

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

11 operations 7 paths 16 schemas 1 DELETE5 GET1 PATCH3 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 Auxiliary Code 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 11

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

Auxiliary Code 11
GET
/organization/{orgid}/auxiliary-codedeprecated
List Auxiliary Code(s)
getAllConfig_12 5 params → 200401403404429500
POST
/organization/{orgid}/auxiliary-code
Create a new Auxiliary Code
createConfig_23 1 param body → 201400401403409429500
POST
/organization/{orgid}/auxiliary-code/bulk
Bulk save Auxiliary Code(s)
saveAllConfig_20 1 param body → 207400401403409429500
PATCH
/organization/{orgid}/auxiliary-code/bulk
Bulk partial update Auxiliary Code(s)
patchAllConfig_2 1 param body → 207400401403404429500
GET
/organization/{orgid}/auxiliary-code/bulk-exportdeprecated
Bulk export Auxiliary Code(s)
bulkExport_20 3 params → 200401403404429500
POST
/organization/{orgid}/auxiliary-code/purge-inactive-entities
Purge inactive Auxiliary Code(s)
purgeInactiveConfig_10 2 params → 200400401403409429500
GET
/organization/{orgid}/auxiliary-code/{id}
Get specific Auxiliary Code by ID
getConfig_24 2 params → 200401403404429500
PUT
/organization/{orgid}/auxiliary-code/{id}
Update specific Auxiliary Code by ID
updateConfig_24 2 params body → 200400401403404412429500
DELETE
/organization/{orgid}/auxiliary-code/{id}
Delete specific Auxiliary Code by ID
deleteConfig_22 2 params → 204401403404412429500
GET
/organization/{orgid}/auxiliary-code/{id}/incoming-references
List references for a specific Auxiliary Code
getIncomingReferences_18 5 params → 200401403404429500
GET
/organization/{orgid}/v2/auxiliary-code
List Auxiliary Code(s)
getAllConfigWithMetaData_21 8 params → 200401403404429500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are AuxiliaryCodeDTO (14 properties), Link (8 properties), MetaDataReferencesPagingInfo (8 properties), MetaDataWithPagingInfo (6 properties). Each schema is shown below with its type and property counts.

Response
object
3 properties
ApiErrorResponse
object
Response body for an API error.
2 properties
Link
object
8 properties
AuxiliaryCodeDTO
object
14 properties 5 required
BulkExportDTOAuxCodeBulkExportDTO
object
5 properties
ErrorDetails
object
Details of an error.
2 properties
BulkResponseItemDTO
object
5 properties
BulkRequestDTOAuxiliaryCodeDTO
object
1 property
OperationError
object
An error message providing details about the operation failure.
1 property
MetaDataWithPagingInfo
object
Metadata of response with paging information
6 properties
BulkResponseDTO
object
1 property
AuxCodeBulkExportDTO
object
4 properties 1 required
MetaDataReferencesPagingInfo
object
Metadata of response for references with paging information
8 properties
EntityInfo
object
6 properties
BulkRequestItemDTOAuxiliaryCodeDTO
object
3 properties
EntityReferenceInfoDTO
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-auxiliary-code-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