Group endpoints
Base URL: /tenants/{tenantName}/groups
Get by id
Get specific group by integer ID.
URL: /tenants/{tenantName}/groups/{groupId}
Method: GET
Parameters:
| Name | Type | Required | Description |
| tenantName | String | Yes | The name of the tenant |
| groupId | Integer (int32) | Yes | The id of the group to retrieve |
Responses:
| Status code | Status Description |
| 200 | Successful operations |
| 400 | Invalid input |
| 401 | Unauthorised |
| 403 | Permission denied |
| 404 | Not found |
Response body
{
id: integer (int32)
name: string
subscriptionLength: integer (int32) in months
}
Create group
Creates a new group.
URL: /tenants/{tenantName}/groups
Method: POST
Parameters:
| Name | Type | Required | Description |
| tenantName | String | Yes | The name of the tenant |
Request body
{
name: string
subscriptionLength: integer (int32) in months
}
Responses:
| Status code | Status Description |
| 200 | Successful operations |
| 400 | Invalid input |
| 401 | Unauthorised |
| 403 | Permission denied |
Response body
{
id: integer (int32)
name: string
subscriptionLength: integer (int32) in months
}
Update group
Updates an existing group.
URL: /tenants/{tenantName}/groups/{groupId}
Method: PUT
Parameters:
| Name | Type | Required | Description |
| tenantName | String | Yes | The name of the tenant |
| groupId | Integer (int32) | Yes | The id of the group to update |
Request body
{
name: string
subscriptionLength: integer (int32) in months
}
Responses:
| Status code | Status Description |
| 200 | Successful operations |
| 400 | Invalid input |
| 401 | Unauthorised |
| 403 | Permission denied |
| 404 | Not found |
Response body
{
id: integer (int32)
name: string
subscriptionLength: integer (int32) in months
}
Delete group
Deletes an existing group where found.
URL: /tenants/{tenantName}/groups/{groupId}
Method: DELETE
Parameters:
| Name | Type | Required | Description |
| tenantName | String | Yes | The name of the tenant |
| groupId | Integer (int32) | Yes | The id of the group to delete |
Responses:
| Status code | Status Description |
| 200 | Successful operations |
| 400 | Invalid input |
| 401 | Unauthorised |
| 403 | Permission denied |
| 404 | Not found |