1. Development Integration
  2. /
  3. Standard Web Application
  4. /
  5. Node.js
  6. /

  7. Management Module

  8. /

  9. Organization Management

  10. /
  11. Search Departments

搜索部门

Update time: 2025-07-23 07:34:21
Edit

通过组织 code、搜索关键词，搜索部门，可以搜索组织名称等。

请求参数

名称类型必填默认值描述示例值
keywordsstring是-搜索关键词，如组织名称等。GenAuth
organizationCodestring是-组织 code。steamory
withCustomDataboolean否-是否获取自定义数据。true

示例代码

import { ManagementClient } from "@genauth/nodejs";
// 在 Node.js 中引用：
// const { ManagementClient } = require('@genauth/nodejs');

const managementClient = new ManagementClient({
  accessKeyId: "GEN_AUTH_USERPOOL_ID",
  accessKeySecret: "GEN_AUTH_USERPOOL_SECRET",
});

(async () => {
  const result = await managementClient.searchDepartments({
    organizationCode: "steamory",
    keywords: "GenAuth",
    withCustomData: true,
  });
})();

请求响应

类型： DepartmentListRespDto

名称类型描述
statusCodenumber业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。
messagestring描述信息
apiCodenumber细分错误码，可通过此错误码得到具体的错误类型。
dataarray响应数据

示例结果：

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "organizationCode": "steamory",
    "departmentId": "60b49eb83fd80adb96f26e68",
    "createdAt": "2022-07-03T02:20:30.000Z",
    "openDepartmentId": "ou_7dab8a3d3cdccxxxxxx777c7ad535d62",
    "name": "开发部",
    "leaderUserIds": "[\"60b49eb83fd80adb96f26e68\"]",
    "description": "技术研发部门",
    "parentDepartmentId": "6229c4deb3e4d8a20b6021ff",
    "code": "6229c4deb3e4d8a20b6021ff",
    "membersCount": 11,
    "hasChildren": true,
    "i18n": {
      "name": {
        "zh-CN": {
          "enabled": false,
          "value": "中文"
        },
        "en-US": {
          "enabled": false,
          "value": "English"
        }
      }
    },
    "customData": {
      "icon": "https://example.com/logo"
    }
  }
}

数据结构

DepartmentDto

名称类型必填描述
organizationCodestring是组织 Code（organizationCode）。 示例值： steamory
departmentIdstring是部门系统 ID（为 GenAuth 系统自动生成，不可修改）。 示例值： 60b49eb83fd80adb96f26e68
createdAtstring是部门创建时间。 示例值： 2022-07-03T02:20:30.000Z
openDepartmentIdstring否自定义部门 ID，用于存储自定义的 ID。 示例值： ou_7dab8a3d3cdccxxxxxx777c7ad535d62
namestring是部门名称。 示例值： 开发部
leaderUserIdsarray否部门负责人 ID。 示例值： ["60b49eb83fd80adb96f26e68"]
descriptionstring否部门描述。 示例值： 技术研发部门
parentDepartmentIdstring是父部门 id。 示例值： 6229c4deb3e4d8a20b6021ff
codestring否部门识别码。 示例值： 6229c4deb3e4d8a20b6021ff
membersCountnumber是部门人数（仅包含直属成员）。 示例值： 11
hasChildrenboolean是是否包含子部门。 示例值： true
isVirtualNodeboolean否是否是虚拟部门。
i18n否多语言设置。嵌套类型：I18nDto。 示例值： [object Object]
customDataobject否部门的扩展字段数据。 示例值： [object Object]

I18nDto

名称类型必填描述
name是支持多语言的字段。嵌套类型：LangObject。 示例值： [object Object]

LangObject

名称类型必填描述
zh-CN是多语言的中文内容。嵌套类型：LangUnit。 示例值： [object Object]
en-US是多语言的英文内容。嵌套类型：LangUnit。 示例值： [object Object]

LangUnit

名称类型必填描述
enabledboolean是是否已开启。若开启，且控制台选择该语言，则展示该内容。（默认关闭）。
valueboolean是多语言内容。