User
This section contains all the information about the user endpoint.
Current user
This api return an active user information based on the given JWT token.
- URL:
/user/current - Method: GET
- Content-type: application/json
Requests description
| Keys/Fields | Mandatory | Criteria | Default | Description |
|---|---|---|---|---|
| Headers | ||||
Authorization | true | A JWT bearer token to authenticated users |
Lists
This api return a list of user records.
- URL:
/user - Method: GET
- Content type: application/json
- Body: json
Requests description
| Keys/Fields | Mandatory | Criteria | Default | Description |
|---|---|---|---|---|
| Headers | ||||
Authorization | true | A JWT bearer token to authenticated users | ||
| Body | ||||
uuid (int) | ||||
per_page (int) | 10 | Specifies the number of items to display per page. | ||
name (string) | search | Search full name. | ||
status (string) | filters | All | Accept Active or Inactive | |
created_at (string) | sorts | desc | Sort created at column desc or asc | |
updated_at (string) | sorts | |||
roles (string) | includes | Include the roles associate with users | ||
clients (string) | includes | Include the clients associate with users |
Single record
This api return a single user information base on the given UUID.
- URL:
/user/{uuid} - Method: GET
- Content type: application/json
Requests description
| Keys/Fields | Mandatory | Criteria | Default | Description |
|---|---|---|---|---|
| Headers | ||||
Authorization | true | A JWT bearer token to authenticated users | ||
| Params | ||||
uuid | true | A uuid associate with the user. |
Table of Contents