Group
Manage groups, which represent logical collections of users or entities.
You can create, update, delete, and search for groups with advanced filtering and pagination.
- Version
- 2.0.0
- OpenAPI version
- 3.0.0
Authentication
Section titled “ Authentication ”OAuth2
Section titled “OAuth2 ”Security scheme type: oauth2
Flow type: password
Token URL: https://auth.4hse.com/realms/4hse/protocol/openid-connect/token
AccessToken
Section titled “AccessToken ”Security scheme type: apiKey
Query parameter name: access-token
Operations
Section titled “Operations” POST /v2/group/index
Returns a paginated and filterable list of groups.
Use POST to allow complex filters via JSON payload.
Authorizations
Section titled “Authorizations ”Request Body
Section titled “Request Body ”Parameters for searching groups
object
The ID of the entity to which the group belongs.
object
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": { "name": "Safety Group" }, "per-page": 10, "page": 1, "sort": "name"}Responses
Section titled “ Responses ”List of groups
object
Example
{ "group_id": "grp-1", "name": "Safety Group", "description": "Group for safety team", "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/group/view/{id}
Retrieve a group by its unique ID.
Authorizations
Section titled “Authorizations ”Path Parameters
Section titled “Path Parameters ”ID of the group to retrieve
Responses
Section titled “ Responses ”Group found
object
Example
{ "group_id": "grp-1", "name": "Safety Group", "description": "Group for safety team", "status": "active", "created_at": 1700000000, "updated_at": 1700000001}Group not found