Tutorial: Configure Chatwork for automatic user provisioning

This tutorial describes the steps you need to perform in both Chatwork and Microsoft Entra ID to configure automatic user provisioning. When configured, Microsoft Entra ID automatically provisions and de-provisions users and groups to Chatwork 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.

Capabilities Supported

• Create users in Chatwork.
• Remove users in Chatwork when they do not require access anymore.
• Keep user attributes synchronized between Microsoft Entra ID and Chatwork.
• Single sign-on to Chatwork (required).

Prerequisites

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

• A Microsoft Entra tenant.
• A user account in Microsoft Entra ID with permission to configure provisioning (for example, Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator).
• A Chatwork tenant.
• A user account in Chatwork with Admin permission.
• Organizations that have contracted Chatwork Enterprise Plan or KDDI Chatwork.

Step 1: Plan your provisioning deployment

1. Learn about how the provisioning service works.
2. Determine who will be in scope for provisioning.
3. Determine what data to map between Microsoft Entra ID and Chatwork.

Step 2: Configure Chatwork to support provisioning with Microsoft Entra ID

1. Open User Synchronization from the Chatwork admin page

Access the Chatwork admin portal as a user with admin rights. If you have administrator privileges, you will be able to access the User Synchronization page.

User Synchronization page contains notes and restrictions for using the user provisioning feature. Check all the items.

2. Configure the SAML login settings.

If you are using Microsoft Entra ID and user provisioning, login to Chatwork using your Microsoft Entra ID.

3. Check the checkboxes after accepting the various items.

Check the checkboxes after accepting the cautions and restrictions for using the user provisioning function.

When all the items are checked, click the Enable user synchronization button.

When the user provisioning function is enabled, a message will appear at the top of the page indicating that it has been enabled.

Step 3: Add Chatwork from the Microsoft Entra application gallery

Add Chatwork from the Microsoft Entra application gallery to start managing provisioning to Chatwork. If you have previously setup Chatwork 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.

Step 4: Define who will be in scope for provisioning

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 / group. If you choose to scope who will be provisioned to your app based on assignment, you can use the following steps 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.

• 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.

• If you need additional roles, you can update the application manifest to add new roles.

Step 5: Configure automatic user provisioning to Chatwork

This section guides you through the steps to configure the Microsoft Entra provisioning service to create, update, and disable users and/or groups in Chatwork based on user and/or group assignments in Microsoft Entra ID.

To configure automatic user provisioning for Chatwork in Microsoft Entra ID:

1. Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.

2. Browse to Identity > Applications > Enterprise applications

   

3. In the applications list, select Chatwork.

   

4. Select the Provisioning tab.

   

5. Set the Provisioning Mode to Automatic.

   

6. In the Admin Credentials section, click on Authorize, make sure that you enter your Chatwork account's Admin credentials. Click Test Connection to ensure Microsoft Entra ID can connect to Chatwork. If the connection fails, ensure your Chatwork account has Admin permissions and try again.

   

7. 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.

   

8. Select Save.

9. In the Mappings section, select Synchronize Microsoft Entra users to Chatwork.

10. Review the user attributes that are synchronized from Microsoft Entra ID to Chatwork in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the user accounts in Chatwork for update operations. If you choose to change the matching target attribute, you will need to ensure that the Chatwork API supports filtering users based on that attribute. Select the Save button to commit any changes.

    Attribute	Type	Supported for filtering
    userName	String	✓
    active	Boolean
    title	String
    externalId	String
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department	String
    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:organization	String

11. To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.

12. To enable the Microsoft Entra provisioning service for Chatwork, change the Provisioning Status to On in the Settings section.

    

13. Define the users and/or groups that you would like to provision to Chatwork by choosing the desired values in Scope in the Settings section.

    

14. When you are ready to provision, click Save.

    

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 Microsoft Entra provisioning service is running.

Step 6: Monitor your deployment

Once you've configured provisioning, use the following resources to monitor your deployment:

• Use the provisioning logs to determine which users have been provisioned successfully or unsuccessfully
• Check the progress bar to see the status of the provisioning cycle and how close it is to completion
• If the provisioning configuration seems to be in an unhealthy state, the application will go into quarantine. Learn more about quarantine states here.

More resources

• Managing user account provisioning for Enterprise Apps
• What is application access and single sign-on with Microsoft Entra ID?

Next steps

• Learn how to review logs and get reports on provisioning activity