Skip to the content.

Authentication API

1. Get System Info

Returns basic system information (name, software version).

Response:

{
  "code": "0",
  "data": {
    "name": "EdgeGateway-01",
    "softVer": "v1.0.0"
  }
}

2. Get Login Nonce

Obtain a random nonce for password encryption. Valid for 2 minutes. Rate limited (2 req/s).

Response:

{
  "code": "0",
  "data": {
    "nonce": "a1b2c3d4e5f6..."
  }
}

3. Login

Authenticate user. Supports local and LDAP login.

Request Body:

{
  "loginFlag": true,
  "loginType": "local", // "local" or "ldap"
  "data": {
    "username": "admin",
    "password": "<SHA256(raw_password + nonce)>", // Hex encoded string
    "nonce": "<nonce_from_previous_step>"
  }
}

Response:

{
  "code": "0",
  "msg": "Success",
  "data": {
    "username": "admin",
    "token": "eyJhbGciOiJIUzI1Ni...",
    "permissions": ["admin"]
  }
}

4. Logout

Response:

{
  "code": "0",
  "msg": "Logged out"
}

5. Change Password

Change current user’s password.

Request Body:

{
  "oldPassword": "<SHA256(old_raw_password + nonce)>",
  "newPassword": "new_raw_password",
  "nonce": "<nonce_from_new_request>"
}

Response:

{
  "code": "0",
  "msg": "密码修改成功"
}