Sign in
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

Changes

Changed in 3 of the 11 revisions of this API.884

  • a4a2ca9fb3af35See the full diff
    • ▲

      added the new required request property allowed_incomings

      new-required-request-property

    • ▲

      added the new required request property allowed_outgoings

      new-required-request-property

    • ▲

      added the new required request property note

      new-required-request-property

    • ●

      removed the request property confirm-password

      request-property-removed

    • ●

      removed the request property email

      request-property-removed

    • ●

      removed the request property group_name

      request-property-removed

    • ●

      removed the request property is_admin

      request-property-removed

    • ●

      removed the request property password

      request-property-removed

  • 1b51dd9ab58f2See the full diff
    • ○

      api tag group added

      api-tag-added

    • ○

      api tag todo removed

      api-tag-removed

  • fafd43b82c78532See the full diff
    • ▲

      added the new required request property confirm-password

      new-required-request-property

    • ▲

      added the new required request property email

      new-required-request-property

    • ▲

      added the new required request property group_name

      new-required-request-property

    • ▲

      added the new required request property is_admin

      new-required-request-property

    • ▲

      added the new required request property password

      new-required-request-property

    • ●

      removed the request property allowed_incomings

      request-property-removed

    • ●

      removed the request property allowed_outgoings

      request-property-removed

    • ●

      removed the request property note

      request-property-removed

    • ○

      api tag todo added

      api-tag-added

    • ○

      api tag group removed

      api-tag-removed

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog