部门和成员操作

更新: 2022-11-22

成员和部门同步API

(注意: 以下接口需要先开通企业帐号同步功能才能使用)

• 添加或修改同步成员
• 删除同步成员
• 添加或修改同步部门
• 删除同步部门
• 添加同步部门的成员
• 删除同步部门的成员
• 删除同步成员的所属部门
• 通过外部帐号获取成员信息
• 通过外部部门ID获取部门信息
• 添加管理员

企业成员和部门API

• 添加成员
• 修改成员
• 删除成员
• 添加部门
• 修改部门
• 删除部门
• 添加部门成员
• 删除部门成员
• 删除成员的所属部门
• 成员列表
• 成员信息
• 部门列表
• 部门中成员列表
• 角色列表

其他API

• 管理日志

API域名

Host: yk3.gokuai.com

添加或修改同步成员

POST /m-open/1/ent/add_sync_member HTTP/1.1

请求参数

注意: 添加成员时, 参数 group_out_ids 不指定, 成员将不会出现在企业管理后台的成员管理中, 还需要调用 添加同步部门的成员

返回结果

HTTP 200

{
  "member_id": 用户ID(number),
  "state": 用户状态, 1表示启用, 0表示禁用(number)
}

注意: 启用的帐号数如果超出企业帐号限制将会被强制禁用

删除同步成员

POST /m-open/1/ent/del_sync_member HTTP/1.1

请求参数

返回结果

HTTP 200

添加或修改同步部门

POST /m-open/1/ent/add_sync_group HTTP/1.1

请求参数

返回结果

HTTP 200

删除同步部门

POST /m-open/1/ent/del_sync_group HTTP/1.1

请求参数

返回结果

HTTP 200

添加同步部门的成员

POST /m-open/1/ent/add_sync_group_member HTTP/1.1

请求参数

返回结果

HTTP 200

删除同步部门的成员

POST /m-open/1/ent/del_sync_group_member HTTP/1.1

请求参数

返回结果

HTTP 200

删除同步成员的所属部门

POST /m-open/1/ent/del_sync_member_group HTTP/1.1

请求参数

返回结果

HTTP 200

通过外部帐号获取成员信息

POST /m-open/1/ent/get_member_by_out_id HTTP/1.1

请求参数

out_ids 和 user_ids 只需传其中一个

返回格式

json

返回结果

{
    "{out_id}":
    {
        "member_id": ,
        "account": ,
        "member_name": ,
        "member_email": ,
        "member_phone": ,
        "member_title": ,
        "state": ,
        "expire":
    },
    ...
}

通过外部部门ID获取部门信息

POST /m-open/1/ent/get_group_by_out_id HTTP/1.1

请求参数

返回格式

json

返回结果

{
    "{out_id}":
    {
        "group_id": 部门ID(number),
        "name": 部门名称(string),
        "out_id": 部门外部ID(string),
        "parent_id": 上级部门ID(number)
    },
    ...
}

添加管理员

POST /m-open/1/ent/add_sync_admin HTTP/1.1

请求参数

返回结果

HTTP 200

添加成员

POST /m-open/1/ent/add_member HTTP/1.1

请求参数

其中部门路径是指部门层级关系, 如: 北京分公司/销售部

返回结果

HTTP 200

{
  "member_id": 用户ID(number),
  "state": 用户状态, 1表示启用, 0表示禁用(number)
}

注意: 启用的帐号数如果超出企业帐号限制将会被强制禁用

修改成员

POST /m-open/1/ent/set_member HTTP/1.1

请求参数

返回结果

HTTP 200

{
  "member_id": 用户ID(number),
  "state": 用户状态, 1表示启用, 0表示禁用(number)
}

删除成员

POST /m-open/1/ent/del_member HTTP/1.1

请求参数

返回结果

HTTP 200

添加部门

POST /m-open/1/ent/add_group HTTP/1.1

请求参数

返回结果

HTTP 200

{
    "group_id": 部门ID(number)
}

修改部门

POST /m-open/1/ent/set_group HTTP/1.1

请求参数

返回结果

HTTP 200

删除部门

POST /m-open/1/ent/del_group HTTP/1.1

请求参数

返回结果

HTTP 200

添加部门成员

POST /m-open/1/ent/add_group_member HTTP/1.1

请求参数

返回结果

HTTP 200

删除部门成员

POST /m-open/1/ent/del_group_member HTTP/1.1

请求参数

返回结果

HTTP 200

删除成员的所属部门

POST /m-open/1/ent/del_member_group HTTP/1.1

请求参数

返回结果

HTTP 200

成员列表

POST /m-open/1/ent/get_members HTTP/1.1

请求参数

返回格式

json

返回结果

{
    list:
    [
        {
            "member_id": 成员ID(number),
            "out_id": 成员外部系统唯一ID(string),
            "account": 成员外部系统登录帐号(string),
            "member_name": 成员显示名(string),
            "member_email": 成员邮箱(string),
            "member_phone": 联系电话(string),
            "member_title": 职位(string),
            "state": 成员状态, 1: 启用, 0: 禁用(number),
            "expire": 临时帐号到期时间戳, 单位秒, 无到期日期则不返回(number)
        },
        ...
    ],
    count: 成员总数(number)
}

成员信息

POST /m-open/1/ent/get_member HTTP/1.1

请求参数

注: 参数中的member_id, out_id, email和account必须传其中之一

返回格式

json

返回结果

{
    "member_id": 成员ID(number),
    "out_id": 成员外部系统唯一ID(string),
    "account": 成员外部系统登录帐号(string),
    "member_name": 成员显示名(string),
    "member_email": 成员邮箱(string),
    "member_phone": 联系电话(string),
    "member_title": 职位(string),
    "state": 成员状态, 1: 启用, 0: 禁用(number),
    "expire": 临时帐号到期时间戳, 单位秒, 无到期日期则不返回(number)
    "groups" :
    [
        {
            "id": 部门ID(number),
            "name": 部门名称(string),
            "group_code": 内部code(string),
            "out_id": 部门外部系统唯一ID(number)
        },
        ...
    ],
    "orgs":
    [
        {
            "id": 库ID(number),
            "name": 库名称(string),
            "type": 类型, 20表示个人库(number),
            "owner": 库拥有者(string),
            "owner_id": 库拥有者ID(number),
            "member_count": 库成员数(number),
            "size_total": 库空间配额, 单位字节, -1表示不限(number),
            "size_used": 库已使用空间, 单位字节(number),
            "mount_id": 库空间ID(number),
            "roles": {
                "角色ID": 角色名称(string),
                ...
                //可能有多个角色, 如果本人是库拥有者不会返回角色信息
            }
        },
        ...
    ]
}

部门列表

POST /m-open/1/ent/get_groups HTTP/1.1

请求参数

返回格式

json

返回结果

[
    {
        "id": 部门ID(number),
        "name": 部门名称(string),
        "out_id": 部门外部系统唯一ID(string),
        "parent_id": 上级部门ID, 0为顶层(number)
    }
]

部门中成员列表

POST /m-open/1/ent/get_group_members HTTP/1.1

请求参数

参数中group_id, out_id, group_path传其中一个即可

返回格式

json

返回结果

{
    list:
    [
        {
            "member_id": 成员ID(number),
            "out_id": 成员外部系统唯一ID(string),
            "account": 成员外部系统登录帐号(string),
            "member_name": 成员显示名(string),
            "member_email": 成员邮箱(string),
            "member_phone": 联系电话(string),
            "member_title": 职位(string),
            "state": 成员状态, 1: 启用, 0: 禁用(number),
            "expire": 临时帐号到期时间戳, 单位秒, 无到期日期则不返回(number)
        },
        ...
    ],
    count: 成员总数(number)
}

角色列表

POST /m-open/1/ent/get_roles HTTP/1.1

请求参数

返回格式

json

返回结果

[
    {
        "id": 角色ID(number),
        "name": 角色名称(string),
    },
    ...
]

管理日志

POST /m-open/1/ent/log HTTP/1.1

请求参数

返回格式

json

返回结果

{
    "total": 总共匹配的日志条数(number),
    "list": [
        {
            "type": 1(number),
            "admin": 管理员(string),
            "content": 日志内容(string),
            "ip": ip地址(string),
            "dateline": 操作时间, 单位秒(number)
        },
        ...
    ]
}