1. 开发集成
  2. /
  3. 标准 Web 应用
  4. /
  5. PHP
  6. /

  7. 管理模块

  8. /

  9. 组织机构管理

  10. /
  11. 搜索顶层组织机构列表

搜索顶层组织机构列表

更新时间: 2024-10-10 07:28:40
编辑

通过搜索关键词，搜索顶层组织机构列表，支持分页。

请求参数

名称类型必填默认值描述示例值
keywordsstring是-搜索关键词，如组织机构名称。Authing
pagenumber否1当前页数，从 1 开始。1
limitnumber否10每页数目，最大不能超过 50，默认为 10。10

示例代码

<?php

require 'vendor/autoload.php';

use Authing\ManagementClient;

$management = new ManagementClient(
    "AUTHING_USERPOOL_ID",
    "AUTHING_USERPOOL_SECRET"
);

$data = $management->searchOrganizations(array(
  
    "keywords" => "Authing",

    "page" => 1,

    "limit" => 10,

));

请求响应

类型： OrganizationPaginatedRespDto

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

示例结果：

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "list": {
      "organizationCode": "steamory",
      "organizationName": "蒸汽记忆",
      "description": "组织描述信息",
      "departmentId": "60b49eb83fd80adb96f26e68",
      "openDepartmentId": "60b49eb83fd80adb96f26e68",
      "hasChildren": true,
      "leaderUserIds": "[\"60b49eb83fd80adb96f26e68\"]",
      "membersCount": 150,
      "i18n": {
        "organizationName": {
          "zh-CN": {
            "enabled": false,
            "value": "中文"
          },
          "en-US": {
            "enabled": false,
            "value": "English"
          }
        }
      }
    }
  }
}

数据结构

OrganizationPagingDto

名称类型必填描述
totalCountnumber是记录总数。
listarray是响应数据。嵌套类型：OrganizationDto。

OrganizationDto

名称类型必填描述
organizationCodestring是组织 code。 示例值： steamory
organizationNamestring是组织名称。 示例值： 蒸汽记忆
descriptionstring否组织描述信息。 示例值： 组织描述信息
departmentIdstring是根节点 ID。 示例值： 60b49eb83fd80adb96f26e68
openDepartmentIdstring否根节点自定义 ID。 示例值： 60b49eb83fd80adb96f26e68
hasChildrenboolean是是否包含子节点。 示例值： true
leaderUserIdsarray否部门负责人 ID。 示例值： ["60b49eb83fd80adb96f26e68"]
membersCountnumber是部门人数。 示例值： 150
isVirtualNodeboolean是是否是虚拟部门。
i18n否多语言设置。嵌套类型：OrganizationNameI18nDto。 示例值： [object Object]

OrganizationNameI18nDto

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

LangObject

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

LangUnit

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