Users API

Endpoints for user management, authentication, and registration.

Register User

POST /api/user/register

Request Body

Field	Type	Required	Description
userName	String	Yes	Username (3-50 chars)
password	String	Yes	Password (6-100 chars)
email	String	No	Email address
tel	String	No	Phone number

Response

{
  "code": 200,
  "message": "Register success",
  "data": {
    "id": 1,
    "userName": "demo",
    "email": "demo@example.com",
    "state": 1
  }
}

Login

POST /api/user/login

Request Body

Field	Type	Required	Description
account	String	Yes	Username or email
password	String	Yes	User password

Response

{
  "code": 200,
  "message": "Login success",
  "data": {
    "token": {
      "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "expiresIn": 86400,
      "tokenType": "Bearer"
    },
    "userType": "PLATFORM_ADMIN",
    "tenantId": null,
    "deploymentMode": "private",
    "userName": "demo",
    "userId": 1
  }
}

Get User Info

GET /api/user/info

Response

{
  "code": 200,
  "data": {
    "id": 1,
    "userName": "demo",
    "email": "demo@example.com",
    "tel": "13800138000",
    "userType": "PLATFORM_ADMIN",
    "tenantId": null,
    "state": 1,
    "createdTime": "2026-08-01T00:00:00Z"
  }
}

List Users

GET /api/user/list

Query Parameters

Parameter	Type	Description
page	Integer	Page number
pageSize	Integer	Items per page
userName	String	Filter by username

Refresh Token

POST /api/user/refresh

{
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Forgot Password

POST /api/user/forgot-password

{
  "email": "user@example.com"
}

Reset Password

POST /api/user/reset-password

{
  "token": "reset-token-from-email",
  "newPassword": "newSecurePassword123"
}