RingCentral Capabilities
Last updated: October 8, 2024
After this article...
You'll understand the capabilities our RingCentral integration provides, and how Lumos interacts with the RingCentral API.
View users
The mapping between RingCentral user statuses and Lumos user account statuses is below.
RingCentral User Status | Lumos Account Status |
active | Active |
not active | Suspended |
deleted (RingCentral no longer returns a user) | Deprovisioned |
RingCentral API endpoint: https://developers.ringcentral.com/api-reference/SCIM/scimSearchViaPost2 (we use the active field and match on the user's primary email)
Suspend a user
AppStore | Offboarding | Access Reviews | License Management |
N/A | ✅ | ✅ | ✅ |
In Lumos, suspending a RingCentral user marks their Account Status as "Suspended".
In RingCentral, this action deactivates the user. This prevents them from logging into RingCentral and disables their User Extension.
This action does not reclaim a license in RingCentral.
RingCentral API endpoint: https://developers.ringcentral.com/api-reference/SCIM/scimPatchUser2 (we set the user's active field to false)
Deprovision a user
AppStore | Offboarding | Access Reviews | License Management |
N/A | ✅ | ✅ | ✅ |
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, you need to check the other Extensions and update their settings if the Extension was used to receive calls or messages (e.g., call forwarding, custom rules, message recipient, etc..) If not done, there is a chance that you may miss calls or fax/voicemail messages which were routed to the disabled/deleted Extension.
Note:
The phone numbers and devices will be kept on your account and will be listed as an unassigned User Extension.
Once a User is deleted, any Additional Desktop Apps, messages, greetings, rules, and recorded calls in User Extension will be lost and cannot be recovered.
This action reclaims a license in RingCentral.
RingCentral API endpoint: https://developers.ringcentral.com/api-reference/SCIM/scimDeleteUser2