ONES User 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.ai",
"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
是否需要登录
是
参数列表
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| user | object | 是 | 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
是否需要登录
是
参数列表
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| []string | 是 | 邀请的邮箱 | |
| license_types | []string | 否 | 邀请时授权的产品 |
| 产品名称 | 产品编号 |
|---|---|
| project | 1 |
| wiki | 2 |
| TestCase | 3 |
| Pipeline | 4 |
| Plan | 5 |
| Account | 6 |
| Desk | 7 |
| Performance | 8 |
请求体参考
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.ai"
}
],
"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
是否需要登录
是
参数列表
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| orgUUID | string | 是 | 组织UUID |
| memvers | []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
}