Sign in

v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB
OAuth 2.0 / OpenID Connect

OAuth 2.0 Token Endpoint

Returns access (and potentially refresh) tokens for making API requests.

For confidential client application types this endpoint requires client authentication using one of the supported methods (client_secret_basic, client_secret_jwt or private_key_jwt)

For non-confidential client application types the client identifier must be provided via client_id request attribute.

post/restapi/oauth/token

Response

Access/Refresh Tokens

access_tokenstring required

OAuth access token to pass to subsequent API requests

expires_ininteger required

Access token TTL (time-to-live) in seconds

refresh_tokenstring

OAuth refresh token (if issued)

refresh_token_expires_ininteger

Refresh token TTL (time-to-live) in seconds

scopestring required

The list of space separated application permissions (OAuth scopes)

token_type'bearer' required

Type of the token. The only supported value is bearer. This value should be used when specifying access token in Authorization header of subsequent API requests

owner_idstring

Token owner's identifier. Contains RingCentral user (extension) ID

endpoint_idstring

Client application instance identifier that matches the value provided by the client, or generated by the server if a client has not provided this value

id_tokenstring

OpenID Connect ID token (if OpenID Connect flow was activated during authorization)

session_expires_ininteger

Remaining time in seconds until session expiration due to absolute timeout. Returned only if absolute session timeout is enforced

session_expiration_timestring date-time

Absolute value of session expiration time in ISO date formatted string. Returned only if absolute session timeout is enforced

session_idstring

OAuth session ID

session_idle_timeoutinteger

Nominal value of session idle timeout in seconds. Returned only if idle session timeout is enforced

Example response

{
  "access_token": "U1BCMDFUMDRKV1MwMXxzLFSvXdw5PHMsVLEn_MrtcyxUsw",
  "expires_in": 7199,
  "refresh_token": "U1BCMDFUMDRKV1MwMXxzLFL4ec6A0XMsUv9wLriecyxS_w",
  "refresh_token_expires_in": 604799,
  "scope": "AccountInfo CallLog ExtensionInfo Messages SMS",
  "token_type": "bearer",
  "owner_id": "256440016",
  "endpoint_id": "8zXq6oaLT7WvwWITlGiA1A",
  "session_expiration_time": "2023-04-01T12:00:01Z"
}