Get Organization User List¶

不登录 EnOS 应用门户的状态下授权应用获取指定组织（OU）下所有用户列表。

约束条件¶

关联应用需被组织管理员授予访问用户信息的权限。

请求格式¶

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

请求参数（Body）¶

名称	必需/可选	数据类型	描述
orgId	必需	String	资产所属的组织ID。如何获取orgId信息>>
pagination	必需	Pagination 请求结构体	分页参数。见 Pagination请求结构体>> （若不提供，则默认按照每页1000条数据的格式返回第0页的数据）。
userIDs	可选	List	需要查询的用户列表（若不提供，则返回全量用户）。
startUpdatedTime	可选	String	指定用户更新时间的起始时间。时间参数格式 >>
endUpdatedTime	可选	String	指定用户更新时间的结束时间。时间参数格式 >>

响应参数¶

名称	数据类型	描述
data	Data 结构体	以分页列表展示用户信息

Data 结构体¶

名称	数据类型	描述
pagination	Pagination 结构体	分页信息
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	用户加入当前组织的时间
department	String	用户所属的部门
company	String	用户所属的公司
position	String	用户的职位
nickName	String	用户的昵称
updatedTime	String	用户的更新时间

错误码¶

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

示例¶

请求示例¶

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": "your_user_id",
        "email": "your_user_email",
        "phone": "your_user_phone",
        "phoneArea": "+86",
        "name": "your_user_name",
        "domain": "",
        "createdTime": "2019-10-21 01:56:26.0",
        "joinTime": "2020-03-20 09:56:37.0",
        "department": "your_user_department",
        "company": "your_user_company",
        "position": "your_user_position",
        "nickName": "your_user_nickname"
      }
    ],
    "pagination": {
      "totalElements": 1,
      "pageNo": 0,
      "pageSize": 1000
    }
  }
}