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

# Admin: Get Group Details

## Endpoint

`/api/admin/groups/get`

## Method

GET

## Description

Returns the details for a group.

## Authentication

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

## Permissions

Administration: View

## Parameters

| Name | Type | Required | Conditional | Description |
|------|------|----------|-------------|-------------|
| `token` | string | Yes | No | The session token generated by the `login` or the `createToken` call. |
| `node` | string | No | No | The node domain name for which the API call is intended. When unspecified, the current node is used. Can only be used when Clustering is initialized. |
| `group` | string | Yes | No | The name of the group. |
| `includeUsers` | boolean | No | No | Set `true` to include a list of all available users in the response. |

## Response Fields

| Field | Type | Description |
|-------|------|-------------|
| `name` | string | The name of the group. |
| `description` | string | The description of the group. |
| `members` | array of strings | List of usernames that are members of this group. |
| `users` | array of strings | List of all available usernames in the system (only present when `includeUsers=true`). |

## Conditional Logic Notes

- The `users` field is only present in the response when `includeUsers` is set to `true`.
- The `node` parameter is only functional when Clustering is initialized.

## Edge Cases

- The `members` field shows users belonging to this group, while the `users` field (when requested) shows all users in the system regardless of group membership.