diff --git a/docs/user_api.rst b/docs/user_api.rst index c56a9e4f71421b692e9ed8068040855a73f56786..d33a241e2065848f2566f811bb3a8fdf8bb8e21c 100644 --- a/docs/user_api.rst +++ b/docs/user_api.rst @@ -16,12 +16,15 @@ API 文档 .. code-block:: shell - $ curl -X POST -H 'Content-Type: application/json' -d '{"username": "admin", "password": "admin"}' http://localhost/api/users/v1/auth/ # 获å–token - {"token":"937b38011acf499eb474e2fecb424ab3"}% # 获å–到的token + $ curl -X POST http://localhost/api/users/v1/auth/ -H 'Content-Type: application/json' -d '{"username": "admin", "password": "admin"}' # 获å–token + {"token":"937b38011acf499eb474e2fecb424ab3"} # 获å–到的token # 如果开å¯äº† MFA, 则返回的是 seed, éœ€è¦æºå¸¦ seed å’Œ otp_code 冿¬¡æäº¤ä¸€æ¬¡æ‰èƒ½èŽ·å–到 token - $ curl -X POST -H 'Content-Type: application/json' -H 'cache-control: no-cache' -d '{"seed": "629ba0935a624bd9b21e31c19e0cc8cb", "otp_code": "202123"}' - {"token":"937b38011acf499eb474e2fecb424ab3"}% + curl -X POST http://localhost/api/users/v1/auth/ -H 'Content-Type: application/json' -d '{"username": "admin", "password": "admin"}' + {"code":101,"msg":"请æºå¸¦seed值, 进行MFA二次认è¯","otp_url":"/api/users/v1/otp/auth/","seed":"629ba0935a624bd9b21e31c19e0cc8cb"} + $ curl -X POST http://localhost/api/users/v1/otp/auth/ -H 'Content-Type: application/json' -H 'cache-control: no-cache' -d '{"seed": "629ba0935a624bd9b21e31c19e0cc8cb", "otp_code": "202123"}' + {"token":"937b38011acf499eb474e2fecb424ab3"} + # otp_code 为动æ€å¯†ç $ curl -H 'Authorization: Bearer 937b38011acf499eb474e2fecb424ab3' -H "Content-Type:application/json" http://localhost/api/users/v1/users/ # 使用token访问,token有效期 1å°æ—¶