optimuscms/users

Optimus Users

This package provides the core backend functionality for managing the users who can access the CMS., _(*1)

Installation

This package can be installed through Composer., _(*2)

composer require optimuscms/users

In Laravel 5.5 and above the package will autoregister the service provider., _(*3)

In Laravel 5.4 you must install this service provider:, _(*4)

// config/app.php
'providers' => [
    ...
    Optimus\Users\UserServiceProvider::class,
    ...
];

API Routes

The API follows standard RESTful conventions, with responses being returned in JSON. Appropriate HTTP status codes are provided, and these should be used to check the outcome of an operation., _(*5)

Users, _(*6)

• List users
• Get user
• Create user
• Update user
• Delete user

List users

List all registered users., _(*7)

GET /admin/api/users

Request Body, _(*8)

None, _(*9)

Example Response, _(*10)

{
    "data": [
        {
            "id": 1,
            "name": "Jack Robertson",
            "email": "jack@optixsolutions.co.uk",
            "username": "jack",
            "created_at": "2019-02-19 09:14:44",
            "updated_at": "2019-02-19 09:14:50"
        },
        {
            "id": 2,
            "name": "Rich Moore",
            "email": "rich@optixsolutions.co.uk",
            "username": "rich",
            "created_at": "2019-02-19 09:36:23",
            "updated_at": "2019-02-19 09:36:23"
        }
    ]
}

Create user

Create a new users who can access the CMS., _(*11)

POST /admin/api/users

Request Body, _(*12)

Example Response, _(*13)

Returns the details of the newly created user. See single user response example., _(*14)

Get user

Get the details of a specific user., _(*15)

GET /admin/api/users/{id}

Request Body, _(*16)

None, _(*17)

Example Response, _(*18)

{
    "data": {
        "id": 1,
        "name": "Jack Robertson",
        "email": "jack@optixsolutions.co.uk",
        "username": "jack",
        "created_at": "2019-02-19 09:14:44",
        "updated_at": "2019-02-19 09:14:50"
    }
}

Update user

Update the details of a specific user., _(*19)

PATCH /admin/api/users/{id}

Request Body, _(*20)

Example Response, _(*21)

Returns the details of the updated user. See single user response example., _(*22)

Delete user

Delete a user so they can no longer access the CMS., _(*23)

DELETE /admin/api/users/{id}

Request Body, _(*24)

None, _(*25)

Example Response, _(*26)

The HTTP status code will be 204 if successful., _(*27)

License

The MIT License (MIT). Please see License File for more information., _(*28)