Get Organization User List¶

授权应用获取指定 OU 下所有用户列表。

前提条件¶

应用需要获取“本 OU 内所有用户 ID、账号、邮箱、手机号码”的权限。如有需要，可联系 OU 管理员获取权限。

请求格式¶

POST https://{apigw-address}/app-portal-service/v2.2/user/organization/roster

请求参数（Body）¶

名称	必需/可选	数据类型	描述
orgId	必需	String	OU ID。如何获取 orgId 信息 >>
pagination	必需	Pagination 请求结构体	分页参数。Pagination 请求结构体 >>
userIds	可选	List	需要查询的用户列表。若不提供，则返回所有用户。
startUpdatedTime	可选	Number	指定用户更新时间的起始时间，格式为毫秒级别的时间戳，例如：1750302616000。时间参数格式 >>
endUpdatedTime	可选	Number	指定用户更新时间的结束时间，格式为毫秒级别的时间戳，例如：1750302616000。时间参数格式 >>

响应参数¶

名称	数据类型	描述
pagination	Pagination 结构体	分页信息。Pagination 结构体 >>
users	Users 结构体	用户信息列表。Users 结构体 >>

Pagination 结构体¶

名称	数据类型	描述
pageNo	Integer	请求页数。
pageSize	Integer	每页记录数。
totalElements	Long	总记录数。

Users 结构体¶

名称	数据类型	描述
userId	String	用户的 ID。
email	String	用户的注册邮箱。
phone	String	用户的注册手机号码。
phoneArea	String	用户注册电话的区号。
name	String	用户名。
domain	String	用户所在的域。仅当用户账号为域账号时返回。
createdTime	String	用户账号的创建时间。
joinTime	String	用户加入当前 OU 的时间。
department	String	用户所属的部门。
company	String	用户所属的公司。
position	String	用户的职位。
nickName	String	用户的昵称。
updatedTime	String	用户信息的更新时间。

错误码¶

代码	描述
31400	OU ID 或分页参数不能为空。
31403	应用未被授权访问用户信息。
31404	未找到对应 OU。

示例¶

请求示例¶

url: https://{apigw-address}/app-portal-service/v2.2/user/organization/roster

method: POST

requestBody:
{
  "orgId": "your_org_id",
  "pagination": {
    "pageNo": 0,
    "pageSize": 1000,
    "sorters": []
  },
  "userIds": [
    "your_user_id"
  ]
}

返回示例¶

{
  "code": 0,
  "message": "OK",
  "data": {
    "users": [
      {
        "userId": "yourUserId",
        "email": "yourEmail@enos.com",
        "phone": "",
        "phoneArea": "",
        "name": "yourUserName",
        "domain": "",
        "createdTime": "2024-09-25 02:15:03",
        "joinTime": "2024-09-25 07:12:33",
        "department": "",
        "company": "",
        "position": "",
        "nickName": "",
        "updatedTime": "2024-09-25 02:15:03",
        "accountStartTime": "",
        "accountExpireTime": ""
      },
      {
        "userId": "yourUserId",
        "email": "yourEmail@enos.com",
        "phone": "",
        "phoneArea": "",
        "name": "yourUserName",
        "domain": "",
        "createdTime": "2024-09-11 17:43:01",
        "joinTime": "2024-09-25 07:12:33",
        "department": "",
        "company": "",
        "position": "",
        "nickName": "",
        "updatedTime": "2024-09-11 17:43:01",
        "accountStartTime": "",
        "accountExpireTime": ""
      }
    ],
    "pagination": {
      "totalElements": 14,
      "pageNo": 0,
      "pageSize": 2
    }
  }
}