基礎(chǔ)說(shuō)明

本文檔用于開(kāi)發(fā)者對(duì)接 IDaaS 應(yīng)用同步的能力，并詳細(xì)列明了具體事件參數(shù)。

若您希望了解對(duì)接原理和調(diào)用流程，請(qǐng)參考 賬戶同步接入概述。

我們可以將所有 IDaaS 中通訊錄事件分為三大類。

一、測(cè)試事件

管理員在完成應(yīng)用同步配置后，可通過(guò)【測(cè)試連接】按鈕，檢查配置是否成功。

使用該功能，應(yīng)用能夠接收特殊的測(cè)試事件。

二、增量事件

增量事件指由 IDaaS 中發(fā)生的變化自動(dòng)觸發(fā)的操作。

通常用于 IDaaS 和應(yīng)用之間數(shù)的持續(xù)、增量的同步。

三、全量事件

全量事件指管理員從 IDaaS 頁(yè)面明確手動(dòng)觸發(fā)的同步操作。

通常用于將 IDaaS 中數(shù)據(jù)一次性導(dǎo)入至應(yīng)用中。

事件清單

數(shù)據(jù)安全性

所有的賬戶/組織事件，IDaaS 均會(huì)將完整的賬戶/組織信息作為參數(shù)，傳遞給事件監(jiān)聽(tīng)方。

若數(shù)據(jù)中有敏感信息，推薦通過(guò) HTTPs 加密通道或勾選【業(yè)務(wù)數(shù)據(jù)加密】，對(duì)傳輸過(guò)程進(jìn)行保護(hù)。

測(cè)試連接

測(cè)試配置信息的連通性，驗(yàn)證驗(yàn)簽和加密能力。

一鍵測(cè)試時(shí)是單獨(dú)的事件訂閱類型：urn:alibaba:idaas:app:event:common:test

請(qǐng)求參數(shù)驗(yàn)簽后 payload 示例：

{
  "iss": "urn:alibaba:idaas:app:event",
  "sub": "idaas_rhhoqmlnyu3cv7ow657gyvurky",
  "aud": "app_mjavzivahje6zxkbc4i2bierdu",
  "exp": 1648711369,
  "iat": 1648709570,
  "jti": "bNRrCYrqXjqe8B1xweqlZw",
  "dataEncrypted": false,
  "cipherData": "",
  "plainData": {
    "instanceId": "idaas_rhhoqmlnyu3cv7ow657gyvurky",
    "aliUid": 151971404963****,
    "eventVersion": "V1.0",
    "eventData": [
         {
          "eventId":"evnt_aaaac766x2somw2ptotoyk6ag6bmfkt5xpqprpq",
          "eventType":"urn:alibaba:idaas:app:event:common:test",
          "eventTime":"1648709509849",
          "bizId":"evnt_aaaac766x2somw2ptotoyk6ag6bmfkt5xpqprpq",
          "bizData":"{\"bizData\":\"req_xxxxxxxxxxsdfsdfsfd\"}"
         }
     ]
  }
}

應(yīng)用成功接收后，應(yīng)用側(cè)必須在返回請(qǐng)求，并確保字段 successEvents 中 eventId 與請(qǐng)求中保持一致。

否則測(cè)試請(qǐng)求將失敗。

{
  "successEvents": [
    {
      "eventId": "evnt_aaaac766x2somw2ptotoyk6ag6bmfkt5xpqprpq",
      "eventCode": "SUCCESS",
      "eventMessage": "SUCCESS"
    }
  ],
  "skippedEvents": [
    {
      "eventId": "",
      "eventCode": "",
      "eventMessage": ""
    }
  ],
  "failedEvents": [
    {
      "eventId": "",
      "eventCode": "",
      "eventMessage": ""
    }
  ],
  "retriedEvents": [
    {
      "eventId": "",
      "eventCode": "",
      "eventMessage": ""
    }
  ]
}

賬戶創(chuàng)建

通過(guò)該事件訂閱員工入職。

事件類型：urn:alibaba:idaas:app:event:ud:user:create

解析后的 bizData 示例：

{
    "password": "ssGp96", 
    "userId": "user_4alcbywzc7jyl23lu2srljsw7i", 
    "username": "zhangsan", 
    "displayName": "張三", 
    "passwordSet": true, 
    "phoneRegion": "", 
   "phoneNumber": "155****5620",
    "phoneVerified": false, 
    "email":"zh***@163.com",
    "emailVerified": false, 
    "userExternalId": "user_4alcbywzc7jyl23lu2srljsw7i", 
    "userSourceType": "build_in", 
    "userSourceId": "idaas_rhhoqmlnyu3cv7ow657gyvurky", 
    "status": "enabled", 
    "accountExpireTime": "-1", 
    "registerTime": "1648531553621", 
    "lockExpireTime": "-1", 
    "createTime": "1648531553621", 
    "updateTime": "1648531553621", 
    "description": "", 
    "customFields": [
        {
            "fieldName": "test_custom_field", 
            "fieldValue": "test_value"
        }
    ],
    "primaryOrganizationalUnitId": "ou_bvluxnp2ef36uupdwob6km34a4",
    "organizationalUnits": [
        {
            "organizationalUnitId": "ou_bvluxnp2ef36uupdwob6km34a4", 
            "organizationalUnitName": "研發(fā)部", 
            "primary": true
        }
    ]
}

參數(shù)說(shuō)明：

賬戶刪除

當(dāng)員工離職時(shí)，通訊錄發(fā)生變更，可訂閱該事件。

事件類型：urn:alibaba:idaas:app:event:ud:user:delete

解析后的 bizData 示例：同賬戶創(chuàng)建。

賬戶基礎(chǔ)信息更新

若員工基本信息發(fā)生變更。如手機(jī)號(hào)，郵箱，姓名等發(fā)生變更，應(yīng)用需要及時(shí)收到變更的信息，可通過(guò)訂閱該事件。

事件類型：urn:alibaba:idaas:app:event:ud:user:update_info

解析后的 bizData 示例：同賬戶創(chuàng)建。

賬戶密碼更新

當(dāng)賬戶密碼發(fā)生變更時(shí)，如：管理員重置密碼，用戶修改密碼。應(yīng)用可通過(guò)訂閱此事件，收到賬戶最新密碼。

事件類型：urn:alibaba:idaas:app:event:ud:user:update_password

解析后的 bizData 示例：同賬戶創(chuàng)建。

賬戶啟用

賬戶狀態(tài)發(fā)生變更，從禁用狀態(tài)修改為啟用狀態(tài)，可訂閱該事件。

事件類型：urn:alibaba:idaas:app:event:ud:user:enable

解析后的bizData示例：同賬戶創(chuàng)建。

賬戶禁用

賬戶狀態(tài)發(fā)生變更，從啟用狀態(tài)修改為禁用狀態(tài)，可訂閱該事件。

事件類型：urn:alibaba:idaas:app:event:ud:user:disable

解析后的bizData示例：同賬戶創(chuàng)建。

賬戶鎖定

賬戶狀態(tài)發(fā)生變更，如輸錯(cuò)多次密碼，導(dǎo)致賬號(hào)鎖定，暫不可用，可訂閱該事件。

事件類型：urn:alibaba:idaas:app:event:ud:user:lock

解析后的bizData示例：同賬戶創(chuàng)建。

賬戶解鎖

賬戶狀態(tài)發(fā)生變更，由鎖定狀態(tài)變?yōu)檎顟B(tài)，可訂閱該事件。

事件類型：urn:alibaba:idaas:app:event:ud:user:unlock

解析后的bizData示例：同賬戶創(chuàng)建。

賬戶移動(dòng)

賬戶所屬主組織機(jī)構(gòu)變更，可訂閱該事件。

事件類型：urn:alibaba:idaas:app:event:ud:user:update_primary_ou

解析后的bizData示例：同賬戶創(chuàng)建

組織創(chuàng)建

可通過(guò)該事件訂閱創(chuàng)建組織機(jī)構(gòu)。

事件類型：urn:alibaba:idaas:app:event:ud:organizational_unit:create

解析后的bizData示例：

{
    "organizationalUnitId": "ou_dqdvxesykpfhig2kvgrzpeoeyu", 
    "organizationalUnitName": "組織部", 
    "parentId": "ou_dqdvxesykpdfasdfaseoeyu", 
    "organizationalUnitExternalId": "ou_dqdvxesykpfhig2kvgrzpeoeyu", 
    "organizationalUnitSourceType": "build_in", 
    "organizationalUnitSourceId": "idaas_rhhoqmlnyu3cv7ow657gyvurky", 
    "createTime": "1648451475209", 
    "updateTime": "1648451475209",
    "description":"自建"
}

參數(shù)說(shuō)明：

組織刪除

可通過(guò)該事件訂閱刪除組織機(jī)構(gòu)。

事件類型：urn:alibaba:idaas:app:event:ud:organizational_unit:delete

解析后的bizData示例：同組織創(chuàng)建。

組織更新

可通過(guò)該事件訂閱修改組織機(jī)構(gòu)基礎(chǔ)信息，如組織機(jī)構(gòu)名稱。

事件類型：urn:alibaba:idaas:app:event:ud:organizational_unit:update

解析后的bizData示例：同組織創(chuàng)建。

組織移動(dòng)

可通過(guò)該事件訂閱組織機(jī)構(gòu)更新父組織機(jī)構(gòu)。

事件類型：urn:alibaba:idaas:app:event:ud:organizational_unit:update_parent_organizational_unit

解析后的bizData示例：同組織創(chuàng)建。

組創(chuàng)建

可通過(guò)該事件訂閱組創(chuàng)建。

事件類型：urn:alibaba:idaas:app:event:ud:group:create

解析后的 bizData 示例

{
    "groupId": "group_yvx3ugdi3yzaehnsd3uqzb4xha",
    "groupName": "test_2024",
    "groupExternalId": "test_2024"
}

參數(shù)說(shuō)明：

組基礎(chǔ)信息更新

可通過(guò)該事件訂閱組基礎(chǔ)信息更新。

事件類型：urn:alibaba:idaas:app:event:ud:group:update

解析后的 bizData 示例：同組創(chuàng)建。

組刪除

可通過(guò)該事件訂閱組刪除。

事件類型：urn:alibaba:idaas:app:event:ud:group:delete

解析后的 bizData 示例：同組創(chuàng)建。

組添加成員

可通過(guò)該事件訂閱組添加成員。

事件類型：urn:alibaba:idaas:app:event:ud:group:add_user

解析后的 bizData 示例

{
    "addedMembers": [
        {
            "memberId": "user_zakg7oeeaftqqff2bzcv7wpqs4",
            "memberName": "小明"
        }
    ],
    "groupId": "group_yvx3ugdi3yzaehnsd3uqzb4xha",
    "groupName": "test_2024_test",
    "groupExternalId": "test_2024"
}

參數(shù)說(shuō)明：

組移除成員

可通過(guò)該事件訂閱組移除成員。

事件類型：urn:alibaba:idaas:app:event:ud:group:remove_user

解析后的 bizData 示例

{
    "removedMembers": [
        {
            "memberId": "user_zakg7oeeaftqqff2bzcv7wpqs4",
            "memberName": "小明"
        }
    ],
    "groupId": "group_yvx3ugdi3yzaehnsd3uqzb4xha",
    "groupName": "test_2024_test",
    "groupExternalId": "test_2024"
}

參數(shù)說(shuō)明：

全量推送組織機(jī)構(gòu)

事件類型：urn:alibaba:idaas:app:event:ud:organizational_unit:push

解析后的 bizData 示例：同組織創(chuàng)建。

全量推送賬戶

事件類型：urn:alibaba:idaas:app:event:ud:user:push

解析后的 bizData 示例：同賬戶創(chuàng)建。

全量推送組

可通過(guò)該事件訂閱全量推送組。

事件類型：urn:alibaba:idaas:app:event:ud:group:push

解析后的 bizData 示例

{
    "allMembers": [
        {
            "memberId": "user_zakg7oeeaftqqff2bzcv7wpqs4",
            "memberName": "小明"
        },
        {
            "memberId": "user_zakg7oeea1234ff2bzcexample",
            "memberName": "張三"
        }
    ],
    "groupId": "group_yvx3ugdi3yzaehnsd3uqzb4xha",
    "groupName": "test_2024",
    "groupExternalId": "test_2024"
}

參數(shù)說(shuō)明：