User
Manage users, including registration, update, deletion, and advanced search.
Users can be linked to roles, groups, and permissions, and support metadata and filtering.
- Version
- 2.0.0
- OpenAPI version
- 3.0.0
Operations
Section titled “Operations” POST /v2/user/index
Returns a paginated and filterable list of users.
Use POST to allow complex filters via JSON payload.
Request Body
Section titled “Request Body ”Parameters for searching users
object
object
The unique identifier for the user.
The username of the user.
The email address of the user.
The current status of the user (e.g., active, inactive, etc.).
The timestamp when the user was created.
The timestamp when the user was last updated.
The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order
The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.
Example
{ "filter": { "username": "john.doe", "status": "active" }, "per-page": 10, "page": 1, "sort": "username"}Responses
Section titled “ Responses ”List of users
object
The unique identifier for the user.
The username of the user.
The email address of the user.
The current status of the user (e.g., active, inactive, etc.).
The timestamp when the user was created.
The timestamp when the user was last updated.
Example
{ "user_id": "user-1", "username": "john.doe", "email": "john.doe@example.com", "status": "active", "created_at": 1700000000, "updated_at": 1700000001}Headers
Section titled “Headers ”Current page
Total number of pages
Number of items per page
Total number of items
GET /v2/user/view/{id}
Retrieve a user by its unique ID.
Path Parameters
Section titled “Path Parameters ”ID of the user to retrieve
Responses
Section titled “ Responses ”User found
object
The unique identifier for the user.
The username of the user.
The email address of the user.
The current status of the user (e.g., active, inactive, etc.).
The timestamp when the user was created.
The timestamp when the user was last updated.
Example
{ "user_id": "user-1", "username": "john.doe", "email": "john.doe@example.com", "status": "active", "created_at": 1700000000, "updated_at": 1700000001}User not found
update
Section titled “update” PUT /v2/user/update/{id}
Update an existing user by its unique ID.
Path Parameters
Section titled “Path Parameters ”ID of the user to update
Request Body required
Section titled “Request Body required ”User object with updated data
object
The unique identifier for the user.
The username of the user.
The hashed password for the user.
The token used to reset the user’s password (optional).
The email address of the user.
The authentication key used for the user’s sessions.
The current status of the user (e.g., active, inactive, etc.).
The timestamp when the user was created.
The timestamp when the user was last updated.
The user’s password, which is write-only and not retrievable.
Example
{ "email": "john.doe@newmail.com", "status": "inactive"}Responses
Section titled “ Responses ”User updated successfully
object
The unique identifier for the user.
The username of the user.
The hashed password for the user.
The token used to reset the user’s password (optional).
The email address of the user.
The authentication key used for the user’s sessions.
The current status of the user (e.g., active, inactive, etc.).
The timestamp when the user was created.
The timestamp when the user was last updated.
The user’s password, which is write-only and not retrievable.
Example
{ "user_id": "user-1", "email": "john.doe@newmail.com", "status": "inactive"}User not found