Skip to main content

ONES User API

danger

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

通用说明​

user​

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

API 说明​

1. 获取当前用户信息​

获取当前用户的信息

URL​

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

HTTP Method​

GET

是否需要登录​

是

传值方式​

无

参数列表​

无

请求体参考​

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": "会飞的犀牛长",
  "name_pinyin": "hui4fei1dexi1niu2zhang3",
  "title": "",
  "avatar": "",
  "phone": "",
  "create_time": 1565770697227728,
  "access_time": 0,
  "status": 1,
  "org_uuid": "AbsatFo2"
}

2. 修改团队成员信息​

URL​

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

HTTP Method​

POST

是否需要登录​

是

参数列表​

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

请求体参考​

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": "会飞的犀牛长",
    "title": "update title"
}'

返回值参考​

{
  "server_update_stamp": 1565850418558480
}

3. 邀请成员​

URL​

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

HTTP Method​

POST

是否需要登录​

是

参数列表​

参数名类型必填说明
email[]string是邀请的邮箱
license_types[]string否邀请时授权的产品
产品名称产品编号
project1
wiki2
TestCase3
Pipeline4
Plan5
Account6
Desk7
Performance8

请求体参考​

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
          ]
  }'

返回值参考​

{
  "bad_emails": []
}

4. 禁用用户​

URL​

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

HTTP Method​

POST

是否需要登录​

是

参数列表​

参数名类型必填说明
orgUUIDstring是组织 UUID，传参方式：In path
members[]string是用户 UUID

请求体参考​

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
}

5. 查看邀请记录​

URL​

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

HTTP Method​

GET

是否需要登录​

是

参数列表​

无

返回参数说明​

参数名类型说明
invitationsarray用户 UUID
  code[]string邀请码
  invite_link[]string邀请链接
  email[]string邮箱
  is_expiredbool是否过期

返回值参考​

{
  "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
    }
  ]
}

6. 邀请成员确认加入​

URL​

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

HTTP Method​

POST

是否需要登录​

否

参数列表​

参数名类型必填说明
emailstring是用户邮箱（不可更改） 5. 查看邀请记录
invite_code[]string是邀请码 5. 查看邀请记录
name[]string是用户名称
password[]string是密码

请求体参考​

{
  "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": "宇宙最强",
      "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": "宇宙最强team",
    "style_hash": "",
    "favicon": "",
    "notifications": []
  }
}

7. 删除用户​

URL​

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

HTTP Method​

POST

是否需要登录​

是

参数列表​

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

请求体参考​

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
}
Last updated on