Overview

Torii integrates with Lark and syncs:

• Users, including their status and role (Admin for the organization's super administrator, Member for everyone else).
• Licenses. Every synced user holds one license named Lark.
• You can constantly stay updated with application information from our Integrations Page >> Integration Capabilities button >> Integration Capabilities table.

This integration supports the international version of Lark (open.larksuite.com). Feishu is not supported.

Requirements

To connect this integration, we require the following:

Accounts & Permissions

• A Lark organization account.
• Access to the Lark Developer Console, to create a custom (self-built) app.
• A Lark administrator of your organization, to approve the app.
• Any Lark plan, including Starter. Custom apps can call the Lark API on every plan.

Scopes

• contact:department.organize:readonly - for retrieving your organization's departments.
• contact:user.base:readonly - for retrieving the members of each department and their names.
• contact:user.employee:readonly - for retrieving each user's status and role.
• contact:user.email:readonly - for retrieving user email addresses.
• tenant:tenant:readonly - for retrieving your Lark organization's name and ID.
• contact:contact - required only for performing actions within Torii (Create User, Update User and Delete User).
• contact:user.id:readonly - required only for the Update User and Delete User actions, to find the user by email.

Required keys

• App ID of the custom app.
• App Secret of the custom app.

How to Generate the Required Values

Follow these steps to generate the required values:

Step 1: Create a custom app

1. Sign in to the Lark Developer Console as a member of your Lark organization.
2. Create a custom (self-built) app for your organization. Enter an app name, a description and an icon, and save.

Step 2: Enable the API permissions

1. In the app's page in the Developer Console, open the permissions management page (under the development configuration section).
2. On the API permissions tab, select the scopes listed in the Scopes section above and enable them.
3. Set the app's contact permission scope to All members, so that Torii can see every user and department in your organization.

Step 3: Publish the app

1. In the app's page, open the version management and release page (under the app release section) and create a version.
2. Review the version details, save, and request to publish the app.
3. Ask a Lark administrator of your organization to approve the request. The permissions take effect only after the app is approved and published.

Step 4: Copy the App ID and App Secret

1. In the app's page, open the credentials and basic information page (under the basic information section).
2. Copy the App ID and the App Secret.

How to Connect the Integration

1. Go to the Integrations page in Torii.
2. Search for Lark and click Connect.
3. Enter the App ID and App Secret.
4. Click Connect.

Actions

• Create User - creates a user in Lark. Requires the contact:contact scope and the contact permission scope set to All members. The user is added to the root department. This action does not assign a seat, so it fails in organizations that use mixed-license mode.
• Update User - updates a user's name and job title in Lark. Fields left empty are not changed.
• Delete User - removes a user from Lark. Lark treats this as a resignation: the user's documents and calendars are transferred to their direct leader, or deleted if the user has no direct leader.

For any further questions, please contact Torii Support.