跳到主要内容

ONES User API

危险

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

通用说明​

user​

参数名必填类型说明
avatar否string头像 url
department_uuids否array string部门 uuid 列表
name否string用户名称
title否string职位
user_uuid是string用户[UUID]

license 授权信息​

产品名称产品编号
project1
wiki2
TestCase3
Pipeline4
Plan5
Account6
Desk7
Performance8

API 说明​

获取当前用户信息​

获取当前用户的信息

URL​

https://your-host-name/project/api/project/users/me

HTTP Method​

GET

是否需要登录​

是

传值方式​

无

请求参数列表​

无

返回参数列表​

参数名值类型取值范围取值例子说明
uuidstringlen=8136mQpBg用户 uuid
emailstringlen<=128fengbin@bangwork.com用户 email
namestringlen<=16KidFeng用户名称
name_pinyinstringlen<=128KidFeng用户名拼音
avatarstringlen<=255头像 url
phonestringlen<=32用户手机号
statusint1:正常 2.删除的 3.待激活 4.禁用的用户状态
create_timeintint641461314935107445用户注册时间，单位是微秒
companystringlen<=255公司信息
license_typesint[]1, 2, 3, 4, 5license 授权信息
languagestringzh：简体中文，en：英语zh语言环境

请求示例​

curl -X GET \
  https://your-host-name/project/api/project/users/me \
  -H 'Ones-Auth-Token: ILg1uaO9d8MOG6rqQoe6Ozqkv27sTbgiKeDDgapEtIYnkyu8m6d51nq7og0koETZ' \
  -H 'Ones-User-Id: DU6krHBN' \
  -H 'Referer: https://your-host-name' \
  -H 'cache-control: no-cache'

返回示例​

{
  "uuid": "DU6krHBN",
  "email": "niuqiang@ones.com",
  "name": "Arnie",
  "name_pinyin": "Arnie",
  "title": "",
  "avatar": "",
  "phone": "",
  "create_time": 1565770697227728,
  "access_time": 0,
  "status": 1,
  "org_uuid": "AbsatFo2",
  "company": "",
  "license_types": [1, 2, 3, 4, 5, 6, 7, 8],
  "language": ""
}

修改团队成员信息​

更新用户信息

URL​

https://your-host-name/project/api/project/team/:teamUUID/users/update

HTTP Method​

POST

是否需要登录​

是

传值方式​

JSON

请求参数列表​

参数名类型必填说明
userobject是user

返回参数列表​

参数名值类型取值范围取值例子说明
server_update_stampint641461314935107445服务器更新时间戳，单位微秒

请求示例​

curl -X POST \
  https://your-host-name/project/api/project/team/3pDzCwAe/users/update \
  -H 'Ones-Auth-Token: ILg1uaO9d8MOG6rqQoe6Ozqkv27sTbgiKeDDgapEtIYnkyu8m6d51nq7og0koETZ' \
  -H 'Ones-User-Id: DU6krHBN' \
  -H 'Referer: https://your-host-name' \
  -H 'cache-control: no-cache' \
  -d '{
    "user_uuid": "DU6krHBN",
    "name": "Arnie",
    "title": "update title"
}'

返回示例​

{
  "server_update_stamp": 1565850418558480
}

邀请成员​

邀请成员加入团队，可批量邀请，可指定授权的产品。

URL​

https://your-host-name/project/api/project/team/:teamUUID/invitations/add_batch

HTTP Method​

POST

是否需要登录​

是

传值方式​

JSON

请求参数列表​

参数名类型必填说明
email[]string是邀请的邮箱
license_types[]string否邀请时授权的产品

返回参数列表​

参数名值类型取值范围取值例子说明
success_emails[]string成功邀请用户邮箱
bad_emailsarraybad_email 对象邀请失败用户信息

bad_email 对象

参数名值类型取值范围取值例子说明
UUIDstringlen=8136mQpBg用户 uuid
Errerror错误 error

请求示例​

curl -X POST \
  https://your-host-name/project/api/project/team/3pDzCwAe/invitations/add_batch \
  -H 'Ones-Auth-Token: ILg1uaO9d8MOG6rqQoe6Ozqkv27sTbgiKeDDgapEtIYnkyu8m6d51nq7og0koETZ' \
  -H 'Ones-User-Id: DU6krHBN' \
  -H 'Referer: https://your-host-name' \
  -H 'cache-control: no-cache' \
  -d '{"invite_settings":[
          {
            "email":"123414@ones.com"
          }
        ],
        "license_types":[
            7,
            8,
            4,
            5,
            1,
            3,
            2
          ]
  }'

返回示例​

{
  "success_emails": ["123414@ones.com"],
  "bad_emails": []
}

禁用用户​

将用户设置为不可用状态

URL​

https://your-host-name/project/api/project/organization/:orgUUID/disable_members

HTTP Method​

POST

是否需要登录​

是

传值方式​

JSON

请求参数列表​

参数名类型必填说明
members[]string是用户 UUID

返回参数列表​

参数名值类型取值范围取值例子说明
server_update_stampint641461314935107445服务器更新时间戳，单位微秒

请求示例​

curl -X POST \
  https://your-host-name/project/api/project/organization/9pSBWJtj/disable_members \
  -H 'Ones-Auth-Token: ILg1uaO9d8MOG6rqQoe6Ozqkv27sTbgiKeDDgapEtIYnkyu8m6d51nq7og0koETZ' \
  -H 'Ones-User-Id: DU6krHBN' \
  -H 'Referer: https://your-host-name' \
  -H 'cache-control: no-cache' \
  -d '{
        "members":[
          "Jky1qMsA"
        ]
  }'

返回示例​

{
  "server_update_stamp": 1565850418558480
}

查看邀请记录​

查看邀请记录信息

URL​

https://your-host-name/project/api/project/team/:teamUUID/invitations

HTTP Method​

GET

是否需要登录​

是

传值方式​

无

请求参数列表​

无

返回参数列表​

参数名类型取值例子说明
invitationsarray邀请用户列表信息

invitation 对象

参数名类型取值例子说明
codestring邀请码
invite_linkstring邀请链接
emailstring邮箱
is_expiredbool是否过期
statusint用户状态

请求示例​

curl -X GET \
    https://your-host-name/project/api/project/team/AJkTaPb4/invitations \
    -H 'Ones-Auth-Token: m4Bp0Y9g0wYFwJ2hUZVcfbuQD95DvboAAPPeSA17HmJGzOtl919ydVmIXNyJf8NC' \
    -H 'Ones-User-Id: SMS8ciyv'
    -H 'Referer: https://your-host-name' \
    -H 'cache-control: no-cache'

返回示例​

{
  "invitations": [
    {
      "code": "JUzlZSRGU4ZcN0upv3VF7aI0tyl9GpJ1",
      "invite_link": "https://dev.myones.net/project/master/#/auth/join_team?invitation=JUzlZSRGU4ZcN0upv3VF7aI0tyl9GpJ1",
      "email": "2222@ones.com",
      "create_time": 1635302823,
      "status": 1,
      "is_expired": false
    },
    {
      "code": "M4NZ7ztkyIBASEzk5nhJbOEqiOnwWlAZ",
      "invite_link": "https://dev.myones.net/project/master/#/auth/join_team?invitation=M4NZ7ztkyIBASEzk5nhJbOEqiOnwWlAZ",
      "email": "11111@ones.com",
      "create_time": 1635302711,
      "status": 1,
      "is_expired": false
    }
  ]
}

邀请成员确认加入​

邀请成员加入团队后，被邀请成员需要确认才能加入到团队。

URL​

https://your-host-name/project/api/project/auth/invite_join_team

HTTP Method​

POST

是否需要登录​

否

传值方式​

JSON

参数请求列表​

参数名类型必填说明
emailstring是用户邮箱（不可更改） 查看邀请记录
invite_codestring是邀请码 查看邀请记录
namestring是用户名称
passwordstring是密码

参数返回列表​

参数名值类型取值范围取值例子说明
userobjectuser 对象用户登录信息
teamsarrayteam 对象用户当前所属团队信息(目前只有一个团队)
orgobjectorg 对象组织简略信息

user 对象

参数名值类型取值范围取值例子说明
uuidstringlen=8136mQpBg用户 uuid
emailstringlen<=128fengbin@bangwork.com用户 email
namestringlen<=16KidFeng用户名称
name_pinyinstringlen<=128KidFeng用户名拼音
avatarstringlen<=255头像 url
phonestringlen<=32用户手机号
statusint1:正常 2.删除的 3.待激活 4.禁用的用户状态
create_timeintint641461314935107445用户注册时间，单位是微秒
channelstringlen<=32u136mQpBge05C38a5396491a145Eeb7A用户所属的推送频道
tokenstringlen<=64token 用户接口登录
license_typesint[]1, 2, 3, 4, 5license 授权信息
imported_jira_userbooltrue,falsefalse是否通过 jira 导入
is_init_passwordbooltrue,falsefalse是否初始化密码
languagestringzh：简体中文，en：英语zh语言环境

team 对象

参数名值类型取值范围取值例子说明
uuidstringlen<=8WNiMa6DR用户当前所属团队 uuid
namestringlen<=255ones.com用户当前所属团队名称
statusint1:正常,3:过期团队状态
ownerstringlen=8团队 owner 的 uuid
logostring图标
create_timeintint641461314935107445用户创建时间，单位是微秒
expire_timeintint64-1有效期，-1 表示永久有效
member_countint6成员数量
org_uuidstringlen=8团队所属组织的 uuid
workdays[]string"Mon", "Tue", "Wed"等work 日期
workhoursintint64800000work 小时数，单位 10^5，如 8 小时，对应 80000
workhours_unitstringhourwork 单位

org 对象

| 参数名 | 值类型 | 取值范围 | 取值例子 | 说明 | | :--------- | :----- | :-------------- | :------- | :-------- | --- | --- | --- | --- | | uuid | string | len=8 | | 组织 UUID | | name | string | len<=255 | | 组织名称 | | org_type | int | int | 0 | 组织类型 | | style_hash | string | | | | | favicon | string | | | 图标信息 | | status | int | 1:正常 2.删除的 | 1 | 组织状态 | | visibility | bool | true,false | true | 可见性 | | | | |

请求示例​

curl -X POST \
    https://your-host-name/project/api/project/auth/invite_join_team \
    -H 'Content-Type: application/json' \
    -H 'Referer: https://your-host-name' \
    -H 'cache-control: no-cache' \
    -d '{
      "email": "11111@ones.com",
      "password": "ONESzsy888",
      "name": "1111",
      "invite_code": "M4NZ7ztkyIBASEzk5nhJbOEqiOnwWlAZ"
    }'

返回示例​

{
  "user": {
    "uuid": "JYNRQUEv",
    "email": "11111@ones.com",
    "name": "1111",
    "name_pinyin": "",
    "title": "",
    "avatar": "",
    "phone": "",
    "create_time": 1635302711283792,
    "status": 1,
    "channel": "uJYNRQUEvpbtIFpus8UAcjhAgw3z2fdE",
    "token": "0MC0hxg7bxIO9fMrE*********AZzErKPwBSFAW22f2i",
    "license_types": [1, 2, 3, 4, 5, 7, 8],
    "imported_jira_user": false,
    "is_init_password": false
  },
  "teams": [
    {
      "uuid": "Jpa4piQQ",
      "status": 1,
      "name": "Ruddy",
      "owner": "9uaNjXTJ",
      "logo": "",
      "cover_url": "",
      "domain": "",
      "create_time": 1624865026011200,
      "expire_time": -1,
      "type": "pro",
      "config": {
        "sprint": {
          "alias": ""
        }
      },
      "member_count": 6,
      "pending_member_count": 0,
      "disable_member_count": 0,
      "org_uuid": "CbuJaGWN",
      "workdays": ["Mon", "Tue", "Wed", "Thu", "Fri"],
      "workhours": 800000,
      "workhours_unit": "hour"
    }
  ],
  "org": {
    "org_type": 0,
    "uuid": "CbuJaGWN",
    "name": "Ruddy team",
    "style_hash": "",
    "favicon": "",
    "notifications": []
  }
}

删除用户​

删除用户信息，可批量删除。

URL​

https://your-host-name/project/api/project/team/:teamUUID/delete_members

HTTP Method​

POST

是否需要登录​

是

传值方式​

无

请求参数列表​

参数名类型必填说明
members[]string是用户 UUID

返回参数列表​

参数名值类型取值范围取值例子说明
server_update_stampint641461314935107445服务器更新时间戳，单位微秒

请求示例​

curl -X POST \
  https://your-host-name/project/api/project/team/3pDzCwAe/delete_members \
  -H 'Ones-Auth-Token: ILg1uaO9d8MOG6rqQoe6Ozqkv27sTbgiKeDDgapEtIYnkyu8m6d51nq7og0koETZ' \
  -H 'Ones-User-Id: DU6krHBN' \
  -H 'Referer: https://your-host-name' \
  -H 'cache-control: no-cache' \
  -d '{
        "members":[
          "Jky1qMsA"
        ]
  }'

返回示例​

{
  "server_update_stamp": 1565850418558480
}
最后于 更新