部门和成员操作

更新: 2017-05-25

成员和部门同步API

企业成员和部门API

API域名

Host: yk3-api-ent.gokuai.com

添加或修改同步成员

POST /1/ent/add_sync_member HTTP/1.1

请求参数

参数 必须 类型 说明
client_id string 企业授权管理中获得的client_id
dateline int unix当前时间戳
out_id string 成员在外部系统的唯一id
member_name string 显示名称
account string 成员在外部系统的登录帐号
member_email string 邮箱
member_phone string 联系电话
password string 如果需要由够快验证帐号密码,密码为必须参数
state int 帐号状态, 默认1启用, 0禁用, 如果启用帐号数量超出限制, 设置启用将会无效
sign string 签名

返回结果

HTTP 200


删除同步成员

POST /1/ent/del_sync_member HTTP/1.1

请求参数

参数 必须 类型 说明
client_id string 企业授权管理中获得的client_id
dateline int unix当前时间戳
members string 成员在外部系统的唯一id, 多个时用逗号分隔
sign string 签名

返回结果

HTTP 200


添加或修改同步部门

POST /1/ent/add_sync_group HTTP/1.1

请求参数

参数 必须 类型 说明
client_id string 企业授权管理中获得的client_id
dateline int unix当前时间戳
out_id string 部门在外部系统的唯一id
name string 显示名称
parent_out_id string 如果部门在另一个部门的下级, 需要指定上级部门唯一id, 不传表示在顶层; 修改时该字段用于移动部门, 空字符串表示移动到顶层
sign string 签名

返回结果

HTTP 200


删除同步部门

POST /1/ent/del_sync_group HTTP/1.1

请求参数

参数 必须 类型 说明
client_id string 企业授权管理中获得的client_id
dateline int unix当前时间戳
groups string 部门在外部系统的唯一id, 多个时用逗号分隔
sign string 签名

返回结果

HTTP 200


添加同步部门的成员

POST /1/ent/add_sync_group_member HTTP/1.1

请求参数

参数 必须 类型 说明
client_id string 企业授权管理中获得的client_id
dateline int unix当前时间戳
group_out_id string 外部部门的唯一id, 不传表示顶层
members string 成员在外部系统的唯一id, 多个时用逗号分隔
sign string 签名

返回结果

HTTP 200


删除同步部门的成员

POST /1/ent/del_sync_group_member HTTP/1.1

请求参数

参数 必须 类型 说明
client_id string 企业授权管理中获得的client_id
dateline int unix当前时间戳
group_out_id string 外部部门的唯一id, 不传表示顶层
members string 成员在外部系统的唯一id, 多个时用逗号分隔
sign string 签名

返回结果

HTTP 200


删除成员的所属部门

POST /1/ent/del_sync_member_group HTTP/1.1

请求参数

参数 必须 类型 说明
client_id string 企业授权管理中获得的client_id
dateline int unix当前时间戳
members string 成员在外部系统的唯一id, 多个时用逗号分隔
sign string 签名

返回结果

HTTP 200


添加管理员

POST /1/ent/add_sync_admin HTTP/1.1

请求参数

参数 必须 类型 说明
client_id string 企业授权管理中获得的client_id
dateline int unix当前时间戳
out_id string 成员在外部系统的唯一id
member_email string 成员邮箱
type int 值为1时,表示超级管理员,值为0时,表示管理员
sign string 签名

返回结果

HTTP 200


成员列表

POST /1/ent/get_members HTTP/1.1

请求参数

参数 必须 类型 说明
client_id string 企业授权管理中获得的client_id
dateline int unix当前时间戳
sign string 签名
start int 记录开始位置, 默认0
size int 返回条数, 默认20

返回格式

json

返回结果

{
    list:
    [
        {
            "member_id": 成员id,
            "out_id": 成员外部id,
            "account": 外部账号,
            "member_name": 成员显示名,
            "member_email": 成员邮箱,
            "state": 成员状态。1:已接受,2:未接受,
        },
        ...
    ],
    count: 成员总数
}

成员信息

POST /1/ent/get_member HTTP/1.1

请求参数

参数 必须 类型 说明
client_id string 企业授权管理中获得的client_id
dateline int unix当前时间戳
sign string 签名
member_id string 成员id
out_id string 外部系统唯一id
account string 外部系统登录帐号
show_groups int 是否返回成员所属部门; 1返回, 0不返回, 默认不返回

注: 参数中的member_id, out_idaccount必须传其中之一

返回格式

json

返回结果

{
    "member_id": 成员id,
    "member_name": 成员显示名,
    "member_email": 成员邮箱,
    "out_id": 外部系统唯一id,
    "account": 外部系统登录帐号,
    "state": 成员状态。1:已接受,2:未接受,
    "groups" :
    [
        {
            "id": 部门id,
            "name": 部门名称,
            "group_code": 内部code,
            "out_id": 外部系统部门唯一id
        },
        ...
    ]
}

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

POST /1/ent/get_member_by_out_id HTTP/1.1

请求参数

参数 必须 类型 说明
client_id string 企业授权管理中获得的client_id
dateline int unix当前时间戳
sign string 签名
out_ids string 外部成员id,以逗号隔开
user_ids string 外部成员登录帐号,以逗号隔开

out_idsuser_ids 只需传其中一个

返回格式

json

返回结果

{
    out_id:{
        "member_id": 成员id,
        "account": 外部账号,
        "member_name": 成员显示名,
        "member_email": 成员邮箱,
        "state": 成员状态。1:已接受,2:未接受
    },
    ...
}

部门列表

POST /1/ent/get_groups HTTP/1.1

请求参数

参数 必须 类型 说明
client_id string 企业授权管理中获得的client_id
dateline int unix当前时间戳
sign string 签名

返回格式

json

返回结果

{
    "list":
    [
        {
            "id": 部门id,
            "name": 部门名称,
            "out_id": 外部唯一id,
            "parent_id": 上级部门id, 0为顶级部门
        }
    ]
}

部门中成员列表

POST /1/ent/get_group_members HTTP/1.1

请求参数

参数 必须 类型 说明
client_id string 企业授权管理中获得的client_id
dateline int unix当前时间戳
sign string 签名
group_id int 部门id
start int 记录开始位置, 默认0
size int 返回条数, 默认20
show_child int [0,1] 是否返回下层部门内的成员, 默认不返回

返回格式

json

返回结果

{
    list:
    [
        {
            "member_id": 成员id,
            "out_id": 成员外部id,
            "account": 外部账号,
            "member_name": 成员显示名,
            "member_email": 成员邮箱,
            "state": 成员状态。1:已接受,2:未接受,
        },
        ...
    ],
    count: 成员总数
}

角色列表

POST /1/ent/get_roles HTTP/1.1

请求参数

参数 必须 类型 说明
client_id string 企业授权管理中获得的client_id
dateline int unix当前时间戳
sign string 签名

返回格式

json

返回结果

[
    {
        "id": 角色id,
        "name": 角色名称,
        },
    ...
]

成员个人云库外链列表

POST /1/ent/get_member_file_link HTTP/1.1

请求参数

参数 必须 类型 说明
client_id string 企业授权管理中获得的client_id
dateline int unix当前时间戳
sign string 签名
member_id int 成员id
file int 是否只返回文件, 1只返回文件

返回格式

json

返回结果

[
    {
        "filename": 文件名或文件夹名,
        "filesize": 文件大小,
        "link": 链接地址,
        "deadline": 到期时间戳 -1表示永久有效,
        "password": 是否加密, 1加密, 0无
    },
    ...
]