Feishu integration

更新时间:
复制 MD 格式

The Feishu integration allows you to synchronize your Feishu contacts with your Qoder CN enterprise, enabling single sign-on and message notifications.

Applicable edition

Exclusive Edition

Create out-of-scope users

To create users outside the Feishu synchronization scope, select the Support built-in users option. Enterprise administrators can configure and manage the Feishu integration in enterprise management > third-party integration.

Configure Feishu integration

Step 1: Configure an internal application

  1. First, create an internal application for Qoder CN on the Feishu Open Platform. For more information, see How to create a custom application.

    In the pop-up window, enter a Name (up to 32 characters) and an App Description (up to 120 characters), and upload an App Icon (JPEG, PNG, SVG, or BMP, under 2 MB, and at least 240×240 px). Then, click Create.

  2. After creating the application, you can find the App ID and App Secret in App Details > credentials and basic information.

  3. Paste the App ID and App Secret from your Feishu application credentials into the corresponding input fields.

    After entering all the required information for the internal application, click Next.

Step 2: Configure application permissions

  1. Qoder CN requires specific permissions from Feishu to synchronize contacts, enable single sign-on, and send message notifications. The required permissions are listed below:

Contacts management

Read basic information of contacts

Read basic information of departments

Read organizational structure of contacts

Read basic user information

Read user organizational structure information

Read user email information

Read user ID

Read personal email information

Messages & groups

Send direct and group messages

  1. On the application details page in the Feishu Open Platform, navigate to permission management to configure these permissions. You can also limit the scope of users to be synchronized from Feishu contacts.

Step 3: Configure information synchronization and mapping

Account binding method: The system automatically binds users in Qoder CN and Feishu who have the same email address.

image

Qoder CN automatically maps and synchronizes user information from Feishu to Qoder CN based on the sync policy and the field mappings below. These mappings cannot be modified. After confirming the settings, click Next.

The default field mappings are: Name maps to name (enabled by default), Email maps to email (enabled by default), Mobile maps to mobile, Department maps to department_ids (enabled by default), Employee ID maps to employee_no, and Nickname maps to nickname.

Step 4: Enable Feishu integration services

Four services are available:

  • User and organization synchronization.

  • Single sign-on.

  • Message notifications.

  • Access Qoder CN in the Feishu client.

By default, these services are disabled during configuration. If you save the Feishu integration without enabling them, you can enable them later from the Feishu integration details page.

You must configure any service you choose to enable. The following sections describe the configuration for each service.

Enable user and organization synchronization

You can configure user and organization synchronization from Feishu provided no other Qoder CN third-party integration is already configured for this purpose. You can set rules for the synchronization schedule and how to handle user and organization discrepancies.

  • Data synchronization timing: The default setting is manual synchronization. You can switch between manual and scheduled synchronization:

    • Manual synchronization: An enterprise administrator must manually start a sync by clicking Run Manual Sync on the Feishu integration details page whenever data needs to be updated.

      Note

      Tip: We recommend waiting at least one hour between manual synchronization operations.

    • Scheduled synchronization: Configure a schedule to synchronize data daily (at a specific time), weekly (on a specific day and time), monthly (on a specific day and time), or at a set interval. If you set up a scheduled sync, we recommend running an initial manual sync after saving your configuration to immediately synchronize the data to Qoder CN.

  • Handling user discrepancies: By default, the system ignores extra accounts in Qoder CN and creates and binds Qoder CN accounts for Feishu accounts within the synchronization scope. You can modify this behavior as needed.

    • Existing Qoder CN account not matched with a Feishu account - Ignore: When an existing Qoder CN account is not matched with a Feishu account, the extra account on Qoder CN is not deleted.

    • An existing Qoder CN account is not matched with a Feishu account - Delete the Qoder CN account: When an existing Qoder CN account is not matched with a Feishu account, delete the account on Qoder CN.

    • Existing Feishu account not matched to a Qoder CN account - Ignore: When an existing Feishu account cannot be matched to a Qoder CN account, a new account is not created in Qoder CN.

    • If an existing Feishu account does not match a Qoder CN account, a new Qoder CN account is created and bound to it. When an existing Feishu account does not match a Qoder CN account, a new account is created on Qoder CN and bound to the Feishu account based on the Account Binding and Attribute Mapping rules.

  • Handling organization discrepancies: By default, the system ignores extra department nodes in Qoder CN and creates and binds Qoder CN departments for Feishu departments within the synchronization scope. You can modify this behavior as needed:

    • Existing Qoder CN departments unmatched in Feishu - Ignore: If a Qoder CN department does not have a match in Feishu, its node in Qoder CN is not deleted.

    • An existing Qoder CN department not found in Feishu - Delete the Qoder CN department: When an existing Qoder CN department is not found in Feishu, the department node in Qoder CN is deleted.

    • Existing Feishu department not matched to a Qoder CN department - Ignore: When an existing Feishu department is not matched to a Qoder CN department, department nodes are not created in Qoder CN.

    • An existing Feishu department is not matched to a Qoder CN department - Create a Qoder CN department and bind it: When an existing Feishu department is not matched to a Qoder CN department, a department node is created on Qoder CN, and the two department nodes are bound.

Enable single sign-on

To enable single sign-on, turn on the single sign-on switch and paste the Qoder CN callback URL into the redirect URL field in your Feishu application's security settings. This completes the single sign-on configuration.

The callback URL is https://yunxiao-dev.devops.aliyun.com/users/callback/lark. Copy this URL and paste it into the redirect URL field in your Feishu application.

Enable message notifications

To enable message notifications, you must first enable the bot feature in your Feishu application. Then, choose a notification method. Two methods are supported:

  • Through account binding: This requires enabling user and organization synchronization or single sign-on. Once Qoder CN accounts are bound to Feishu accounts, the corresponding Feishu accounts will receive notifications.

  • By email: Users can add their Feishu-bound email address in their personal settings to receive notifications.

In the Feishu Open Platform developer console, navigate to App Capabilities > Add App Capability from the left-side navigation. On the Add by Capability tab, find the Bot card and click + Add.

Access Qoder CN in Feishu

If you need to access Qoder CN from the workbench of the Feishu PC client, you can enable the switch to access Qoder CN in the client. You also need to go to the Feishu Open Platform. For the Feishu application that you created in the first step, go to Application Details > App Features, enable the web application feature, paste the Qoder CN web address below into the desktop homepage input box of the web application, and save the configuration.

After configuring the features, you must publish the application in the Feishu Open Platform to apply the changes. In the App Details > App Release > Version Management and Release section of your Feishu application, create a new version and publish it. For more details, refer to the Feishu documentation on Application Publishing and Usage.

After completing all configurations, click Save to finish setting up the Feishu integration.

Sign in to Qoder CN with Feishu

After single sign-on is enabled, the Qoder CN login page displays a Feishu login option, which users who have linked their Feishu accounts can click to log on to Qoder CN.

View user and organization sync results

After you enable user and organization synchronization, the Feishu integration details page shows the latest synchronization status. The status can be: Not synchronized, Succeeded, Failed, or Partially Succeeded.

Modify or disable Feishu integration services

On the Feishu integration details page, each enabled service has a Modify Service Configuration button. Click this button to modify or disable the service.

  • Disable user and organization synchronization:

    • The binding between Qoder CN accounts and Feishu accounts is not removed.

    • User and organization synchronization from Feishu will stop.

  • Disable single sign-on:

    • The binding between Qoder CN accounts and Feishu accounts is not removed.

    • Users can no longer sign in to Qoder CN using their Feishu account. They must use their Qoder CN username and password.

  • Disable message notifications:

    • Message notifications are disabled if a Feishu email is not configured and both user and organization synchronization and single sign-on are also disabled.

    • After disabling, notifications will no longer be sent via Feishu.

  • Disable access to Qoder CN from the Feishu client:

    • Users can no longer access Qoder CN from the Feishu desktop client's workspace.

Remove Feishu integration

On the Feishu integration details page, click the Remove Integration button and confirm the action. After removal:

  • The binding between Qoder CN and Feishu accounts is removed, but this does not affect previously synchronized user and organization information.

  • You will no longer receive Feishu message notifications.

  • You can no longer sign in to Qoder CN with Feishu. You must use your Qoder CN username and password to sign in.