Bind organizations to sync organization structures and members

Updated at:

This topic is for administrators who maintain Apsara DevOps and DingTalk organizations. It describes how to link an Apsara DevOps organization with a DingTalk organization. This link enables organization structure and member synchronization, DingTalk message notifications, and DingTalk Docs integration.

Prerequisites

  • To bind an Apsara DevOps organization to a DingTalk organization, you must first install the Apsara DevOps application in your DingTalk organization.

  • You must have the DingTalk administrator or sub-administrator role.

Install Apsara DevOps in DingTalk

A DingTalk administrator can add sub-administrators in the DingTalk Admin Console (https://oa.dingtalk.com) > Settings > Set Sub-administrator, or in the DingTalk mobile app > Manage > Set Administrator. For more information, see the DingTalk Help Center.

  1. Open the DingTalk mobile app and scan the QR code for the Apsara DevOps application, or search for "Apsara DevOps" on the Workbench to create an organization and install the application.

    Apsara DevOps application QR code

  2. After scanning the QR code, you are taken to the Product Details page. Click Activate for Free. On the configuration page, select a Scope (for example, All Employees), select the check boxes to agree to the Service Agreement, Authorization Details, and Privacy Policy, and then click Activate Now.

    Note

    Scope: specifies which members are synchronized to Apsara DevOps. If you do not select department synchronization and only synchronize individual members, Apsara DevOps cannot retrieve department information from DingTalk, and the department information for those members will not be visible in Apsara DevOps.

    Important

    Apsara DevOps does not support the School Address Book (students and parents) in DingTalk. If the industry type of your DingTalk organization is Education, you must select specific employees in the scope settings and exclude the School Address Book (students and parents).

Bind a DingTalk organization to an Apsara DevOps organization

Before you perform this operation, make sure that you have the Apsara DevOps organization administrator role. After the organization structure is synchronized, the Apsara DevOps organization structure is replaced with the DingTalk organization structure. Members who have not bound a DingTalk account are moved to Unassigned Members. After the binding, they are moved to the corresponding organization structure. Additions and deletions made to the organization structure in the DingTalk admin console are automatically synchronized to Apsara DevOps.

  1. In the DingTalk mobile app, go to Workbench > Apsara DevOps to open the application. If your DingTalk organization is not bound to an Apsara DevOps organization, you are taken to the page for binding or creating an organization.

  2. Create or bind an Alibaba Cloud account. Select the binding method based on the type of the destination account that you want to bind.

    Bind an Alibaba Cloud account
    • To register a new Alibaba Cloud account:

      Click Create/Bind Alibaba Cloud Account to go to the Alibaba Cloud registration page. Enter your mobile phone number, select a DingTalk organization, select the check box to agree to the service agreement, and then click Confirm Registration. After the registration is complete, you can complete Quick Real-name Verification or click Return. Return to the Apsara DevOps homepage and select the bound Alibaba Cloud account in the account list to log on.

    • To bind an existing Alibaba Cloud account:

      In the dialog box that appears, click Create/Bind Alibaba Cloud Account to go to the initial logon settings page. Click Bind Alibaba Cloud Account and Log On. On the Bind Alibaba Cloud Account page, enter your email address, member name, or 8-digit ID and your logon password, and then click Verify and Join to complete the binding. After the binding is complete, you are taken to the Apsara DevOps homepage.

    Bind a RAM user

    Procedure: In the dialog box that appears, select Bind RAM User to go to the RAM user logon page. Enter the RAM user name in the format of <username>@<default domain> or <username>@<enterprise alias>, click Next, enter the user password, and then click Log On. On the RAM User and DingTalk Binding page, confirm the DingTalk account and organization information, and then click Confirm Binding. After the binding is complete, a success message appears and the DingTalk QR code logon address is displayed. Click OK.

  3. Bind an existing Apsara DevOps organization or create a new Apsara DevOps organization.

    Bind an existing Apsara DevOps organization

    On the Bind Apsara DevOps Enterprise page, enter the enterprise name in the search box, select the target enterprise from the list, and then click Bind. After the binding is complete, a Binding Succeeded message appears. You can visit https://devops.aliyun.com on a PC to try more features.

    Create a new Apsara DevOps organization

    On the Bind Apsara DevOps Enterprise page, click Create Apsara DevOps Organization. The system automatically creates an Apsara DevOps organization with the same name as your DingTalk organization and completes the binding between the two organizations. After the binding is complete, a Binding Succeeded message appears.

  4. After the binding is complete, return to the web version of Apsara DevOps. Go to Organization Management Console > Members to view the binding information. The Apsara DevOps organization structure has been replaced with the DingTalk organization structure.

  5. Activate Apsara DevOps users:

    • Members of the DingTalk organization must access Apsara DevOps and bind their DingTalk accounts to activate their Apsara DevOps user profiles. For more information about how to activate Apsara DevOps users, see Organizations.

    • Activate Apsara DevOps members by sharing a link.

      Method 1: Invite target members

      Go to Organization Management Console > Member Management > Members. Click Add Members, select Invite Organization Members, copy the invitation link, and share it with the relevant groups. Members can access this link to activate their Apsara DevOps membership. On the Member Management page, click the invitation entry to open the Invite Enterprise Members dialog box and select the Invite through DingTalk tab. After you confirm the bound DingTalk enterprise, follow these steps: Step 1, the DingTalk administrator confirms the enterprise members in the address book; Step 2, the members bind their DingTalk accounts to join Apsara DevOps. The administrator can choose to send DingTalk notifications, or click Copy in the text box below to copy the invitation link and share it to a work group or mailing list.

      Method 2: Invite members who have never logged on

      Go to Organization Management Console > Member Management > Members. Click the link area shown in the figure, Copy Invitation Link, and share the link with members who have not logged on. Members can access this link to activate their Apsara DevOps membership.

      The link is located in the blue prompt bar at the top of the Never Logged On tab. The link text is Share Link to Email Group or Work Group.

Modify the synchronized part of the organization structure

  1. On the Workbench, open Apsara DevOps.

  2. Select Application Management to modify the Visible Scope.

  3. To make changes, go to Visible Scope. Select the items that you want to synchronize, and then follow the on-screen instructions to complete the setup.

Important

If you do not select department synchronization and only synchronize individual members, Apsara DevOps cannot retrieve department information from DingTalk, and the department information for those members will not be visible in Apsara DevOps.

DingTalk message notifications

  • After you bind your DingTalk account at both the organization and individual levels (including organization binding and individual binding), actions that trigger notifications, such as creating or modifying a task, send a Work Notification message to the DingTalk accounts of the task participants.

  • You do not receive work notifications for actions that you perform.

  • Work notifications are sent only to task participants. If you are not a participant in a specific task, you will not receive the work notification for that task, even if you are the project owner.

DingTalk notifications are sent for the following events:

Project module

Dynamic Notifications

Project Collaboration

Basic events: Includes creating a task, moving a task, or moving a task to the recycle bin.

Update events: Includes notifications for comments, status changes, content updates, assignee changes, due date changes, and priority changes.

Events related to linked content.

Code Management

Notifications for third-party library import events.

Operations on merge requests.

Changes to member permissions.

Transfers or path changes for repositories or groups.

Notifications for code repository or group deletion events.

Changes to the visibility of repositories or groups.

Alerts.

Pipelines

Manual review notifications.

Adding, deleting, or modifying members of a pipeline.

Failures or cancellations of pipeline runs.

Deleting pipelines.

You can transfer the pipeline owner.

Unbind an organization

If you have bound an organization and want to switch to a different one or unbind it, you can unbind it in Apsara DevOps and then follow the steps described earlier to bind a new organization. To unbind an organization:

Contact an organization administrator to go to the Admin Console > Third-Party Binding. Click Unbind and follow the prompts to unbind the Apsara DevOps organization from the DingTalk organization. After the organizations are unbound, the organization structure reverts to the one defined in Apsara DevOps.