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: List Users

## Endpoint

`/api/admin/users/list`

## Method

GET

## Description

Returns a list of all users.

## 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. |

## Response Fields

| Field | Type | Description |
|-------|------|-------------|
| `users` | array | List of user objects. |
| `users[].displayName` | string | The display name of the user. |
| `users[].username` | string | The username of the user account. |
| `users[].disabled` | boolean | Whether the user account is disabled. |
| `users[].previousSessionLoggedOn` | string (datetime) | ISO 8601 timestamp of the previous session login. |
| `users[].previousSessionRemoteAddress` | string | IP address from the previous session login. |
| `users[].recentSessionLoggedOn` | string (datetime) | ISO 8601 timestamp of the most recent session login. |
| `users[].recentSessionRemoteAddress` | string | IP address from the most recent session login. |

## Conditional Logic Notes

- The `node` parameter is only functional when Clustering is initialized.

## Edge Cases

- Users who have never logged in will have `previousSessionLoggedOn` and `recentSessionLoggedOn` set to `0001-01-01T00:00:00Z` and the corresponding remote addresses set to `0.0.0.0`.