ONES Auth API

• 通用说明
  • 状态码说明
  • 字段格式
• API 说明
  • 用户登录
  • 获取登录信息
  • 用户登出

通用说明

如果您需要调用 ONES 应用程序接口， 通常用户登录是必须的。您可以通过调用 ONES 用户登录接口完成用户登录。 如果您是合法用户，登录接口返回值会包含 user.uuid 和 user.token, 此二值用于 ONES 用户登录凭证。

ONES API 接口登录凭证作为 HTTP Header 为接口调用提供身份校验:

状态码说明

字段格式

email

email 的长度必须小于等于 128，并符合以下正则表达式

^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$

phone

\+(9[976]\d|8[987530]\d|6[987]\d|5[90]\d|42\d|3[875]\d|2[98654321]\d|9[8543210]|8[6421]|6[6543210]|5[87654321]|4[987654310]|3[9643210]|2[70]|7|1)\d{1,14}$

password

密码要求：[8,32] 位 ascii chart 可打印字符

^[\x21-\x7E]{8,32}$

API 说明

用户登录

用户登录接口返回值中 token 用于其他 api 访问时的登录字段，token 没有过期时间，用户修改密码、被移出团队或者用户主动登出时会导致 token 失效。

URL

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

HTTP Method

POST

是否需要登录

否

传值方式

JSON

参数列表

其中，email和phone必须填其中一个，当email和phone同时存在时，只有email生效

返回参数列表

返回值参考

http_status_code=200

{
  "user": {
    "uuid": "Gq8ZZZ7F",
    "email": "timliudream+200@163.com",
    "name": "timliudream+200",
    "name_pinyin": "timliudream+200",
    "title": "",
    "avatar": "",
    "phone": "",
    "create_time": 1547538969719424,
    "status": 1,
    "channel": "uGq8ZZZ7FflUZ6X5J7pqNlQclsWmkTUD",
    "token": "vBRxnkWypojEA2xxqe92GhhXW3f2FbjC9xZ1A2p7kW0mFhskEwX0wHDpvYZJkpM3",
    "license_types": [1, 2, 3, 4, 5]
  },
  "teams": [
    {
      "uuid": "U66S45tG",
      "status": 1,
      "name": "tim",
      "owner": "Gq8ZZZ7F",
      "logo": "",
      "cover_url": "",
      "domain": "",
      "create_time": 1547538969731072,
      "expire_time": -1,
      "type": "pro",
      "config": {
        "sprint": {
          "alias": ""
        }
      },
      "member_count": 6,
      "org_uuid": "369VHsHp",
      "workdays": ["Mon", "Tue", "Wed", "Thu", "Fri"],
      "workhours": 800000
    }
  ],
  "org": {
    "uuid": "369VHsHp",
    "name": "tim",
    "org_type": 0,
    "style_hash": "7acb764ba7bbe3137a0ad6ee9ca45cc7"
  }
}

异常返回值参考

http_status_code=813

{
  "is_owner": true,
  "expire_time": 1578053867,
  "csm": {
    "email": "lianxun@ones.ai",
    "name": "??",
    "title": "??????",
    "phone": "???????????"
  }
}

获取登录信息

登录后获取登录用户的信息(包括组织、团队信息，登录人员基本信息以及token)

URL

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

HTTP Method

GET

是否需要登录

是

传值方式

JSON

参数列表

无

返回参数列表

返回值参考

http_status_code=200

{
  "user": {
    "uuid": "Gq8ZZZ7F",
    "email": "timliudream+200@163.com",
    "name": "timliudream+200",
    "name_pinyin": "timliudream+200",
    "title": "",
    "avatar": "",
    "phone": "",
    "create_time": 1547538969719424,
    "status": 1,
    "channel": "uGq8ZZZ7FflUZ6X5J7pqNlQclsWmkTUD",
    "token": "vBRxnkWypojEA2xxqe92GhhXW3f2FbjC9xZ1A2p7kW0mFhskEwX0wHDpvYZJkpM3",
    "license_types": [1, 2, 3, 4, 5]
  },
  "teams": [
    {
      "uuid": "U66S45tG",
      "status": 1,
      "name": "tim",
      "owner": "Gq8ZZZ7F",
      "logo": "",
      "cover_url": "",
      "domain": "",
      "create_time": 1547538969731072,
      "expire_time": -1,
      "type": "pro",
      "config": {
        "sprint": {
          "alias": ""
        }
      },
      "member_count": 6,
      "org_uuid": "369VHsHp",
      "workdays": ["Mon", "Tue", "Wed", "Thu", "Fri"],
      "workhours": 800000
    }
  ],
  "org": {
    "uuid": "369VHsHp",
    "name": "tim",
    "org_type": 0,
    "style_hash": "7acb764ba7bbe3137a0ad6ee9ca45cc7"
  }
}

用户登出

URL

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

HTTP Method

GET

是否需要登录

是

传值方式

wu

参数列表

无

返回值参考

http_status_code=200

null

错误返回值参考

http_status_code=401

{
    "code": 401,
    "errcode": "AuthFailure.InvalidToken",
    "reason": "InvalidToken",
    "type": "AuthFailure"
}