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 SCIM 2 Users API

The SCIM 2 Users API from Webex — 3 operation(s) for scim 2 users.

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

Tagged areas include SCIM 2 Users. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

7 operations 3 paths 21 schemas 1 DELETE3 GET1 PATCH1 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 SCIM 2 Users 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 7

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

SCIM 2 Users 7
POST
/identity/scim/{orgId}/v2/Users
Create a user
Create a user 1 param body → 201400401403404405409410
GET
/identity/scim/{orgId}/v2/Users
Search users
Search users 11 params → 200400401403404405409410
GET
/identity/scim/{orgId}/v2/Users/{userId}
Get a user
Get a user 2 params → 200400401403404405409410
PUT
/identity/scim/{orgId}/v2/Users/{userId}
Update a user with PUT
Update a user with PUT 2 params body → 200400401403404405409410
PATCH
/identity/scim/{orgId}/v2/Users/{userId}
Update a user with PATCH
Update a user with PATCH 2 params body → 200400401403404405409410
DELETE
/identity/scim/{orgId}/v2/Users/{userId}
Delete a user
Delete a user 2 params → 204400401403404405409410
GET
/identity/scim/v2/Users/me
Get Me
Get Me → 200400401403404405409410

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are SearchGetUserResponse (23 properties), GetUserResponse (22 properties), PostUser (20 properties), PutUser (19 properties). Each schema is shown below with its type and property counts.

ManagedGroupsObject
object
3 properties 3 required
SipAddressObject
object
4 properties 1 required
SearchGetUserResponse
object
23 properties 5 required
GroupObject
object
3 properties
PutUser
object
19 properties 3 required
AccountStatusObject
string
An array of additional information about a user's status.
GetUserResponse
object
22 properties 5 required
MetaObject
object
Response metadata.
6 properties 4 required
AddressObject
object
6 properties
PostUser
object
20 properties 3 required
SearchUserResponse
object
5 properties 1 required
PhotoObject
object
4 properties
UserTypeObject
string
NameObject
object
The components of the user's real name.
5 properties
ManagedOrgsObject
object
2 properties 2 required
ManagerResponseObject
object
The user's manager.
3 properties 1 required
PatchUser
object
2 properties 2 required
ExternalAttributeObject
object
2 properties 2 required
EmailObject
object
4 properties
RoleObject
object
3 properties
PhoneNumberObject
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-scim-2-users-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