Common

Ping

GET /

200: OK Access to Cookies XSRF_TOKEN

- Body
    - **name** `string` Host, pod name
    - **ip** `string` Real IP
    - **now** `date` Current time
    - **values** `object` The node is runtime configured and returned when Mode != release

400: Bad Request

- Body
    - **message** `string`

Login

POST /login

Request Body

Name	Type	Description
email*	String
password*	String

204: No Content

400: Bad Request

- Body
    - **message** `string`

SMS Login Code

GET /login/sms

204: No Content

400: Bad Request

- Body
    - **message** `string`

SMS Login

POST /login/sms

Request Body

Name	Type	Description
phone*	String
code*	String	sms login code

204: No Content

400: Bad Request

- Body
    - **message** `string`

TOTP Login

POST /login/totp

Request Body

Name	Type	Description
email*	String
code*	String	Totp Code

204: No Content

400: Bad Request

- Body
    - **message** `string`

Reset Password Code

GET /forget_code

Query Parameters

Name	Type	Description
email*	String

204: No Content

400: Bad Request

- Body
  - **message** `string`

Reset Password

POST /forget_reset

Request Body

Name	Type	Description
email*	String
code*	String	Reset password code
password*	String	Reset password

204: No Content

400: Bad Request

- Body
  - **message** `string`

Verify

GET /verify

204: No Content

400: Bad Request

- Body
    - **message** `string`

401: Unauthorized

- Body
    - **code** `string` Business code
    - **message** `string`

Token Refresh Code

GET /refresh_code

200: OK

- Body
    - **code** `string`

400: Bad Request

- Body
    - **message** `string`

Refresh Token

GET /refresh_token

Request Body

Name	Type	Description
code*	String	Token refresh code

204: No Content

400: Bad Request

- Body
    - **message** `string`

Logout

POST /logout

204: No Content

User Info

GET /user

200: OK

- Body
    - **_id** `string` User ID
    - **email** `string` User email
    - **name** `string` User name
    - **avatar** `string` User avatar
    - **phone** `string` Phone settings status
    - **sessions** `number` Total number of sessions
    - **history** `object` Recent login history
    - **totp** `string` TOTP settings status
    - **lark** `object` Lark info
    - **status** `bool` User status
    - **create_time** `date`
    - **update_time** `date`

400: Bad Request

- Body
    - **message** `string`

Set User

PATCH /user

Request Body

Name	Type	Description
key*	String	Email|Name|Avatar Specify updated field
email	String	RequiredIf: key=Email
name	String	RequiredIf: key=Name
avatar	String	RequiredIf: key=Avatar

204: No Content

400: Bad Request

- Body
    - **message** `string`

Set Password

POST /user/password

Request Body

Name	Type	Description
old*	String	Old password
password*	String	New password

204: No Content

400: Bad Request

- Body
    - **message** `string`

User SMS Code

GET /user/phone_code

204: No Content

400: Bad Request

- Body
    - **message** `string`

Bind User's Phone

POST /user/phone

Request Body

Name	Type	Description
phone*	String	Phone number
code*	String	SMS code

204: No Content

400: Bad Request

- Body
    - **message** `string`

Generate TOTP URL

GET /user/totp

200: OK

- Body
    - **totp** `string` TOTP URL

400: Bad Request

- Body
    - **message** `string`

Bind TOTP

POST /user/totp

Request Body

Name	Type	Description
totp*	String	TOTP URL
tss*	String[]	Two consecutive code

204: No Content

400: Bad Request

- Body
    - **message** `string`

Unset User

DELETE /user/:key

Path Parameters

Name	Type	Description
key*	String	phone|totp|lark Specify updated field

204: No Content

400: Bad Request

- Body
    - **message** `string`

Load Option

GET /options

Query Parameters

Name	Type	Description
type*	String	Type, include: upload、collaboration、generate-secret

200: OK

400: Bad Request

- Body
    - **message** `string`