Group

A group.

Create a group

Create a new group.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing group information.

name
required
string <= 1000 characters

The name of the group.

status
integer
Default: 0

The status of the group.

  • 0 - Disabled
  • 1 - Active
Enum: 0 1
Responses
201

Successful operation

422

Unprocessable Content

post/group
Request samples
application/json
{
  • "name": "Admin group"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "0b46056f0523eff8471c66498aa56c6301a652c4",
  • "data": {
    },
  • "timestamp": 1661422671546
}

Get all groups

Get all groups of the authenticated hub.

SecurityJWT
Request
query Parameters
page
integer
Default: 1

The page number of the response.

Responses
200

Successful operation

get/group
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "88edf5a107033a8bc38a5020b9b377d44c3514e1",
  • "data": [
    ],
  • "meta": {
    },
  • "timestamp": 1661423258998
}
Get a group
Get a group.


SecurityJWT 
Request 
path Parameters
group
required
string or integer
The id/hash of the group.


 
Responses 
200
Successful operation


404
Not Found


get/group/{group}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "88edf5a107033a8bc38a5020b9b377d44c3514e1",
  • "data": {
    },
  • "timestamp": 1661428008616
}
Update a group
Update a group.


SecurityJWT 
Request 
path Parameters
group
required
string or integer
The id/hash of the group.


 
Request Body schema: application/json
A JSON object containing group information.


name
string  <= 1000 characters 
The name of the group.


 
status
integer
The status of the group.


    

  • 0 - Disabled
    • 

  • 1 - Active
    • 



 Enum: 0 1  
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/group/{group}
Request samples 
application/json
{
  • "status": 1
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "55ea7caa9d9732a9bf1e783b6d623deb6cf4baa7",
  • "data": {
    },
  • "timestamp": 1661428298409
}
Delete a group
Delete a group.


SecurityJWT 
Request 
path Parameters
group
required
string or integer
The id/hash of the group.


 
Responses 
200
Successful operation


404
Not Found


delete/group/{group}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1661428679500
}
Restore a group
Restore a group and all elements that have been deleted with the group.


SecurityJWT 
Request 
path Parameters
group
required
string or integer
The id/hash of the group.


 
Responses 
200
Successful operation


404
Not Found


put/group/{group}/restore
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1661428967806
}
➔ Next to Group measure permission