v1

latestOpenAPI 3.0.02026-07-175652103.9 KB
group

Add a Group

This function is an API endpoint that allows an authenticated admin to add a new group. It is tagged with "group" for OpenAPI documentation..<br> Todo allow to use different team

Parameters

  • request: The request data, which includes the details of the group to be added. <br>

Returns

If successful, this function returns a Json<UsersResponse> object, which includes a success message, the total number of groups, and the list of groups. <br> If the admin is not authorized, this function returns a status::Unauthorized error. <br>

Errors

This function will return an error if the system is in maintenance mode, or if the admin is not authorized.

Example

POST /api/group {"name":"new group","password":"string","confirm-password":"string","email":"string","is_admin":false,"group_name":"string"}

post/api/group

Request body

namestring required
notestring required
allowed_outgoingsstring[] required
allowed_incomingsstring[] required

Response

msgstring required
totalinteger required
datastring required