必须确保企业用户已授予平台appId获取其组织成员的管理权限,点击查看如何授权
- manage_org_member- 授权允许获取企业/组织用户的组织成员的查询、新增、编辑、删除权限
接口描述
用于实名企业中添加企业成员,支持批量添加多个成员账号(一次至多添加10个)。
注意事项:
- 请确保添加的
psnId
(个人账号)已完成个人实名认证或通过e签宝SaaS官网完成个人实名认证。 - 个人账号成功添加到企业机构成员中后默认设置为“普通成员”角色。
接口地址&请求方法
接口地址:https://{host}/v3/organizations/{orgId}/members
请求方法:POST
请求头格式
具体请求头参数,请查看公共请求头格式。
请求参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 | |
orgId | string | 是 | path | 机构账号ID 【注】用户在e签宝注册实名后才有账号ID,账号ID获取方式请使用【查询机构认证信息】接口通过组织机构名称/组织机构证件号进行查询 | |
members(点击“+”展开详情) | array | 是 | body | 待添加企业成员信息 | |
psnId | string | 是 | body | 已实名的个人账号ID 【注】用户在e签宝注册实名后才有账号ID,账号ID获取方式请使用【查询个人认证信息】接口通过个人账号标识(手机号或邮箱)/个人用户的证件号进行查询 | |
memberName | string | 是 | body | 员工姓名/昵称(用户自定义昵称,用于区分企业成员) | |
employeeNum | string | 否 | body | 员工编号(用户自定义,可以为企业工号) | |
role | string | 否 | body | 要添加的成员角色,多个角色英文逗号隔开(不传默认为普通成员角色) 2 - 印章保管员(可以对企业印章进行创建、删除、修改、查询等操作) 3 - 成员管理员(可以对企业成员进行添加、移除、修改、查询等操作) 4 - 模板管理员(可以对模板进行复制、新增、删除、开启、关闭、查询等操作) |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | ||||
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | ||||
message | string | 否 | 业务信息 请根据 code 来判断错误情况,不应该依赖 message匹配,因为 message 可能会调整。 | ||||
data(点击“+”展开详情) | object | 否 | 业务数据 | ||||
addedMembers | list | 否 | 本次添加成功的成员列表 | ||||
unaddedMembers(点击“+”展开详情) | array | 否 | 本次添加失败的成员列表 | ||||
psnId | string | 否 | 个人账号ID | ||||
failedReason | string | 否 | 失败原因,原因文案如下:
| ||||
existingMemberPsnId | string | 否 | 已存在的成员的个人账号ID |
请求示例
{
"members":[
{
"psnId":"d3fcf19***0ddc60a13",
"memberName":"成员1的姓名",
"employeeNum":"100"
},
{
"psnId":"501a277***6b19b7211",
"memberName":"成员2的姓名",
"employeeNum":"101"
}
]
}
响应示例
{
"message":"成功",
"code":0,
"data":{
"addedMembers":[
"d3fcf19***0ddc60a13",
"501a277***6b19b7211"
],
"unaddedMembers":[
]
}
}
{
"message": "成功",
"code": 0,
"data": {
"addedMembers": [],
"unaddedMembers": [
{
"psnId": "ddc491d*****3a3bfe11",
"failedReason": "用户已经是当前企业成员",
"existingMemberPsnId": "ddc491d******3a3bfe11"
}
]
}
}