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`

None

{
    "result": [
        {
            "email": "admin"
        }
    ]
}

This path creates a new system user. The first user can be created without authentication.

Method	Path
POST	`/api/v1/users`

email (string): The email of the user.
password (string): The password of the user.
role (int): The role of the user. Allowed values:
- admin: Administrator user with full access to network and system resources.
- network-manager: Network manager user with full access to network resources.
- readonly: Read-only user with only read access to network resources.

{
    "result": {
        "message": "User created successfully"
    }
}

This path updates an existing system user.

Method	Path
PUT	`/api/v1/users/{email}`

role (int): The role of the user. Allowed values:
- admin: Administrator user with full access to network and system resources.
- network-manager: Network manager user with full access to network resources.
- readonly: Read-only user with only read access to network resources.

{
    "result": {
        "message": "User updated successfully"
    }
}

This path returns the details of a specific system user.

Method	Path
GET	`/api/v1/users/{email}`

None

{
    "result": {
        "email": "guillaume@ellanetworks.com"
    }
}

This path deletes a user from Ella Core.

Method	Path
DELETE	`/api/v1/users/{email}`

None

{
    "result": {
        "message": "User deleted successfully"
    }
}

This path updates the password of a specific system user.

Method	Path
PUT	`/api/v1/users/{email}/password`

{
    "result": {
        "message": "User password updated successfully"
    }
}