¶ 获取部门成员列表

更新时间: 2025-02-18 09:00:47

通过组织 code、部门 ID、排序，获取部门成员列表，支持分页，可以选择获取自定义数据、identities 等。

¶ 请求参数

名称	类型	必填	默认值	描述	示例值
orderBy	string	是	Desc	增序还是倒序。枚举值：`Asc`,`Desc`	`Desc`
sortBy	string	是	JoinDepartmentAt	排序依据。枚举值：`Default`,`JoinDepartmentAt`	`JoinDepartmentAt`
departmentId	string	是	-	部门 ID，根部门传 `root`。	`root`
organizationCode	string	是	-	组织 code。	`steamory`
departmentIdType	string	否	department_id	此次调用中使用的部门 ID 的类型。枚举值：`department_id`,`open_department_id`	`department_id`
includeChildrenDepartments	boolean	否	-	是否包含子部门的成员。
page	number	否	1	当前页数，从 1 开始。	`1`
limit	number	否	10	每页数目，最大不能超过 50，默认为 10。	`10`
withCustomData	boolean	否	-	是否获取自定义数据。	`true`
withIdentities	boolean	否	-	是否获取 identities。	`true`
withDepartmentIds	boolean	否	-	是否获取部门 ID 列表。	`true`

¶ 示例代码

import cn.authing.sdk.java.dto.*;
import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.model.ManagementClientOptions;

class ManagementClientTest {
    private static String ACCESS_KEY_ID = "AUTHING_USERPOOL_ID";
    private static String ACCESS_KEY_SECRET = "AUTHING_USERPOOL_SECRET";

    public static void main(String[] args) {
        ManagementClientOptions clientOptions = new ManagementClientOptions(ACCESS_KEY_ID, ACCESS_KEY_SECRET);
        ManagementClient managementClient = new ManagementClient(clientOptions);
    
        
         
        request.setOrderBy("Desc"); 
        request.setSortBy("JoinDepartmentAt"); 
        request.setDepartmentId("root"); 
        request.setOrganizationCode("steamory"); 
        request.setDepartmentIdType("department_id"); 
        request.setIncludeChildrenDepartments(false); 
        request.setPage(1); 
        request.setLimit(10); 
        request.setWithCustomData(true); 
        request.setWithIdentities(true); 
        request.setWithDepartmentIds(true);
        UserPaginatedRespDto response = managementClient.listDepartmentMembers(request);
        System.out.println(response);
    }
}

¶ 请求响应

类型： UserPaginatedRespDto

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

示例结果：

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "list": {
      "userId": "6229ffaxxxxxxxxcade3e3d9",
      "createdAt": "2022-07-03T02:20:30.000Z",
      "updatedAt": "2022-07-03T02:20:30.000Z",
      "status": "Activated",
      "email": "test@example.com",
      "phone": "188xxxx8888",
      "phoneCountryCode": "+86",
      "username": "bob",
      "name": "张三",
      "nickname": "张三",
      "photo": "https://files.authing.co/authing-console/default-user-avatar.png",
      "loginsCount": 3,
      "lastLogin": "2022-07-03T02:20:30.000Z",
      "lastIp": "127.0.0.1",
      "gender": "M",
      "emailVerified": true,
      "phoneVerified": true,
      "passwordLastSetAt": "2022-07-03T02:20:30.000Z",
      "birthdate": "2022-06-03",
      "country": "CN",
      "province": "BJ",
      "city": "BJ",
      "address": "北京朝阳",
      "streetAddress": "北京朝阳区 xxx 街道",
      "postalCode": "438100",
      "externalId": "10010",
      "departmentIds": "[\"624d930c3xxxx5c08dd4986e\",\"624d93102xxxx012f33cd2fe\"]",
      "identities": {
        "identityId": "62299d8b866d2dab79a89dc4",
        "extIdpId": "6076bacxxxxxxxxd80d993b5",
        "provider": "wechat",
        "type": "openid",
        "userIdInIdp": "oj7Nq05R-RRaqak0_YlMLnnIwsvg",
        "originConnIds": "[\"605492ac41xxxxe0362f0707\"]"
      },
      "customData": {
        "school": "北京大学",
        "age": 22
      },
      "statusChangedAt": "2022-07-03T02:20:30.000Z"
    }
  }
}

¶ 数据结构

¶ UserPagingDto

名称	类型	必填	描述
totalCount	number	是	记录总数。
list	array	是	数据列表。嵌套类型：UserDto。

¶ UserDto

名称	类型	必填	描述
userId	string	是	用户 ID。示例值： `6229ffaxxxxxxxxcade3e3d9`
createdAt	string	是	账号创建时间。示例值： `2022-07-03T02:20:30.000Z`
updatedAt	string	是	账号更新时间。示例值： `2022-07-03T02:20:30.000Z`
status	string	是	账户当前状态。枚举值：`Suspended`,`Resigned`,`Activated`,`Archived`
email	string	否	邮箱。示例值： `test@example.com`
phone	string	否	手机号。示例值： `188xxxx8888`
phoneCountryCode	string	否	手机区号。示例值： `+86`
username	string	否	用户名，用户池内唯一。示例值： `bob`
name	string	否	用户真实名称，不具备唯一性。示例值： `张三`
nickname	string	否	昵称。示例值： `张三`
photo	string	否	头像链接。示例值： `https://files.authing.co/authing-console/default-user-avatar.png`
loginsCount	number	否	历史总登录次数。示例值： `3`
lastLogin	string	否	上次登录时间。示例值： `2022-07-03T02:20:30.000Z`
lastIp	string	否	上次登录 IP。示例值： `127.0.0.1`
gender	string	是	性别。枚举值：`M`,`W`,`U`
emailVerified	boolean	是	邮箱是否验证。示例值： `true`
phoneVerified	boolean	是	手机号是否验证。示例值： `true`
passwordLastSetAt	string	否	用户上次密码修改时间。示例值： `2022-07-03T02:20:30.000Z`
birthdate	string	否	出生日期。示例值： `2022-06-03`
country	string	否	所在国家。示例值： `CN`
province	string	否	所在省份。示例值： `BJ`
city	string	否	所在城市。示例值： `BJ`
address	string	否	所处地址。示例值： `北京朝阳`
streetAddress	string	否	所处街道地址。示例值： `北京朝阳区 xxx 街道`
postalCode	string	否	邮政编码号。示例值： `438100`
externalId	string	否	第三方外部 ID。示例值： `10010`
resetPasswordOnNextLogin	boolean	否	下次登录要求重置密码。
departmentIds	array	否	用户所属部门 ID 列表。示例值： `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]`
identities	array	否	外部身份源。嵌套类型：IdentityDto。
customData	object	否	用户的扩展字段数据。示例值： `[object Object]`
statusChangedAt	string	否	用户状态上次修改时间。示例值： `2022-07-03T02:20:30.000Z`

¶ IdentityDto

名称	类型	必填	描述
identityId	string	是	Identity ID。示例值： `62299d8b866d2dab79a89dc4`
extIdpId	string	是	外部身份源的 ID。示例值： `6076bacxxxxxxxxd80d993b5`
provider	string	是	外部身份源类型，如 lark, wechat。示例值： `wechat`
type	string	是	Identity 类型，如 unionid, openid, primary。示例值： `openid`
userIdInIdp	string	是	在外部身份源的 id。示例值： `oj7Nq05R-RRaqak0_YlMLnnIwsvg`
originConnIds	array	是	身份来自的身份源连接 ID 列表。示例值： `["605492ac41xxxxe0362f0707"]`

上一篇: 获取子部门列表下一篇: 获取部门直属成员 ID 列表