Download the PHP package optimuscms/users without Composer
On this page you can find all versions of the php package optimuscms/users. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package users
Optimus Users
This package provides the core backend functionality for managing the users who can access the CMS.
Installation
This package can be installed through Composer.
In Laravel 5.5 and above the package will autoregister the service provider.
In Laravel 5.4 you must install this service provider:
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.
Users
- List users
- Get user
- Create user
- Update user
- Delete user
List users
List all registered users.
Request Body
None
Example Response
Create user
Create a new users who can access the CMS.
Request Body
Parameter | Required | Type | Description |
---|---|---|---|
name |
Yes | string |
The name of the user |
email |
Yes | string |
The email address of the user |
username |
Yes | string |
A username which will be used to login to the CMS |
password |
Yes | string |
A password which will be used to login to the CMS |
Example Response
Returns the details of the newly created user. See single user response example.
Get user
Get the details of a specific user.
Request Body
None
Example Response
Update user
Update the details of a specific user.
Request Body
Parameter | Required | Type | Description |
---|---|---|---|
name |
Yes | string |
The name of the user |
email |
Yes | string |
The email address of the user |
username |
Yes | string |
A username which will be used to login to the CMS |
password |
No | string |
A password which will be used to login to the CMS |
Example Response
Returns the details of the updated user. See single user response example.
Delete user
Delete a user so they can no longer access the CMS.
Request Body
None
Example Response
The HTTP status code will be 204
if successful.
License
The MIT License (MIT). Please see License File for more information.