UCSDK接口新增变更记录（v0.6->v0.8）

内部 UCSDK 接口评审

---

变更接口

用户注册(v0.8)

• POST /v0.8/users
• 请求body新增org_name、realm参数

用户登录(v0.8)

• POST /v0.8/tokens
• 请求body新增imei、device_type、device_desc参数
• 请求body原参数login_name解释:“用户名或手机号或邮箱”->“用户名或手机号或工号”
• 错误代码新增UC/THIRD_ACCOUNT_NOT_EXIST

查找用户

• GET /v0.8/users? $key=xxx&$offset=0&$limit=10
• 增加搜索规则，需要修改SDK注释：

1. 按昵称前缀进行搜索，如：“苏玉城”用户，通过“苏玉”可以搜索出来。 
2. 支持全拼简拼搜索，如：“苏玉城”用户，通过“sy”或“su”进行搜索。 
3. 搜索支持，手机、昵称字段。

注册组织

• POST /v0.8/organizations
• 功能说明:“注册组织，同时增加组织管理员”->“通过手机验证码注册组织”
• 访问权限 :“ORG_ADMIN”->“SDP_DEVELOPER”

修改组织

• PATCH /v0.8/organizations/45
• 访问权限 :“ORG_ADMIN”->“ORG_ADMIN、SDP_DEVELOPER”

删除组织

• DELETE/v0.8/organizations/84
• 访问权限 :“ORG_ADMIN”->“ORG_ADMIN、SDP_DEVELOPER”

获取指定组织信息

• GET /v0.8/organizations/85
• 访问权限 :“”->“同组织具有获取权限、SDP_DEVELOPER”

全量或增量获取组织下节点信息(分页)(v0.7)

• GET /organizations/{org_id}/orgnodes?$offset=偏移量&$limit=数量
• 功能说明变更 :

支持如下3个功能
1. 全量获取组织下节点(分页)，如：/organizations/{org_id}/orgnodes?$offset=偏移量&$limi2 获取组织下业务节点(分页)，如：/organizations/{org_id}/orgnodes?$offset=偏移量&$limit=数量&type=1，即，需带参数$offset、$limit和type
3 增量获取组织下节点(分页)，如：/organizations/{org_id}/orgnodes?update_time=1423048443668&$limit=数量，即，需带参数update_time和$limit

• 访问权限 :“”->“同组织具有获取权限”
• 响应报文 :根据传入参数不同划分为三种不同响应报文

全量或增量获取组织下用户(分页)(v0.7)

• GET /organizations/{org_id}/users?$offset=偏移量&$limit=数量
• 功能说明变更 :

支持如下4个功能
1 全量获取组织下用户(分页，不带领域realm)，如：/organizations/{org_id}/users?$offset=偏移量&$limit=数量，即，需带参数$offset和$limit
2 全量获取组织下用户(分页,带领域realm)，如：/organizations/{org_id}/users?$offset=偏移量&$limit=数量&realm=nd.com，即，需带参数$offset、$limit和realm
3 增量获取组织下用户(分页,获取用户基本信息、组织扩展信息变更的用户)，如：/organizations/{org_id}/users?update_time=1423048443668&$limit=数量，即，需带参数update_time和$limit
4 增量获取组织下用户(分页，仅领域扩展信息变更的用户)，如：/organizations/{org_id}/users?update_time=1423048443668&realm=nd.com&$limit=数量，即，需带参数update_time、realm和$limit

• 访问权限 :“”->“同组织具有获取权限”
• 响应报文 :根据传入参数不同划分为四种不同响应报文

新增节点(v0.6)

• POST /v0.8/organizations/3413/orgnodes？type=xxx
• 功能说明变更 :

新增节点，其中，type参数(可选)
type=0或不带type参数：新增普通组织节点；
type=1:新增业务组织节点。

• 访问权限 :“ORG_ADMIN、SDP_DEVELOPER”->“ORG_ADMIN”

修改节点信息

• PATCH /v0.8/organizations/4861/orgnodes/1234567
• 访问权限 :“ORG_ADMIN、SDP_DEVELOPER”->“ORG_ADMIN”

删除节点

• DELETE /v0.8/organizations/4861/orgnodes/1234567
• 访问权限 :“ORG_ADMIN、SDP_DEVELOPER”->“ORG_ADMIN”

获取节点信息

• GET /v0.8/organizations/348/orgnodes/1234567
• 访问权限 :“”->“同组织具有获取权限”

分页获取下一级节点列表

• GET /organizations/{org_id}/orgnodes/{node_id}/childnodes?$offset=偏移量&$limit=数量
• 访问权限 :“”->“同组织具有获取权限”
• URL参数说明：

node_id：节点ID,当node_id=0时,查找组织下一级节点

分页获取节点下一级用户列表 (v0.6)

• GET /organizations/{org_id}/orgnodes/{node_id}/users?$offset=偏移量&$limit=数量
• 访问权限 :“”->“同组织具有获取权限”
• 响应model：新增role_name属性
• URL参数说明：

org_id:组织ID
orgnodes:实体类型的节点ID

批量新增用户到指定节点(v0.6)

• GET /organizations/{org_id}/orgnodes/{node_id}/users?$offset=偏移量&$limit=数量
• 访问权限 :“ORG_ADMIN”->“ORG_ADMIN、BIZ_SERVER”
• 响应model：新增role_name属性
• URL参数说明：

org_id:用户新增到的组织ID
node_id:用户新增到的实体类型的节点ID

根据名称查找指定节点(v0.6)

• GET /organizations/{org_id}/orgnodes/{node_id}/users?$offset=偏移量&$limit=数量
• 功能说明：根据名称查找指定节点(包括实体节点和业务节点)下符合条件的节点列表,结果分页显示
• 访问权限 :“”->“同组织具有获取权限”
• URL参数说明：

type:节点类型;0:实体节点;1:项目节点;补填type参数默认表示实体节点

查找节点下用户

• GET /organizations/{org_id}/orgnodes/{node_id}/users/actions/search?name=xxx&$offset=偏移量&$limit=数量
• 访问权限 :“”->“同组织具有获取权限”
• URL参数说明：

org_id:组织ID
node_id:节点ID;nodeid=0时表示实体分类下的用户,因为业务分类下不会直接挂用户

统计组织下的所有节点数(v0.6)

• GET /organizations/{org_id}/nodes/actions/count?type=1
• 访问权限 :“”->“同组织具有获取权限”
• URL参数说明：

type(可选)：type=0或不带type参数：获取普通组织节点数；type=1:获取业务组织节点数。

统计组织下的所有用户数

• GET /organizations/{org_id}/users/actions/count
• 访问权限 :“”->“同组织具有获取权限”

统计某个节点下的所有节点数(v0.6)

• GET /organizations/{org_id}/orgnodes/{node_id}/nodes/actions/count?type=节点类型
• 访问权限 :“”->“同组织具有获取权限”
• URL参数说明：

type(可选)：节点类型，0:实体节点;1:项目节点;不填type参数默认表示实体节点 。

统计某个节点下的所有用户数

• GET /organizations/{org_id}/orgnodes/{node_id}/users/actions/count
• 访问权限 :“”->“同组织具有获取权限”
• URL参数说明：

org_id:组织ID
node_id:节点ID(实体或者业务);node_id=0时,查找实体节点下的用户,因为业务分类下不会直接挂用户

员工离职(v0.6)

• DELETE /organizations/{org_id}/orgnodes/{node_id}/users/{user_id}
• 访问权限 :“ORG_ADMIN”->“ORG_ADMIN、BIZ_SERVER”
• URL参数说明：

org_id:要离职的用户所在的组织ID
node_id:要离职的用户所在的实体节点ID
user_id:要离职的用户ID

• 响应model :新增org_id、node_id、user_id

新增接口

第三方登陆(v0.8)

• POST /v0.8/third_tokens

批量获取用户信息(v0.8)

• POST /v0.8/users/actions/query?realm=xxx

第三方短信验证码(v0.8)

• POST /v0.8/smses

用户扩展信息支持查询排序注册(v0.8)

• POST /v0.8/users/extend/actions/register

用户扩展信息查询接口(v0.8)

• POST /v0.8/users/extend/actions/search

批量获取用户id(v0.8)

• POST /v0.8/users/actions/third_query

获取用户所属业务组织节点(v0.6)

• GET /v0.8/organizations/123/orgnodes?user_id=xxx&type=1

新增用户到业务组织节点(v0.6)

• POST /v0.8/organizations/123/orgnodes/456/users/actions/reference?type=1

批量删除业务组织节点下的用户(v0.6)

• POST /v0.8/organizations/123/orgnodes/456/users/actions/delete

修改业务组织节点中用户信息(v0.6)

• PATCH /v0.8/organizations/123/orgnodes/345/users/678/actions/update?type=1

获取业务组织节点中用户信息(v0.6)

• GET /v0.8/organizations/123/orgnodes/456/users/789

组织用户密码重置(v0.8)

• PUT /v0.8/organizations/1/orgnodes/2/users/3/password

基于角色分页查询用户(v0.7)

• GET /v0.8/users/roles/129?$offset=0&$limit=10