Skip to main content

Lark

Updated

Overview

This guide explains how to integrate Lark on the App Catalog page in Josys.

Integration Specifications

Target Plans STARTER, PRO, ENTERPRISE
Required Admin Role Super Administrator 
Integration Method OAuth 
Integration Key Email
Supported Actions Delete Account Account Visualization 
Statuses Excluded from Unmanaged IDs Deleted 
Provisioning Settings  
Deprovisioning Settings  
Contract Information -
Other Retrieved Items ・Department (Lark)
・Job Title (Lark)
Visible Items ・Status
・Department (Lark)
・Job Title (Lark)
Retrieved Items for License Management  
Common Items Status User 
Retrieved Permission Types -
Edit Permissions  
Target Accounts -

Generating an API Token

  1. Log in to the Lark Developer console using a Super Administrator account.
    Click CREATE APP.
  2. Click CreateCustom App, enter the App Name and Description, and click Create.
  3. Go to Permissions & Scopes, click Batch import/export scopes,
    Copy and paste the following scopes to add them. 
    
  "scopes": {
    "tenant": [
      "contact:contact",
      "admin:app.info:readonly",
      "contact:contact.base:readonly",
      "contact:department.base:readonly",
      "contact:department.organize:readonly",
      "contact:group:readonly",
      "contact:user.base:readonly",
      "contact:user.department:readonly",
      "contact:user.dotted_line_leader_info.read",
      "contact:user.email:readonly",
      "contact:user.employee:readonly",
      "contact:user.employee_id:readonly",
      "contact:user.gender:readonly",
      "contact:user.phone:readonly",
      "contact:user.user_geo",
      "tenant:tenant:readonly"
    ],
    "user": [
      "contact:contact",
      "contact:contact.base:readonly",
      "contact:department.base:readonly",
      "contact:department.organize:readonly",
      "contact:user.base:readonly",
      "contact:user.department:readonly",
      "contact:user.department_path:readonly",
      "contact:user.dotted_line_leader_info.read",
      "contact:user.email:readonly",
      "contact:user.employee:readonly",
      "contact:user.employee_id:readonly",
      "contact:user.gender:readonly",
      "contact:user.phone:readonly",
      "contact:user.user_geo"
    ]
  }
}

  4. In Security Settings, add the following URL to Redirect URLs. https://app.josys.it/admin/integrations/callback/lark

  5. In Version Management & Release, click Create a version, create a version, and then click Submit for release.
    *If you have set up an app approval flow, a review by the Super Administrator is required.

  6. Copy the Client ID and Client Secret.

Integrating with Josys

  1. From the left sidebar of Josys, click Integrations > App Catalog.
  2. Search for Lark and click it.
  3. The setup page will appear on the right side.
  4. Enter the Client ID and Client Secret, click Next, and then log in with your Super Administrator account to complete the integration.

Related articles