Get system user list
1. API Description
This API is used to obtain the user list of the system.
Request mode: POST [ip]/api/user/get-all
Administrator Rights | Logged-in |
---|---|
Yes | Yes |
2. Input Parameters
None
3. Output Parameters
Name | Type | Description |
---|---|---|
status | Int | Status code |
code | String | Status description |
users | Array of user | User list |
USER
Name | Type | Description |
---|---|---|
username | String | User name |
group | String | User group, Admin or User |
4. Example
Obtaining the user list.
Input Example
None
Output Example
{
"users": [
{
"username": "Admin",
"group": "Admin"
},
{
"username": "test",
"group": "User"
}
],
"status": 0,
"code": "Success"
}
5. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Status | Definition | Description |
---|---|---|
31 | NOT_PERMITTED | Only administrators have permission |