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

  7. 管理模块

  8. /

  9. 组织机构管理

  10. /
  11. 搜索部门下的成员

搜索部门下的成员

更新时间: 2024-07-24 09:31:53
编辑

通过组织 code、部门 ID、搜索关键词，搜索部门下的成员，支持分页，可以选择获取自定义数据、identities 等。

请求参数

名称类型必填默认值描述示例值
keywordsstring是-搜索关键词，如成员名称。张三
departmentIdstring是-部门 ID，根部门传 root。root
organizationCodestring是-组织 code。steamory
pagenumber否1当前页数，从 1 开始。1
limitnumber否10每页数目，最大不能超过 50，默认为 10。10
departmentIdTypestring否department_id此次调用中使用的部门 ID 的类型。 枚举值：department_id,open_department_iddepartment_id
includeChildrenDepartmentsboolean否-是否包含子部门的成员。
withCustomDataboolean否-是否获取自定义数据。true
withIdentitiesboolean否-是否获取 identities。true
withDepartmentIdsboolean否-是否获取部门 ID 列表。true

示例代码


using Authing.CSharp.SDK.Models;
using Authing.CSharp.SDK.Services;
using Authing.CSharp.SDK.Utils;
using Authing.CSharp.SDK.UtilsImpl;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;

namespace Example
{
    class Program
    {
      private static ManagementClientOptions options;
      private static string ACCESS_Key_ID = "AUTHING_USERPOOL_ID";
      private static string ACCESS_KEY_SECRET = "AUTHING_USERPOOL_SECRET";

      static void Main(string[] args)
      {
          MainAsync().GetAwaiter().GetResult();
      }

      private static async Task MainAsync()
      {
          options = new ManagementClientOptions()
          {
              AccessKeyId = ACCESS_Key_ID,
              AccessKeySecret = ACCESS_KEY_SECRET,
          };

          ManagementClient managementClient = new ManagementClient(options);
        
          UserPaginatedRespDto  result = await managementClient.SearchDepartmentMembers
          (             
                keywords: "张三", 
                departmentId: "root", 
                organizationCode: "steamory", 
                page: 1, 
                limit: 10, 
                departmentIdType: "department_id", 
                includeChildrenDepartments: false, 
                withCustomData: true, 
                withIdentities: true, 
                withDepartmentIds: true
          );
        }
    }
}

请求响应

类型： UserPaginatedRespDto

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

示例结果：

{
  "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

名称类型必填描述
totalCountnumber是记录总数。
listarray是数据列表。嵌套类型：UserDto。

UserDto

名称类型必填描述
userIdstring是用户 ID。 示例值： 6229ffaxxxxxxxxcade3e3d9
createdAtstring是账号创建时间。 示例值： 2022-07-03T02:20:30.000Z
updatedAtstring是账号更新时间。 示例值： 2022-07-03T02:20:30.000Z
statusstring是账户当前状态。 枚举值：Suspended,Resigned,Activated,Archived
emailstring否邮箱。 示例值： test@example.com
phonestring否手机号。 示例值： 188xxxx8888
phoneCountryCodestring否手机区号。 示例值： +86
usernamestring否用户名，用户池内唯一。 示例值： bob
namestring否用户真实名称，不具备唯一性。 示例值： 张三
nicknamestring否昵称。 示例值： 张三
photostring否头像链接。 示例值： https://files.authing.co/authing-console/default-user-avatar.png
loginsCountnumber否历史总登录次数。 示例值： 3
lastLoginstring否上次登录时间。 示例值： 2022-07-03T02:20:30.000Z
lastIpstring否上次登录 IP。 示例值： 127.0.0.1
genderstring是性别。 枚举值：M,W,U
emailVerifiedboolean是邮箱是否验证。 示例值： true
phoneVerifiedboolean是手机号是否验证。 示例值： true
passwordLastSetAtstring否用户上次密码修改时间。 示例值： 2022-07-03T02:20:30.000Z
birthdatestring否出生日期。 示例值： 2022-06-03
countrystring否所在国家。 示例值： CN
provincestring否所在省份。 示例值： BJ
citystring否所在城市。 示例值： BJ
addressstring否所处地址。 示例值： 北京朝阳
streetAddressstring否所处街道地址。 示例值： 北京朝阳区 xxx 街道
postalCodestring否邮政编码号。 示例值： 438100
externalIdstring否第三方外部 ID。 示例值： 10010
resetPasswordOnNextLoginboolean否下次登录要求重置密码。
departmentIdsarray否用户所属部门 ID 列表。 示例值： ["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]
identitiesarray否外部身份源。嵌套类型：IdentityDto。
customDataobject否用户的扩展字段数据。 示例值： [object Object]
statusChangedAtstring否用户状态上次修改时间。 示例值： 2022-07-03T02:20:30.000Z

IdentityDto

名称类型必填描述
identityIdstring是Identity ID。 示例值： 62299d8b866d2dab79a89dc4
extIdpIdstring是外部身份源的 ID。 示例值： 6076bacxxxxxxxxd80d993b5
providerstring是外部身份源类型，如 lark, wechat。 示例值： wechat
typestring是Identity 类型，如 unionid, openid, primary。 示例值： openid
userIdInIdpstring是在外部身份源的 id。 示例值： oj7Nq05R-RRaqak0_YlMLnnIwsvg
originConnIdsarray是身份来自的身份源连接 ID 列表。 示例值： ["605492ac41xxxxe0362f0707"]