Integrate with RingCentral

Use JumpCloud SAML Single Sign On (SSO) to give your users convenient but secure access to all their web applications with a single set of credentials. Integrate your JumpCloud account with RingCentral through an identity management connector. After you connect JumpCloud with RingCentral, you can provision, update and deprovision users in RingCentral through your JumpCloud Administrator Portal. Leverage this integration for centralized user lifecycle management and get immediate attribute management of users bound to integrated applications.

Read this article to learn how to configure the RingCentral integration.

Prerequisites:

• A RingCentral administrator account with a Premium or Enterprise plan.
• A JumpCloud administrator account.
• RingCentral supports a number user attribute that is populated by default and required for SSO to work. Optionally, you can map a JumpCloud user attribute to this field to dynamically apply a user’s number to their account. Alternately, you can use JumpCloud custom attributes to store and pass this value in an assertion.
• The administrator’s email address must be URL encoded E.g., for an email address of [email protected], the encoded email address is testing12%2B3%2540jumpcloud.com. To encode your email address:
  • Navigate to your URL Encoder of choice or use this URL Encoding tool.
  • Type your email address (which should be used by both your JumpCloud account and your RingCentral administrator account) into the blue field.
  • Select Encode.
  • Copy the generated value for use while configuring JumpCloud.
• Your RingCentral domain.
• RingCentral SCIM integration requires a User Admin or higher role.
  • Learn more about RingCentral’s User Roles and Permissions. 
• The RingCentral account must have available DigitalLines (licenses) to provision users from JumpCloud. 
• We recommend that you activate SSO for RingCentral prior to creating an Identity Management integration with RingCentral to simplify the login process for your users and reduce the number of usernames and passwords they have to remember.
• If you aren’t going to use SSO, we recommend that you deactivate it in the Administrator Portal to prevent it from appearing in the User Portal Application list.

Important Considerations

• The RingCentral API is based on version 2.0 of the SCIM standard and runs under the RingCentral REST API.
  • Learn more about RingCentral SCIM implementation at API Reference: Provisioning.
• If you delete an integrated RingCentral application from your Applications list, the application is removed from JumpCloud, but any previously bound users remain active in RingCentral. These users will be able log in to RingCentral with the password they used prior to enablement of SSO to the RingCentral application from your JumpCloud account.
• If you deactivate the Identity Management on your RingCentral application and SSO is activated, previously bound users remain active in RingCentral and are able to authenticate using SSO. No further updates will be made to user accounts via the Identity Management integration.
  • Users created via SCIM integration should also be deleted via SCIM integration. Otherwise, the administrator must disable the user prior to deleting them.
• Users deactivated via the SCIM integration can only be deleted via the SCIM integration after reactivating them and then deleting them.
• Newly provisioned users receive an activation email with a link to set up their account.
• User accounts in a pending status can’t be managed; they can only be deleted.
• If a user’s password expires in JumpCloud, their account becomes suspended and they are deactivated in all applications that have Identity Management configured and, are associated to them. Once the user’s password is updated, the account and previously associated applications are reactivated.

Attribute Considerations

• Any extra attributes sent to the API are ignored. 
• If you define an address for a user, you must set a country value. The country value must match one of the countries associated with an unassigned extension, otherwise, the user isn’t added to RingCentral.
• username MUST be same as work type email address.
• name.givenName is required.
• name.familyName is required.
• At least 1 address is required.

Configuring the SSO Integration

To configure JumpCloud 1

1. Access the JumpCloud Administrator Console.
2. Go to USER AUTHENTICATION > SSO.
3. Click + Add New Application, scroll to or search for RingCentral, then click configure.
4. Enter a Display Label in the General Info tab. Optionally, you can enter a description and adjust the logo shown for the application.
5. Select the SSO tab and replace any instances of <mydomain>.
6. Click Copy Metadata URL.
7. Add any other attributes and click save.

To configure RingCentral 1

1. Login to RingCentral as as administrator.
2. Go to: More > Security and Compliance > Single Sign-on.
3. In the Set up SSO by yourself section, click Edit
4. In the Upload IDP Metadata section:
   • Select URL from the dropdown menu.
   • Enter the JumpCloud Metadata URL.
   • Click Import.
5. In the Attribute Mapping section, select Custom from the Map Email Attribute to dropdown menu, then enter email in the field that appears.
6. Click Save.
7. In the Set up SSO by yourself section, click Download to obtain your SP metadata.

To configure JumpCloud 2

1. Find RingCentral in the list of configured applications and click Configure.
2. Select the SSO tab.
3. Upload the RingCentral metadata file by clicking Upload Metadata.
4. Click save.

To configure RingCentral 2

1. Navigate to Tools > Single Sign-on.
2. Select the Enable SSO option under Enable SSO.
3. In Manage Your Login, configure SSO/password settings. 
4. Click Save. 

Authorizing User SSO Access

Users are implicitly denied access to applications. After you connect an application to JumpCloud, you need to authorize user access to that application. You can authorize user access from the Application Configuration panel or from the Groups Configuration panel. 

To authorize user access from the Application Configuration panel

1. Log in to the JumpCloud Admin Portal.
2. Go to USER AUTHENTICATION > SSO Applications, then select the application to which you want to authorize user access.
3. Select the User Groups tab. If you need to create a new group of users, see Get Started: Groups.
4. Select the check box next to the group of users you want to give access.
5. Click save. 

To learn how to authorize user access from the Groups Configuration panel, see Authorize Users to an SSO Application.

Validate SSO authentication workflows

At this time, single sign on with RingCentral works only as an SP initiated request.

SP Initiated Authentication Workflows

• Navigate to your Service Provider application URL.
• You will be redirected to log in to the JumpCloud User Portal.
• The browser will be redirected back to the application and be automatically logged in.

Configuring the Identity Management Integration

1. Log in to the JumpCloud Administrator Portal.
2. Go to USER AUTHENTICATION > SSO.
3. If have not previously configured SSO for RingCentral:
   • Click +Add New Application, search for RingCentral and click configure.
   • Enter a name in the Display Label field and optionally add a description and adjust the display settings.
   • Click activate and then continue.
4. Find RingCentral in the Configured Applications list, open it and select the Identity Management tab.
5. Click configure. 
6. You’re prompted to sign in to your RingCentral account.
7. You’re prompted to give JumpCloud permission to administer your organization’s RingCentral workspace.
8. Click Authorize.
   • If you aren’t a RingCentral User Admin role or higher, you see a request asking for administrator permissions. You’re required to have a RingCentral User Admin role account to complete the integration with JumpCloud. 
9. You receive a confirmation that the Identity Management integration has been successfully verified.

Attribute Mappings

The following table lists attributes that JumpCloud sends to the application. See Attribute Considerations for more information regarding attribute mapping considerations. 

Learn about JumpCloud Properties and how they work with system users in our API. 

Importing Users

This functionality is helpful if users have already been created in the application but have not been created in JumpCloud.

1. Log in to the JumpCloud Admin Portal.
2. Go to USER AUTHENTICATION > SSO Applications.
3. Search for the application and click to open its configuration panel. 
4. Select the Identity Management tab.
5. Click manual import.
6. Select the users you want to create in JumpCloud from the application from the list of users that appear. Users in the list have two import statuses:

• New – The user has not been imported.
• Imported – user has been imported and has an account in JumpCloud.

7. Click import.

• If you are importing less than 100 users, your import results will display in real time and you can continue onboarding your users. 
• If you have more than 100 users being imported, JumpCloud will send you an email when your import is complete.

8. You can now connect and grant users access to all their JumpCloud resources. Learn more in the Authorize Users to an Application and Connecting Users to Resources articles.

Removing the Integration

To deactivate the IdM Integration

1. Log in to the JumpCloud Admin Portal.
2. Go to USER AUTHENTICATION > SSO Applications.
3. Search for the application that you’d like to deactivate and click to open its details panel. 
4. Under the company name and logo on the left hand panel, click the Deactivate IdM connection link.
5. Click confirm. 
6. If successful, you will receive a confirmation message.

To deactivate the SSO Integration

1. Log in to the JumpCloud Admin Portal.
2. Go to USER AUTHENTICATION > SSO Applications.
3. Search for the application that you’d like to deactivate and click to open its details panel. 
4. Select the SSO tab.
5. Scroll to the bottom of the configuration.
6. Click Deactivate SSO. 
7. Click save. 
8. If successful, you will receive a confirmation message.

To delete the application

1. Log in to the JumpCloud Admin Portal.
2. Go to USER AUTHENTICATION > SSO Applications.
3. Search for the application that you’d like to delete and click to open its details panel.
4. Check the box for the application.
5. Click Delete.
6. Enter the number of the applications you are deleting
7. Click Delete Application.
8. If successful, you will see an application deletion confirmation notification.