> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lumos.com/llms.txt
> Use this file to discover all available pages before exploring further.

# RingCentral

## After this article

You will be able to connect RingCentral to Lumos, sync users, and suspend or deprovision them.

## Capabilities

| Functionality | Type | Sync | Provision | Description |
| - | - | - | - | - |
| Users | Account | Yes | Yes | View users, and suspend or deprovision them |

**View users**

Lumos maps RingCentral user statuses to Lumos account statuses as follows.

| RingCentral User Status | Lumos Account Status |
| - | - |
| active | Active |
| not active | Suspended |
| deleted (RingCentral no longer returns a user) | Deprovisioned |

Lumos matches on the user's primary email.

**Suspend a user**

| AppStore | Offboarding | Access Reviews | License Management |
| - | - | - | - |
| N/A | Yes | Yes | Yes |

In Lumos, suspending a RingCentral user marks their Account Status as "Suspended". In RingCentral, this action deactivates the user, which prevents them from logging into RingCentral and disables their User Extension. This action does not reclaim a license in RingCentral.

**Deprovision a user**

| AppStore | Offboarding | Access Reviews | License Management |
| - | - | - | - |
| N/A | Yes | Yes | Yes |

In Lumos, deprovisioning a RingCentral user marks their Account Status as "Deprovisioned". In RingCentral, this action deletes the user and their data from RingCentral. After the User Extension has been disabled or deleted, check the other Extensions and update their settings if the Extension was used to receive calls or messages (for example, call forwarding, custom rules, or message recipient). If you skip this, you may miss calls or fax and voicemail messages that were routed to the disabled or deleted Extension. This action reclaims a license in RingCentral.

Note:

* The phone numbers and devices are kept on your account and listed as an unassigned User Extension.
* Once a user is deleted, any Additional Desktop Apps, messages, greetings, rules, and recorded calls in the User Extension are lost and cannot be recovered.

## Required plan and roles

* **RingCentral plan:** There is no minimum RingCentral plan needed to connect this integration.
* **RingCentral role:** Your RingCentral user needs to be at least a **User Admin** to connect this integration.
* **OAuth scopes** requested during connection:

| Scope | Required | Description |
| - | - | - |
| `ReadAccounts` | Yes | Viewing user account info (including name, business name, address, and phone number or account number) |
| `EditAccounts` | Yes | Viewing and updating user account info (including name, business name, address, and phone number or account number) |

RingCentral provides a read-only scope for reading user account info, but the current Lumos integration requests both scopes. There is not currently a way to override or remove these scopes in RingCentral during or after connecting the integration.

## Read-only access vs provisioning

**Is read-only possible?** No. RingCentral does expose a read-only scope for account info, but the Lumos integration requests both `ReadAccounts` and `EditAccounts` together, and there is currently no way to override or remove either scope during or after connecting.

**What full provisioning requires.** A RingCentral user who is at least a **User Admin**, then accepting both the `ReadAccounts` and `EditAccounts` OAuth scopes when you connect. Follow the steps below, there's no separate read-only connection path to choose.

**Watch out for.** Because both scopes are always requested together, any RingCentral connection can suspend or deprovision users, even if you only intended to view accounts. Suspending a user doesn't reclaim a license, deprovisioning does and permanently deletes the user's data, including messages, greetings, and recorded calls tied to their Extension.

## Instructions

**Phase 1: Connect RingCentral in Lumos**

1. Find the RingCentral card in your Lumos integrations (Reconnect or add new).
2. Choose a unique identifier for this integration (such as "lumos-ringcentral-1"). This helps in case you want to connect multiple tenants of RingCentral.
3. Click **Connect RingCentral**.
4. Log in and accept the requested scopes in RingCentral to connect the integration.

## API Endpoints Used

<Note>
  The API endpoints this integration uses are available to logged-in Lumos customers. [Log in](/login) to view them.
</Note>

## Troubleshooting

**Can't connect the integration.** Confirm your RingCentral user is at least a User Admin. During connection, log in and accept both requested scopes in RingCentral.

**Lumos requests edit access, but I only want read-only.** RingCentral provides a read-only scope for reading user account info, but the current Lumos integration requests both `ReadAccounts` and `EditAccounts`. There is not currently a way to override or remove these scopes in RingCentral during or after connecting.