移除企业机构成员

更新时间:2024-09-24 13:48:03

必须确保企业用户已授予平台appId获取其组织成员的管理权限,点击查看如何授权

  • manage_org_member- 授权允许获取企业/组织用户的组织成员的查询、新增、编辑、删除权限

接口描述

用于将企业成员从企业机构中移除,支持批量移除多个成员账号(一次至多移除10个)。

  • 当企业成员角色为企业管理员时无法通过此接口移除

接口地址&请求方法

接口地址:https://{host}/v3/organizations/{orgId}/members

请求方法:DELETE

请求头格式

具体请求头参数,请查看公共请求头格式

请求参数

参数名称

参数类型

必选

参数位置

参数说明

orgId

string

path

机构账号ID

【注】用户在e签宝注册实名后才有账号ID,账号ID获取方式请使用【查询机构认证信息】接口通过组织机构名称/组织机构证件号进行查询

memberPsnIds

string

query

需移除的个人账号ID列表

【注】

响应参数

展开全部参数参数名称

参数类型

必选

参数说明

code

int32

业务码,0表示成功,非0表示异常。

message

string

业务信息

请根据 code 来判断错误情况,不应该依赖message匹配,因为 message 可能会调整。

data(点击“+”展开详情)

object

业务数据

deletedMembers

list

本次移除成功的成员列表

undeletedMembers(点击“+”展开详情)

array

本次移除失败的成员列表

psnId

string

个人账号ID

failedReason

string

移除失败的原因,原因文案如下:

  • 用户不是企业成员
  • 用户不存在

请求示例

DELETE https://openapi.esign.cn/v3/organizations/3c40c*****940279134e7/members?memberPsnIds=50d5eda*****0b1bd29c,00371e8******1ed09

响应示例

{
    "message":"成功",
    "code":0,
    "data":{
        "deletedMembers":[
            "d3fcf19***0ddc60a13",
            "501a277***6b19b7211"
        ],
        "undeletedMembers":[
        ]
    }
}
{
    "message": "成功",
    "code": 0,
    "data": {
        "deletedMembers": [],
        "undeletedMembers": [
            {
                "psnId": "5288e5*******45b80256c",
                "failedReason": "用户不存在"
            }
        ]
    }
}

错误码

点击查看错误码

我要纠错