Users Management

Local Users Endpoints

Endpoints for viewing user(s), creating a user, updating a user, enabling or disabling a user.

Display users : GET /api2/users admin
Display user : GET /api2/users/{id} admin
Create user : POST /api2/users admin
- usage: the email, name, username, role and password fields are mandatory and should be passed in the request payload.
Update user : PUT /api2/users/{id} admin
- usage: the email, name, username, role and password fields are mandatory and should be passed in the request payload.
Delete user : DELETE /api2/users/{id} admin
- usage: the request body has to be empty

Json Structure

]
    {
        "id": 1,
        "name": "admin",
        "username": "admin",
        "email": "admin@profitap.com",
        "sshKey": "",
        "role": "admin",
        "enabled": true,
        "creation_time": 1542373932,
        "modification_time": 1542373932,
        "last_access": 0
    },
    {
        "id": 3,
        "name": "guest",
        "username": "guest",
        "email": "guest@profitap.com",
        "sshKey": null,
        "role": "viewer",
        "enabled": true,
        "creation_time": 1542373932,
        "modification_time": 1542373932,
        "last_access": 0
    }
]

Back to X2-SERIES API Home