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

RingCentral SCIM API

The SCIM API from RingCentral — 8 operation(s) for scim.

RingCentral SCIM API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 12 operations across 8 paths, and defines 25 schemas. It is described by OpenAPI 3.0.3, at version 1.0.58-20240529-47eda8bd.

Requests are made against 4 base URLs: https://platform.ringcentral.com, https://media.ringcentral.com, https://platform.devtest.ringcentral.com, https://platform.devtest.ringcentral.com.

12 operations 8 paths 25 schemas 1 DELETE7 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.58-20240529-47eda8bd
Servers
https://platform.ringcentral.com
https://media.ringcentral.com
https://platform.devtest.ringcentral.com
https://platform.devtest.ringcentral.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

RingCentral SCIM API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. By default, every request must be authenticated.

Paths & Operations 12

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

SCIM 12
GET
/scim/v2/Schemas
List Schemas
scimListSchemas2 → 200403
GET
/scim/v2/Schemas/{uri}
Get Schema
scimGetSchema2 1 param → 200404
GET
/scim/v2/Users
Search/List Users
scimSearchViaGet2 3 params → 200400401403429500
POST
/scim/v2/Users
Create User
scimCreateUser2 body → 201400401403404409429500
POST
/scim/v2/Users/.search
Search/List Users
scimSearchViaPost2 body → 200400401403429500
GET
/scim/v2/Users/{scimUserId}
Get User
scimGetUser2 1 param → 200401403404429500
PUT
/scim/v2/Users/{scimUserId}
Update/Replace User
scimUpdateUser2 1 param body → 200400401403404409429500
DELETE
/scim/v2/Users/{scimUserId}
Delete User
scimDeleteUser2 1 param → 204401403404429500
PATCH
/scim/v2/Users/{scimUserId}
Update/Patch User
scimPatchUser2 1 param body → 200400401403404409429500
GET
/scim/v2/ServiceProviderConfig
Get Provider Config
scimGetProviderConfig2 → 200
GET
/scim/v2/ResourceTypes
List Resource Types
scimListResourceTypes2 → 200403
GET
/scim/v2/ResourceTypes/{type}
Get Resource Type
scimGetResourceType2 1 param → 200404

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are ScimUserResponse (13 properties), ScimUser (12 properties), ScimSchemaAttribute (12 properties), ScimProviderConfig (9 properties). Each schema is shown below with its type and property counts.

ScimBulkSupported
object
3 properties
ScimResourceTypeSearchResponse
object
5 properties
ScimEnterpriseUser
object
1 property
ScimUserAddress
object
6 properties 1 required
ScimUserPatch
object
2 properties 2 required
ScimSchemaExtension
object
2 properties 2 required
ScimPatchOperation
object
3 properties 1 required
ScimUserResponse
object
13 properties 4 required
ScimMeta
object
Resource metadata
4 properties
ScimProviderConfig
object
9 properties
ScimFilterSupported
object
2 properties
ScimSupported
object
1 property
ScimName
object
2 properties 2 required
ScimErrorResponse
object
4 properties
ScimUserSearchResponse
object
5 properties
ScimResourceTypeResponse
object
7 properties 3 required
ScimEmail
object
2 properties 2 required
ScimSearchRequest
object
4 properties
ScimPhoto
object
2 properties 2 required
ScimSchemaSearchResponse
object
5 properties
ScimSchemaResponse
object
5 properties 1 required
ScimAuthenticationScheme
object
5 properties
ScimUser
object
12 properties 4 required
ScimSchemaAttribute
object
12 properties 7 required
ScimPhoneNumber
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-scim-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
RingCentral Team Messaging API
RingCentral Video API
RingCentral Fax API
RingCentral Data API
RingCentral Audio and Video AI API
RingCentral Call Log API
RingCentral Call Analytics API
RingCentral Presence API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Webhooks and Subscriptions API