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 User Profiles API

The User Profiles API from Webex — 5 operation(s) for user profiles.

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

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

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

8 operations 5 paths 16 schemas 1 DELETE4 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 User Profiles 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 8

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

User Profiles 8
GET
/organization/{orgid}/user-profile/{id}/incoming-references
List references for a specific User Profile
getIncomingReferencesUserProfile 5 params → 200401403404429500
GET
/organization/{orgid}/v3/user-profile
List user profiles
getAllConfigWithMetaDataUserProfileGranularAccess 6 params → 200401403404429500
POST
/organization/{orgid}/v3/user-profile
Create a new User Profile
createConfigUserProfileGranularAccess 1 param body → 201400401403409429500
POST
/organization/{orgid}/v3/user-profile/bulk
Bulk save User Profiles
saveAllConfigUserProfileGranularAccess 1 param body → 207400401403409429500
GET
/organization/{orgid}/v3/user-profile/{id}
Get specific User Profile by ID
getConfigUserProfileGranularAccess 3 params → 200401403404429500
PUT
/organization/{orgid}/v3/user-profile/{id}
Update specific User Profile by ID
updateConfigUserProfileGranularAccess 2 params body → 200400401403404412429500
DELETE
/organization/{orgid}/v3/user-profile/{id}
Delete specific User Profile by ID
deleteConfigUserProfileGranularAccess 2 params → 204401403404412429500
GET
/organization/{orgid}/v3/user-profile/{id}/acl
Get specific User Profile ACL by ID
getACLByUserProfileUserProfileGranularAccess 3 params → 200401403404429500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are UserProfileGranularAccessDTO (18 properties), AccessControlListDTO (18 properties), ResourceCollectionDTO (9 properties), MetaDataReferencesPagingInfo (8 properties). Each schema is shown below with its type and property counts.

UserProfilePermissionsDTO
object
User Profile Permissions DTO
3 properties 1 required
BulkRequestItemDTOUserProfileGranularAccessDTO
object
List of items in the bulk request.
3 properties
AccessControlListDTO
object
Access Control List is higher order DTO of user profile and resource collection.
18 properties
ApiErrorResponse
object
Response body for an API error.
2 properties
ErrorDetails
object
Details of an error.
2 properties
BulkResponseItemDTO
object
5 properties
ResourceTypesDTO
object
A resource type with its access level and associated IDs.
3 properties 2 required
BulkRequestDTOUserProfileGranularAccessDTO
object
1 property
OperationError
object
An error message providing details about the operation failure.
1 property
ResourceCollectionDTO
object
A collection of resources with their types and access levels.
9 properties 1 required
MetaDataWithPagingInfo
object
Metadata of response with paging information
6 properties
BulkResponseDTO
object
1 property
UserProfileGranularAccessDTO
object
Data Transfer Object for creating or updating a user profile with granular access controls.
18 properties 5 required
MetaDataReferencesPagingInfo
object
Metadata of response for references with paging information
8 properties
EntityInfo
object
6 properties
EntityReferenceInfoDTO
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-user-profiles-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