Users¶
This section describes the RESTful API for managing system users. System users are used to authenticate with Ella Core and manage the system.
List Users¶
This path returns the list of system users.
Method | Path |
---|---|
GET | /api/v1/users |
Parameters¶
None
Sample Response¶
{
"result": [
{
"email": "admin"
}
]
}
Create a User¶
This path creates a new system user. The first user can be created without authentication.
Method | Path |
---|---|
POST | /api/v1/users |
Parameters¶
email
(string): The email of the user.password
(string): The password of the user.
Sample Response¶
{
"result": {
"message": "User created successfully"
}
}
Update a User¶
This path updates an existing system user.
Method | Path |
---|---|
PUT | /api/v1/users/{email} |
Parameters¶
password
(string): The password of the user.
Sample Response¶
{
"result": {
"message": "User updated successfully"
}
}
Get a User¶
This path returns the details of a specific system user.
Method | Path |
---|---|
GET | /api/v1/users/{email} |
Parameters¶
None
Sample Response¶
{
"result": {
"email": "guillaume@ellanetworks.com"
}
}
Delete a User¶
This path deletes a user from Ella Core.
Method | Path |
---|---|
DELETE | /api/v1/users/{email} |
Parameters¶
None
Sample Response¶
{
"result": {
"message": "User deleted successfully"
}
}