Skip to content

Commit eec4da2

Browse files
v-sonanv-sonan
committed
RingCentral provisioning doc update
1 parent 673cdaf commit eec4da2

File tree

2 files changed

+58
-58
lines changed

2 files changed

+58
-58
lines changed

‎articles/active-directory/saas-apps/media/ringcentral-provisioning-tutorial/provisioning.png

3.44 KB
Loading

‎articles/active-directory/saas-apps/ringcentral-provisioning-tutorial.md

Lines changed: 58 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'Tutorial: Configure RingCentral for automatic user provisioning with Azure Active Directory | Microsoft Docs'
3-
description: Learn how to configure Azure Active Directory to automatically provision and de-provision user accounts to RingCentral.
3+
description: Learn how to automatically provision and de-provision user accounts from Azure AD to RingCentral.
44
services: active-directory
55
documentationcenter: ''
66
author: zchia
@@ -20,35 +20,31 @@ ms.author: Zhchia
2020

2121
# Tutorial: Configure RingCentral for automatic user provisioning
2222

23-
The objective of this tutorial is to demonstrate the steps to be performed in RingCentral and Azure Active Directory (Azure AD) to configure Azure AD to automatically provision and de-provision users and/or groups to RingCentral.
23+
This tutorial describes the steps you need to perform in both RingCentral and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users and groups to [RingCentral](https://www.ringcentral.com/office/plansandpricing.html) using the Azure AD Provisioning service. For important details on what this service does, how it works, and frequently asked questions, see [Automate user provisioning and deprovisioning to SaaS applications with Azure Active Directory](../manage-apps/user-provisioning.md).
2424

25-
> [!NOTE]
26-
> This tutorial describes a connector built on top of the Azure AD User Provisioning Service. For important details on what this service does, how it works, and frequently asked questions, see [Automate user provisioning and deprovisioning to SaaS applications with Azure Active Directory](../app-provisioning/user-provisioning.md).
27-
>
28-
> This connector is currently in Public Preview. For more information on the general Microsoft Azure terms of use for Preview features, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
25+
26+
## Capabilities supported
27+
> [!div class="checklist"]
28+
> * Create users in RingCentral
29+
> * Remove users in RingCentral when they do not require access anymore
30+
> * Keep user attributes synchronized between Azure AD and RingCentral
31+
> * [Single sign-on](https://docs.microsoft.com/azure/active-directory/saas-apps/ringcentral-tutorial) to RingCentral (recommended)
2932
3033
## Prerequisites
3134

3235
The scenario outlined in this tutorial assumes that you already have the following prerequisites:
3336

34-
* An Azure AD tenant
37+
* [An Azure AD tenant](https://docs.microsoft.com/azure/active-directory/develop/quickstart-create-new-tenant)
38+
* A user account in Azure AD with [permission](https://docs.microsoft.com/azure/active-directory/users-groups-roles/directory-assign-admin-roles) to configure provisioning (e.g. Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator).
3539
* [A RingCentral tenant](https://www.ringcentral.com/office/plansandpricing.html)
3640
* A user account in RingCentral with Admin permissions.
3741

38-
## Assigning users to RingCentral
39-
40-
Azure Active Directory uses a concept called *assignments* to determine which users should receive access to selected apps. In the context of automatic user provisioning, only the users and/or groups that have been assigned to an application in Azure AD are synchronized.
41-
42-
Before configuring and enabling automatic user provisioning, you should decide which users and/or groups in Azure AD need access to RingCentral. Once decided, you can assign these users and/or groups to RingCentral by following the instructions here:
43-
* [Assign a user or group to an enterprise app](../manage-apps/assign-user-or-group-access-portal.md)
44-
45-
## Important tips for assigning users to RingCentral
42+
## Step 1. Plan your provisioning deployment
43+
1. Learn about [how the provisioning service works](https://docs.microsoft.com/azure/active-directory/manage-apps/user-provisioning).
44+
2. Determine who will be in [scope for provisioning](https://docs.microsoft.com/azure/active-directory/manage-apps/define-conditional-rules-for-provisioning-user-accounts).
45+
3. Determine what data to [map between Azure AD and RingCentral](https://docs.microsoft.com/azure/active-directory/manage-apps/customize-application-attributes).
4646

47-
* It is recommended that a single Azure AD user is assigned to RingCentral to test the automatic user provisioning configuration. Additional users and/or groups may be assigned later.
48-
49-
* When assigning a user to RingCentral, you must select any valid application-specific role (if available) in the assignment dialog. Users with the **Default Access** role are excluded from provisioning.
50-
51-
## Set up RingCentral for provisioning
47+
## Step 2. Configure RingCentral to support provisioning with Azure AD
5248

5349
1. Sign in to your [RingCentral Admin Console](https://login.ringcentral.com/sw.html). Navigate to **Tools > Directory Integration**.
5450

@@ -63,37 +59,22 @@ Before configuring and enabling automatic user provisioning, you should decide w
6359
> [!NOTE]
6460
> To assign licenses to users, refer to the video link [here](https://support.ringcentral.com/s/article/5-10-Adding-Extensions-via-Web?language).
6561
66-
## Add RingCentral from the gallery
67-
68-
Before configuring RingCentral for automatic user provisioning with Azure AD, you need to add RingCentral from the Azure AD application gallery to your list of managed SaaS applications.
69-
70-
**To add RingCentral from the Azure AD application gallery, perform the following steps:**
71-
72-
1. In the **[Azure portal](https://portal.azure.com)**, in the left navigation panel, select **Azure Active Directory**.
62+
## Step 3. Add RingCentral from the Azure AD application gallery
7363

74-
![The Azure Active Directory button](common/select-azuread.png)
64+
Add RingCentral from the Azure AD application gallery to start managing provisioning to RingCentral. If you have previously setup RingCentral for SSO you can use the same application. However it is recommended that you create a separate app when testing out the integration initially. Learn more about adding an application from the gallery [here](https://docs.microsoft.com/azure/active-directory/manage-apps/add-gallery-app).
7565

76-
2. Go to **Enterprise applications**, and then select **All applications**.
66+
## Step 4. Define who will be in scope for provisioning
7767

78-
![The Enterprise applications blade](common/enterprise-applications.png)
68+
The Azure AD provisioning service allows you to scope who will be provisioned based on assignment to the application and or based on attributes of the user / group. If you choose to scope who will be provisioned to your app based on assignment, you can use the following [steps](../manage-apps/assign-user-or-group-access-portal.md) to assign users and groups to the application. If you choose to scope who will be provisioned based solely on attributes of the user or group, you can use a scoping filter as described [here](https://docs.microsoft.com/azure/active-directory/manage-apps/define-conditional-rules-for-provisioning-user-accounts).
7969

80-
3. To add a new application, select the **New application** button at the top of the pane.
70+
* When assigning users and groups to RingCentral, you must select a role other than **Default Access**. Users with the Default Access role are excluded from provisioning and will be marked as not effectively entitled in the provisioning logs. If the only role available on the application is the default access role, you can [update the application manifest](https://docs.microsoft.com/azure/active-directory/develop/howto-add-app-roles-in-azure-ad-apps) to add additional roles.
8171

82-
![The New application button](common/add-new-app.png)
72+
* Start small. Test with a small set of users and groups before rolling out to everyone. When scope for provisioning is set to assigned users and groups, you can control this by assigning one or two users or groups to the app. When scope is set to all users and groups, you can specify an [attribute based scoping filter](https://docs.microsoft.com/azure/active-directory/manage-apps/define-conditional-rules-for-provisioning-user-accounts).
8373

84-
4. In the search box, enter **RingCentral**, select **RingCentral** in the results panel, and then click the **Add** button to add the application.
8574

86-
![RingCentral in the results list](common/search-new-app.png)
75+
## Step 5. Configure automatic user provisioning to RingCentral
8776

88-
## Configuring automatic user provisioning to RingCentral
89-
90-
This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and/or groups in RingCentral based on user and/or group assignments in Azure AD.
91-
92-
> [!TIP]
93-
> You may also choose to enable SAML-based single sign-on for RingCentral , following the instructions provided in the [RingCentral Single sign-on tutorial](ringcentral-tutorial.md). Single sign-on can be configured independently of automatic user provisioning, though these two features compliment each other.
94-
95-
> [!NOTE]
96-
> To learn more about RingCentral's SCIM endpoint, refer to [RingCentral API Reference](https://developers.ringcentral.com/api-reference).
77+
This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and/or groups in TestApp based on user and/or group assignments in Azure AD.
9778

9879
### To configure automatic user provisioning for RingCentral in Azure AD:
9980

@@ -115,23 +96,38 @@ This section guides you through the steps to configure the Azure AD provisioning
11596

11697
5. Under the **Admin Credentials** section, input `https://platform.ringcentral.com/scim/v2` in **Tenant URL**. Input the **SCIM Authentication Token** value retrieved earlier in **Secret Token**. Click **Test Connection** to ensure Azure AD can connect to RingCentral. If the connection fails, ensure your RingCentral account has Admin permissions and try again.
11798

118-
![Tenant URL + Token](common/provisioning-testconnection-tenanturltoken.png)
99+
![Provisioning tab](./media/ringcentral-provisioning-tutorial/provisioning.png)
119100

120-
6. In the **Notification Email** field, enter the email address of a person or group who should receive the provisioning error notifications and check the checkbox - **Send an email notification when a failure occurs**.
101+
6. In the **Notification Email** field, enter the email address of a person or group who should receive the provisioning error notifications and select the **Send an email notification when a failure occurs** check box.
121102

122103
![Notification Email](common/provisioning-notification-email.png)
123104

124-
7. Click **Save**.
105+
7. Select **Save**.
125106

126107
8. Under the **Mappings** section, select **Synchronize Azure Active Directory Users to RingCentral**.
127108

128-
![RingCentral User Mappings](media/ringcentral-provisioning-tutorial/usermappings.png)
129-
130-
9. Review the user attributes that are synchronized from Azure AD to RingCentral in the **Attribute Mapping** section. The attributes selected as **Matching** properties are used to match the user accounts in RingCentral for update operations. Select the **Save** button to commit any changes.
131-
132-
![RingCentral User Attributes](media/ringcentral-provisioning-tutorial/userattributes.png)
133-
134-
10. To configure scoping filters, refer to the following instructions provided in the [Scoping filter tutorial](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md).
109+
9. Review the user attributes that are synchronized from Azure AD to RingCentral in the **Attribute-Mapping** section. The attributes selected as **Matching** properties are used to match the user accounts in RingCentral for update operations. If you choose to change the [matching target attribute](https://docs.microsoft.com/azure/active-directory/manage-apps/customize-application-attributes), you will need to ensure that the RingCentral API supports filtering users based on that attribute. Select the **Save** button to commit any changes.
110+
111+
|Attribute|Type|
112+
|---|---|
113+
|userName|String|
114+
|externalId|String|
115+
|active|Boolean|
116+
|displayName|String|
117+
|title|String|
118+
|emails[type eq "work"].value|String|
119+
|addresses[type eq "work"].country|String|
120+
|addresses[type eq "work"].region|String|
121+
|addresses[type eq "work"].locality|String|
122+
|addresses[type eq "work"].postalCode|String|
123+
|addresses[type eq "work"].streetAddress|String|
124+
|name.givenName|String|
125+
|name.familyName|String|
126+
|phoneNumbers[type eq "mobile"].value|String|
127+
|urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department|String|
128+
|urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager|Reference|
129+
130+
10. To configure scoping filters, refer to the following instructions provided in the [Scoping filter tutorial](../manage-apps/define-conditional-rules-for-provisioning-user-accounts.md).
135131

136132
11. To enable the Azure AD provisioning service for RingCentral, change the **Provisioning Status** to **On** in the **Settings** section.
137133

@@ -145,16 +141,20 @@ This section guides you through the steps to configure the Azure AD provisioning
145141

146142
![Saving Provisioning Configuration](common/provisioning-configuration-save.png)
147143

148-
This operation starts the initial synchronization of all users and/or groups defined in **Scope** in the **Settings** section. The initial sync takes longer to perform than subsequent syncs, which occur approximately every 40 minutes as long as the Azure AD provisioning service is running. You can use the **Synchronization Details** section to monitor progress and follow links to provisioning activity report, which describes all actions performed by the Azure AD provisioning service on RingCentral.
144+
This operation starts the initial synchronization cycle of all users and groups defined in **Scope** in the **Settings** section. The initial cycle takes longer to perform than subsequent cycles, which occur approximately every 40 minutes as long as the Azure AD provisioning service is running.
149145

150-
For more information on how to read the Azure AD provisioning logs, see [Reporting on automatic user account provisioning](../app-provisioning/check-status-user-account-provisioning.md).
146+
## Step 6. Monitor your deployment
147+
Once you've configured provisioning, use the following resources to monitor your deployment:
148+
149+
1. Use the [provisioning logs](https://docs.microsoft.com/azure/active-directory/reports-monitoring/concept-provisioning-logs) to determine which users have been provisioned successfully or unsuccessfully
150+
2. Check the [progress bar](https://docs.microsoft.com/azure/active-directory/manage-apps/application-provisioning-when-will-provisioning-finish-specific-user) to see the status of the provisioning cycle and how close it is to completion
151+
3. If the provisioning configuration seems to be in an unhealthy state, the application will go into quarantine. Learn more about quarantine states [here](https://docs.microsoft.com/azure/active-directory/manage-apps/application-provisioning-quarantine-status).
151152

152153
## Additional resources
153154

154-
* [Managing user account provisioning for Enterprise Apps](../app-provisioning/configure-automatic-user-provisioning-portal.md)
155+
* [Managing user account provisioning for Enterprise Apps](../manage-apps/configure-automatic-user-provisioning-portal.md)
155156
* [What is application access and single sign-on with Azure Active Directory?](../manage-apps/what-is-single-sign-on.md)
156157

157158
## Next steps
158159

159-
* [Learn how to review logs and get reports on provisioning activity](../app-provisioning/check-status-user-account-provisioning.md)
160-
160+
* [Learn how to review logs and get reports on provisioning activity](../manage-apps/check-status-user-account-provisioning.md)

0 commit comments

Comments
 (0)