ONES Organization API

danger

ONES API 已废弃。请使用Open API。

• 通用说明
  • 组织
  • 组织类型枚举
• API 说明
  • 1. 获取组织信息
  • 2. 将组织成员添加到团队
  • 3. 删除组织成员
  • 4. 获取组织下所有团队
  • 5. 获取用户有权限的所有团队
  • 6. 获取组织成员列表
  • 7. 获取组织额外支持信息
  • 8. 获取第三方组织架构信息
  • 9. 在组织下获取某团队绑定的第三方组织信息

通用说明

组织

organization

参数名	值类型	取值范围	说明
uuid	string	len=8	组织 UUID
name	string		组织名称
scale	int		组织规模（最大成员数）
type	string		组织类型，详见下方说明
sync_data	array		第三方同步数据
sync_type	int		第三方企业类型 1:微信；2：钉钉
sync_corp_uuid	int		第三方企业 id
sync_corp_name	string		第三方企业名称
sync_agent_id	int		第三方企业应用名称
owner	string		组织创建者
logo	string		组织 logo
status	int		组织状态 1：正常；2：已过期
visibility	bool		组织页是否可见
server_update_stamp	int64		更新时间戳
sidebar_menus	array		更新时间戳
key	string		侧边栏配置 key
default_value	string		侧边栏配置默认值
element_show	bool		是否在管理界面展示此侧边栏组件
value	string		侧边栏配置 value
is_show	bool		侧边栏配置是否展示
is_can_update_text	bool		侧边栏配置是否可以更改 value
is_can_update_is_show	bool		侧边栏配置是否可以更改是否展示

组织类型

organization_type

组织类型	说明	功能限制
free	免费组织	无过期时间，15 人，3 个项目，30M 附件
pro	高级付费组织	有过期时间，300M 附件

状态码说明

状态码	说明
200	成功
403	没有创建的权限
500	服务器内部错误

API 说明

1. 获取组织信息

URL

https://your-host-name/project/api/project/organization/:organizationUUID/info

HTTP Method

GET

是否需要登录

是

传值方式

url param

参数列表

无

返回值参考

{
  "uuid": "CbuJaGWN",
  "name": "xx组织",
  "owner": "9uaNjXTJ",
  "logo": "",
  "favicon": "",
  "type": "pro",
  "status": 1,
  "scale": 5000,
  "member_count": 6,
  "disable_member_count": 1,
  "sync_data": [],
  "create_time": 1624865025,
  "visibility": false,
  "enable_workorder_component": false
}

2. 将组织成员添加到团队

URL

https://your-host-name/project/api/project/organization/:organizationUUID/add

HTTP Method

POST

调用权限

manage_organization_member 或 administer_organization(只可添加自己)

是否需要登录

是

传值方式

url param

参数列表

参数名	是否必须	值类型	取值范围	说明
team_uuid	T	string		指定团队
members	T	string array		用户 UUID 列表

返回参数列表

JSON 键名	值类型	说明
bad_members
uuid	string	用户 UUID
code	int	返回码
desc	string	错误描述

{
  "bad_members": [
    {
      "uuid": "W426Dryc",
      "code": 409,
      "desc": "user already in team"
    }
  ]
}

3. 删除组织成员

URL

https://your-host-name/project/api/project/organization/:organizationUUID/delete_member

HTTP Method

POST

调用权限

manage_organization_member

是否需要登录

是

传值方式

url param

参数列表

参数名	是否必须	值类型	取值范围	说明
member	T	string		用户 UUID

4. 获取组织下所有团队

URL

https://your-host-name/project/api/project/organization/:organizationUUID/teams

HTTP Method

GET

调用权限

manage_organization_member 或者 administrator_organization

是否需要登录

是

传值方式

url param

参数列表

无

5. 获取用户有权限的所有团队

URL

https://your-host-name/project/api/project/organization/:organizationUUID/my_teams

HTTP Method

GET

是否需要登录

是

传值方式

url param

参数列表

无

6. 获取组织成员列表

URL

https://your-host-name/project/api/project/organization/:organizationUUID/members

HTTP Method

GET

调用权限

manage_organization_member 或 administer_organization

是否需要登录

是

传值方式

url param

7. 获取组织额外支持信息

URL

https://your-host-name/project/api/project/organization/:organizationUUID/service

HTTP Method

GET

是否需要登录

是

调用权限

manage_organization_member 或 administer_organization

传值方式

url param

8. 获取第三方组织架构信息

URL

https://your-host-name/project/api/project/organization/:organizationUUID/sso/sync_data

HTTP Method

GET

调用权限

administer_organization

是否需要登录

是

传值方式

url param

参数列表

无

返回参数列表

参数名	值类型	说明
sync_data	array	第三方组织数据
sync_type	int	第三方组织类型
departments	array	部门集合
sync_id	string	部门 id
parent_id	string	父节点 id
name	string	部门名称
next_id	string	下一个兄弟节点 id
member_count	int	部门成员数
members	array	用户集合
sync_id	string	用户 uuid
name	string	用户名
email	string	用户邮箱

9. 在组织下获取某团队绑定的第三方组织信息

URL

https://your-host-name/project/api/project/organization/:organizationUUID/team/:teamUUID/sync_data

HTTP Method

GET

调用权限

administer_organization

是否需要登录

是

传值方式

URL

参数列表

无

返回参数列表

参数名	值类型	取值例子	说明
sync_data	array		绑定的第三方组织
sync_type	int	1:wechat;2:dingding	第三方组织类型
sync_corp_uuid	string		指定第三方组织企业 id
sync_corp_name	string		指定第三方组织企业名称
sync_agent_id	int		指定第三方组织企业应用名称
departments	array	["id1","id2"]	指定部门 sync_ids
members	array	["id1","id2"]	指定成员 sync_ids