|
| 1 | +--- |
| 2 | +title: 'Tutorial: Configure Cybozu for automatic user provisioning with Microsoft Entra ID' |
| 3 | +description: Learn how to automatically provision and deprovision user accounts from Microsoft Entra ID to Cybozu. |
| 4 | +services: active-directory |
| 5 | +author: twimmers |
| 6 | +writer: twimmers |
| 7 | +manager: jeedes |
| 8 | +ms.assetid: 338f2546-2e46-4c9e-b4e9-69146f3afaf8 |
| 9 | +ms.service: active-directory |
| 10 | +ms.subservice: saas-app-tutorial |
| 11 | +ms.workload: identity |
| 12 | +ms.topic: tutorial |
| 13 | +ms.date: 09/21/2023 |
| 14 | +ms.author: thwimmer |
| 15 | +--- |
| 16 | + |
| 17 | +# Tutorial: Configure Cybozu for automatic user provisioning |
| 18 | + |
| 19 | +This tutorial describes the steps you need to perform in both Cybozu and Microsoft Entra ID to configure automatic user provisioning. When configured, Microsoft Entra ID automatically provisions and deprovisions users to [Cybozu](https://www.cybozu.com/jp/) using the Microsoft Entra 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 Microsoft Entra ID](../app-provisioning/user-provisioning.md). |
| 20 | + |
| 21 | + |
| 22 | +## Supported capabilities |
| 23 | +> [!div class="checklist"] |
| 24 | +> * Create users in Cybozu. |
| 25 | +> * Remove users in Cybozu when they do not require access anymore. |
| 26 | +> * Keep user attributes synchronized between Microsoft Entra ID and Cybozu. |
| 27 | +> * [Single sign-on](cybozu-tutorial.md) to Cybozu (recommended). |
| 28 | +
|
| 29 | +## Prerequisites |
| 30 | + |
| 31 | +The scenario outlined in this tutorial assumes that you already have the following prerequisites: |
| 32 | + |
| 33 | +* [A Microsoft Entra tenant](../develop/quickstart-create-new-tenant.md) |
| 34 | +* A user account in Microsoft Entra ID with [permission](../roles/permissions-reference.md) to configure provisioning (for example, Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator). |
| 35 | +* A user account in Cybozu with Admin permissions. |
| 36 | + |
| 37 | +## Step 1: Plan your provisioning deployment |
| 38 | +* Learn about [how the provisioning service works](../app-provisioning/user-provisioning.md). |
| 39 | +* Determine who will be in [scope for provisioning](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md). |
| 40 | +* Determine what data to [map between Microsoft Entra ID and Cybozu](../app-provisioning/customize-application-attributes.md). |
| 41 | + |
| 42 | +## Step 2: Configure Cybozu to support provisioning with Microsoft Entra ID |
| 43 | +Contact Cybozu support to configure Cybozu to support provisioning with Microsoft Entra ID. |
| 44 | + |
| 45 | +## Step 3: Add Cybozu from the Microsoft Entra application gallery |
| 46 | + |
| 47 | +Add Cybozu from the Microsoft Entra application gallery to start managing provisioning to Cybozu. If you have previously setup Cybozu for SSO, you can use the same application. However it's recommended that you create a separate app when testing out the integration initially. Learn more about adding an application from the gallery [here](../manage-apps/add-application-portal.md). |
| 48 | + |
| 49 | +## Step 4: Define who will be in scope for provisioning |
| 50 | + |
| 51 | +The Microsoft Entra provisioning service allows you to scope who will be provisioned based on assignment to the application and or based on attributes of the user. 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 to the application. If you choose to scope who will be provisioned based solely on attributes of the user, you can use a scoping filter as described [here](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md). |
| 52 | + |
| 53 | +* Start small. Test with a small set of users before rolling out to everyone. When scope for provisioning is set to assigned users, you can control this by assigning one or two users to the app. When scope is set to all users, you can specify an [attribute based scoping filter](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md). |
| 54 | + |
| 55 | +* If you need more roles, you can [update the application manifest](../develop/howto-add-app-roles-in-azure-ad-apps.md) to add new roles. |
| 56 | + |
| 57 | + |
| 58 | +## Step 5: Configure automatic user provisioning to Cybozu |
| 59 | + |
| 60 | +This section guides you through the steps to configure the Microsoft Entra provisioning service to create, update, and disable users in TestApp based on user assignments in Microsoft Entra ID. |
| 61 | + |
| 62 | +<a name='to-configure-automatic-user-provisioning-for-Cybozu-in-azure-ad'></a> |
| 63 | + |
| 64 | +### To configure automatic user provisioning for Cybozu in Microsoft Entra ID: |
| 65 | + |
| 66 | +1. Sign in to the [Microsoft Entra admin center](https://entra.microsoft.com) as at least a [Cloud Application Administrator](../roles/permissions-reference.md#cloud-application-administrator). |
| 67 | +1. Browse to **Identity** > **Applications** > **Enterprise applications** |
| 68 | + |
| 69 | +  |
| 70 | + |
| 71 | +1. In the applications list, select **Cybozu**. |
| 72 | + |
| 73 | +  |
| 74 | + |
| 75 | +1. Select the **Provisioning** tab. |
| 76 | + |
| 77 | +  |
| 78 | + |
| 79 | +1. Set the **Provisioning Mode** to **Automatic**. |
| 80 | + |
| 81 | +  |
| 82 | + |
| 83 | +1. Under the **Admin Credentials** section, input your Cybozu Tenant URL and Secret Token. Click **Test Connection** to ensure Microsoft Entra ID can connect to Cybozu. If the connection fails, ensure your Cybozu account has Admin permissions and try again. |
| 84 | + |
| 85 | +  |
| 86 | + |
| 87 | +1. In the **Notification Email** field, enter the email address of a person who should receive the provisioning error notifications and select the **Send an email notification when a failure occurs** check box. |
| 88 | + |
| 89 | +  |
| 90 | + |
| 91 | +1. Select **Save**. |
| 92 | + |
| 93 | +1. Under the **Mappings** section, select **Synchronize Microsoft Entra users to Cybozu**. |
| 94 | + |
| 95 | +1. Review the user attributes that are synchronized from Microsoft Entra ID to Cybozu in the **Attribute-Mapping** section. The attributes selected as **Matching** properties are used to match the user accounts in Cybozu for update operations. If you choose to change the [matching target attribute](../app-provisioning/customize-application-attributes.md), you need to ensure that the Cybozu API supports filtering users based on that attribute. Select the **Save** button to commit any changes. |
| 96 | + |
| 97 | + |Attribute|Type|Supported for filtering|Required by Cybozu| |
| 98 | + |---|---|---|---| |
| 99 | + |userName|String|✓|✓ |
| 100 | + |active|Boolean|| |
| 101 | + |displayName|String|| |
| 102 | + |emails[type eq "work"].value|String|| |
| 103 | + |name.givenName|String|| |
| 104 | + |name.familyName|String|| |
| 105 | + |externalId|String|| |
| 106 | + |
| 107 | +1. 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). |
| 108 | + |
| 109 | +1. To enable the Microsoft Entra provisioning service for Cybozu, change the **Provisioning Status** to **On** in the **Settings** section. |
| 110 | + |
| 111 | +  |
| 112 | + |
| 113 | +1. Define the users that you would like to provision to Cybozu by choosing the desired values in **Scope** in the **Settings** section. |
| 114 | + |
| 115 | +  |
| 116 | + |
| 117 | +1. When you're ready to provision, click **Save**. |
| 118 | + |
| 119 | +  |
| 120 | + |
| 121 | +This operation starts the initial synchronization cycle of all users 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 Microsoft Entra provisioning service is running. |
| 122 | + |
| 123 | +## Step 6: Monitor your deployment |
| 124 | +Once you've configured provisioning, use the following resources to monitor your deployment: |
| 125 | + |
| 126 | +* Use the [provisioning logs](../reports-monitoring/concept-provisioning-logs.md) to determine which users have been provisioned successfully or unsuccessfully |
| 127 | +* Check the [progress bar](../app-provisioning/application-provisioning-when-will-provisioning-finish-specific-user.md) to see the status of the provisioning cycle and how close it's to completion |
| 128 | +* If the provisioning configuration seems to be in an unhealthy state, the application goes into quarantine. Learn more about quarantine states [here](../app-provisioning/application-provisioning-quarantine-status.md). |
| 129 | + |
| 130 | +## More resources |
| 131 | + |
| 132 | +* [Managing user account provisioning for Enterprise Apps](../app-provisioning/configure-automatic-user-provisioning-portal.md) |
| 133 | +* [What is application access and single sign-on with Microsoft Entra ID?](../manage-apps/what-is-single-sign-on.md) |
| 134 | + |
| 135 | +## Next steps |
| 136 | + |
| 137 | +* [Learn how to review logs and get reports on provisioning activity](../app-provisioning/check-status-user-account-provisioning.md) |
0 commit comments