technitium 0.4.0

Typed async Rust client for the Technitium DNS Server API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

# Admin: Set Group Details

## Endpoint

`/api/admin/groups/set`

## Method

GET

## Description

Allows changing group description or renaming a group.

## Authentication

Required. Token must be provided via the `token` parameter.

## Permissions

Administration: Modify

## Parameters

| Name | Type | Required | Conditional | Description |
|------|------|----------|-------------|-------------|
| `token` | string | Yes | No | The session token generated by the `login` or the `createToken` call. |
| `group` | string | Yes | No | The name of the group to update. |
| `newGroup` | string | No | No | A new group name to rename the group. |
| `description` | string | No | No | A new group description. |
| `members` | string | No | No | A comma-separated list of usernames to set as the group's members. |

## Response Fields

| Field | Type | Description |
|-------|------|-------------|
| `name` | string | The (possibly updated) name of the group. |
| `description` | string | The description of the group. |
| `members` | array of strings | List of usernames that are members of this group. |

## Conditional Logic Notes

- The `members` parameter replaces the full member list; it is not additive. Omitting it leaves membership unchanged.
- Renaming a group via `newGroup` changes the group name across all references (permissions, user memberships, etc.).

## Edge Cases

- Setting `members` to an empty string would remove all members from the group.
- Renaming built-in groups (e.g., `Administrators`) may be restricted.