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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

RingCentral

RingCentral OAuth 2.0 / OpenID Connect API

Public OAuth 2.0 and OpenID Connect Resources

Provider Profile APIs.io OpenAPI GitHub

RingCentral OAuth 2.0 / OpenID Connect API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include OAuth 2.0 / OpenID Connect. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 3 paths, and defines 20 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.

4 operations 3 paths 20 schemas 1 GET3 POST

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
Contact
RingCentral Developers Support
License
RingCentral API License Agreement
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

RingCentral OAuth 2.0 / OpenID Connect 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 4

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

OAuth 2.0 / OpenID Connect 4

Public OAuth 2.0 and OpenID Connect Resources

POST
/restapi/oauth/token
OAuth 2.0 Token Endpoint
getToken body → 200400415429
GET
/restapi/oauth/authorize
OAuth 2.0 Authorization Endpoint
authorize 15 params → 302400
POST
/restapi/oauth/authorize
OAuth 2.0 Authorization Endpoint (POST)
authorize2 body → 302400
POST
/restapi/oauth/revoke
OAuth 2.0 Token Revocation Endpoint
revokeToken 1 param body → 200400

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are AuthorizeRequest (15 properties), TokenInfo (13 properties), BaseTokenRequest (6 properties), RopcTokenRequest (5 properties). Each schema is shown below with its type and property counts.

IvrPinTokenRequest
object
Token endpoint request parameters used in the "IVR Pin" authorization flow with the ivrpin grant type
2 properties
CodeChallengeMethodEnum
string
The code challenge method as defined by the PKCE specification - [RFC-7636 "Proof Key for Code Exchange by OAuth Public Clients"](https://datatracker.ietf.org/…
DeviceCodeTokenRequest
object
Token endpoint request parameters used in the "Device Authorization" flow with the urn:ietf:params:oauth:grant-type:devicecode grant type
2 properties
RopcTokenRequest
object
Token endpoint request parameters used in the "Password" (also known as "Resource Owner Password Credentials" - ROPC) authorization flow with the password gran…
5 properties
GetTokenRequest
ApiErrorWithParameter
The error model with additional attributes which can be used for HTTP 400/409 This is a deprecated model: "ApiError" model can be used instead with arbitrary a…
BaseTokenRequest
object
6 properties 1 required
RevokeTokenRequest
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
ClientCredentialsTokenRequest
ClientAuthJwtModel
object
2 properties
RefreshTokenRequest
object
Token endpoint request parameters used in the "Refresh Token" flow with the refreshtoken grant type
2 properties
JwtTokenRequest
object
Token endpoint request parameters used in the "Personal JWT", "JWT Bearer" and "Partner JWT" authorization flows with the urn:ietf:params:oauth:grant-type:jwt-…
2 properties
DisplayModesEnum
string
Specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.
AuthCodeTokenRequest
object
Token endpoint request parameters used in the "Authorization Code" and "Authorization code with PKCE" flows with the authorizationcode grant type
4 properties
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
GuestTokenRequest
object
Token endpoint request parameters used in the "Guest" authorization flow with the guest grant type
4 properties
OtpTokenRequest
object
Token endpoint request parameters used in the "One-time Password" (OTP) authorization flow with the otp grant type
2 properties
AuthorizeRequest
object
15 properties 2 required
TokenInfo
object
13 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-oauth-2-0-openid-connect-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
AE Profile APIs.io
RingCentral Team Messaging API
AE Profile APIs.io
RingCentral Video API
AE Profile APIs.io
RingCentral Fax API
AE Profile APIs.io
RingCentral Data API
AE Profile APIs.io
RingCentral Audio and Video AI API
AE Profile APIs.io
RingCentral Call Log API
AE Profile APIs.io
RingCentral Call Analytics API
AE Profile APIs.io
RingCentral Presence API
AE Profile APIs.io
RingCentral Voicemail API
AE Profile APIs.io
RingCentral Provisioning API
AE Profile APIs.io
RingCentral Webhooks and Subscriptions API
AE Profile APIs.io
#OAuth 2.0 / OpenID Connect
← Back to R APIs
API Details
ID
ringcentral:ringcentral-oauth-2-0-openid-connect-api
Server
https://platform.ringcentral.com
Provider
RingCentral
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network