AI Coding Assistant Lingma:API integration

Step 1: Configure the data request URL

a. Enter the data request URL. Both HTTP and HTTPS are supported. Make sure the API is accessible.

b. Click Next once the test for API access passes.

Response of the API calls

The response should be structured as the following sample:

{
  "users": [
    {
      "user_id": "yx12346xxx",
      "name": "zhoux",
      "user_name": "zhouxxx",
      "nick_name": "xxwai",
      "staff_id": "004xx5",
      "email": "zhouxxx@alibaba-inc.com",
      "department_ids": [
        "16xxx2"
      ]
    }
  ],
  "departments": [
    {
      "department_id": "A_id",
      "name": "A",
    },
    {
      "department_id": "B_id",
      "name": "B",
      "parent_id": "A_id"
    }
  ],
  "next_page_number": 1
}

The departments returned as a list contains all departments that users belong to. Pagination must base on the number of users, and the data of parent department must be returned before child department (for example, if department A is the parent of department B, the data of department A must be listed in the departments before the data of department B. See sample response above).

API Response Field Reference

Step 2: Configure user sync

a. Fill in the following fields.

b. Click Next once you have finished filling in all the fields.

System will link accounts with any of the following matching attributes across the API and Lingma:

• Link Accounts with Same Email

• Link Accounts with Same Username

• Link Accounts with Same Mobile Number

• Link Accounts with Employee ID

Ensure the uniqueness and existence of the attribute, as Lingma will perform one-to-one account matching based on it. The following picture explains the procedure of linking accounts.

Step 3: Enable the synchronization of organizations and users

a. Enable the sync between organizations and users on Lingma when no other third-party synchronization services are active. You can configure the synchronization timing and user and organization difference handling rules.

b. User synchronization can also be enabled later on the Identity Providers page by clicking Enable Services.

c. To finalize all configurations, click the Save Configuration button.

• Data synchronization supports both manual and scheduled execution.

  • Manual synchronization: Administrator need to manually execute synchronization by selecting Manual on the product page.

    Note

    Manual synchronization operations should be spaced at least one hour apart.

  • Scheduled synchronization: can be set daily, weekly, monthly, or at regular intervals. It is suggested to perform a manual synchronization after saving the scheduled settings, to synchronize the current data to Lingma.

• User data synchronization rules

  Default Behavior:

  • Ignore redundant Lingma accounts not mapped to third-party sources.

  • Create Lingma accounts for third-party accounts within the sync scope if no corresponding accounts exist, and bind them using defined rules.

  • Customizable Settings:

    Scenario	Handling Mode Options
    Existing Lingma accounts, not linked to third-party accounts	- Ignore: retained in Lingma without deletion. - Delete: removed during synchronization.
    Existing third-party accounts, not linked to Lingma accounts	- Ignore: no Lingma account has been created. - Create & Bind: new Lingma account created and associated with the third-party account via binding and attribute mapping rules.

• Department synchronization policies

  Default Behavior:

  • Ignore redundant Lingma departments not mapped to third-party sources.

  • Create Lingma departments for third-party accounts within the sync scope if no corresponding departments exist, and bind them.

    • Customizable Settings:

      Scenario	Handling Mode Options
      Existing Lingma departments, not linked to third-party departments	- Ignore: retained in Lingma without deletion. - Delete: removed during synchronization.
      Existing third-party departments, not linked to Lingma departments	- Ignore: no Lingma department is created. - Create & Bind: new Lingma department created and linked to the third-party department.