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

OAuth2

Security scheme type: oauth2

Flow type: password

Token URL: https://auth.4hse.com/realms/4hse/protocol/openid-connect/token

AccessToken

Security scheme type: apiKey

Query parameter name: access-token

Operations

index

POST

/v2/group/index

Returns a paginated and filterable list of groups.
Use POST to allow complex filters via JSON payload.

Authorizations

• OAuth2
• AccessToken

Request Body

Parameters for searching groups

object

entity_id

required

The ID of the entity to which the group belongs.

string

filter

object

group_id

string

name

string

description

string

status

string

created_at

integer

updated_at

integer

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

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

string

history

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.

boolean

Example

{
  "filter": {
    "name": "Safety Group"
  },
  "per-page": 10,
  "page": 1,
  "sort": "name"
}

Responses

200

List of groups

Array<object>

object

group_id

string

name

string

description

string

status

string

created_at

integer

updated_at

integer

Example

{
  "group_id": "grp-1",
  "name": "Safety Group",
  "description": "Group for safety team",
  "status": "active",
  "created_at": 1700000000,
  "updated_at": 1700000001
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

view

GET

/v2/group/view/{id}

Retrieve a group by its unique ID.

Authorizations

• OAuth2
• AccessToken

Path Parameters

id

required

string format: uuid

ID of the group to retrieve

Responses

200

Group found

object

group_id

string

name

string

description

string

status

string

created_at

integer

updated_at

integer

Example

{
  "group_id": "grp-1",
  "name": "Safety Group",
  "description": "Group for safety team",
  "status": "active",
  "created_at": 1700000000,
  "updated_at": 1700000001
}

404

Group not found