Reference
RingCentral
Set up RingCentral OAuth for cloud communications and telephony
Overview
Section titled “Overview”Connect your users to RingCentral for cloud phone systems, messaging, video meetings, and call log access.
| Property | Value |
|---|---|
| Provider ID | ringcentral |
| Category | Communication |
| PKCE | Supported |
| Token refresh | Automatic |
| Redirect URI | Shown in Developer Portal |
Step 1: Create a RingCentral OAuth App
Section titled “Step 1: Create a RingCentral OAuth App”Go to the RingCentral Developer Portal
Navigate to developers.ringcentral.com/my-account.html and sign in.
Create a new app
Click Create App, select OAuth 2.0, and fill in the app name and platform type.
Configure the redirect URI
Add the Alter callback URL from the Developer Portal to the OAuth Redirect URI field.
Get credentials
Copy the Client ID and Client Secret.
Step 2: Add to Alter Vault
Section titled “Step 2: Add to Alter Vault”Open the Developer Portal
Go to portal.alterauth.com and navigate to the application.
Add RingCentral provider
Go to OAuth Providers > Add Provider > RingCentral.
Enter credentials
- Client ID: Paste your RingCentral Client ID
- Client Secret: Paste your RingCentral Client Secret
Select scopes
Choose the scopes the application needs.
Save
Click Save. The provider is now active.
Available Scopes
Section titled “Available Scopes”| Scope | Description |
|---|---|
ReadAccounts | View account and extension information |
EditAccounts | Modify account and extension settings |
ReadMessages | View messages including SMS and voicemail |
EditMessages | Send and manage messages |
ReadCallLog | View call history and recordings |
ReadPresence | View user presence and availability status |
Meetings | Schedule and manage RingCentral meetings |
Contacts | View and manage contacts |
- RingCentral has separate sandbox and production environments. Test with sandbox credentials before going to production.
- See the RingCentral authentication guide for more details.
Policy-cataloged operations
Section titled “Policy-cataloged operations”Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.
| Operation ID | Families | Method | Provider path |
|---|---|---|---|
account/get | read | GET | /restapi/v1.0/account/{accountId} |
call-log/account | read | GET | /restapi/v1.0/account/{accountId}/call-log |
call-log/extension | read | GET | /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log |
contacts/create | write | POST | /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact |
contacts/list | read | GET | /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact |
extension/get | read | GET | /restapi/v1.0/account/{accountId}/extension/{extensionId} |
extensions/list | read | GET | /restapi/v1.0/account/{accountId}/extension |
fax/send | send | POST | /restapi/v1.0/account/{accountId}/extension/{extensionId}/fax |
message-store/get | read | GET | /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId} |
message-store/list | read | GET | /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store |
presence/get | read | GET | /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence |
ring-out/create | send | POST | /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out |
sms/send | send | POST | /restapi/v1.0/account/{accountId}/extension/{extensionId}/sms |
team-messaging/chats/list | read | GET | /team-messaging/v1/chats |
team-messaging/posts/create | send | POST | /team-messaging/v1/chats/{chatId}/posts |