Skip to content

Commit 7a40d76

Browse files
defguard-communitygitbook-bot
authored andcommitted
GITBOOK-462: change request with no subject merged in GitBook
1 parent 04d1ed2 commit 7a40d76

File tree

19 files changed

+43
-52
lines changed

19 files changed

+43
-52
lines changed

SUMMARY.md

Lines changed: 21 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,6 @@
3535
* [Django](admin-and-features/openid-connect/django.md)
3636
* [MinIO](admin-and-features/openid-connect/minio.md)
3737
* [Vault](admin-and-features/openid-connect/vault.md)
38-
* [LDAP and Active Directory integration](admin-and-features/ldap-and-active-directory-integration/README.md)
39-
* [Configuration](admin-and-features/ldap-and-active-directory-integration/configuration.md)
40-
* [Settings table](admin-and-features/ldap-and-active-directory-integration/settings-table.md)
41-
* [Two-way LDAP and Active Directory synchronization](admin-and-features/ldap-and-active-directory-integration/two-way-ldap-and-active-directory-synchronization.md)
42-
* [Access Control List](admin-and-features/access-control-list/README.md)
43-
* [ACL Aliases](admin-and-features/access-control-list/acl-aliases.md)
44-
* [Implementation Details](admin-and-features/access-control-list/firewall-internals.md)
4538
* [External OpenID providers](admin-and-features/external-openid-providers/README.md)
4639
* [Google](admin-and-features/external-openid-providers/google.md)
4740
* [Microsoft](admin-and-features/external-openid-providers/microsoft.md)
@@ -51,27 +44,31 @@
5144
* [Okta](admin-and-features/external-openid-providers/okta.md)
5245
* [Custom](admin-and-features/external-openid-providers/custom.md)
5346
* [External OIDC secure enrollment](admin-and-features/external-openid-providers/external-oidc-secure-enrollment.md)
47+
* [LDAP and Active Directory integration](admin-and-features/ldap-and-active-directory-integration/README.md)
48+
* [Configuration](admin-and-features/ldap-and-active-directory-integration/configuration.md)
49+
* [Settings table](admin-and-features/ldap-and-active-directory-integration/settings-table.md)
50+
* [Two-way LDAP and Active Directory synchronization](admin-and-features/ldap-and-active-directory-integration/two-way-ldap-and-active-directory-synchronization.md)
51+
* [Access Control List](admin-and-features/access-control-list/README.md)
52+
* [ACL Aliases](admin-and-features/access-control-list/acl-aliases.md)
53+
* [Implementation Details](admin-and-features/access-control-list/firewall-internals.md)
54+
* [Network devices](admin-and-features/network-devices.md)
55+
* [Activity & Audit logs](admin-and-features/activity-log/README.md)
56+
* [Audit Log Streaming to SIEM systems](admin-and-features/activity-log/activity-log-streaming/README.md)
57+
* [Supported SIEM systems integrations](admin-and-features/activity-log/activity-log-streaming/activity-log-integrations/README.md)
58+
* [Vector integration guide](admin-and-features/activity-log/activity-log-streaming/activity-log-integrations/vector-integration-guide.md)
59+
* [Logstash integration guide](admin-and-features/activity-log/activity-log-streaming/activity-log-integrations/logstash-integration-guide.md)
60+
* [Notifications](admin-and-features/notifications/README.md)
61+
* [Email notifications](admin-and-features/notifications/setting-up-smtp-for-email-notifications.md)
62+
* [Gateway notifications](admin-and-features/notifications/gateway-notifications.md)
63+
* [New version notifications](admin-and-features/notifications/new-version-notifications.md)
64+
* [Integrations](admin-and-features/integrations/README.md)
65+
* [Webhooks](admin-and-features/integrations/webhooks.md)
66+
* [REST API](admin-and-features/integrations/api-tokens.md)
5467
* [OPSense Configuartion](admin-and-features/setting-up-your-instance/gateway/README.md)
5568
* [SSH Authentication](admin-and-features/ssh-authentication.md)
5669
* [Forward auth](admin-and-features/forward-auth.md)
5770
* [YubiKey Provisioning](admin-and-features/yubikey-provisioning.md)
58-
* [Network devices](admin-and-features/network-devices.md)
59-
60-
***
61-
62-
* [Activity & Audit logs](activity-log/README.md)
63-
* [Audit Log Streaming to SIEM systems](activity-log/activity-log-streaming/README.md)
64-
* [Supported SIEM systems integrations](activity-log/activity-log-streaming/activity-log-integrations/README.md)
65-
* [Vector integration guide](activity-log/activity-log-streaming/activity-log-integrations/vector-integration-guide.md)
66-
* [Logstash integration guide](activity-log/activity-log-streaming/activity-log-integrations/logstash-integration-guide.md)
67-
* [Notifications](notifications/README.md)
68-
* [Email notifications](notifications/setting-up-smtp-for-email-notifications.md)
69-
* [Gateway notifications](notifications/gateway-notifications.md)
70-
* [New version notifications](notifications/new-version-notifications.md)
71-
* [Integrations](integrations/README.md)
72-
* [Webhooks](integrations/webhooks.md)
73-
* [REST API](integrations/api-tokens.md)
74-
* [User SNAT bindings](user-snat-bindings.md)
71+
* [User SNAT bindings](admin-and-features/user-snat-bindings.md)
7572

7673
## Deployment strategies
7774

activity-log/README.md renamed to admin-and-features/activity-log/README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Activity log is available as a dedicated page in Defguard core Web UI that's use
1212

1313
To access it click the `Activity log` button in the navbar.
1414

15-
<figure><img src="../.gitbook/assets/image.png" alt=""><figcaption><p>Activity log page</p></figcaption></figure>
15+
<figure><img src="../../.gitbook/assets/image.png" alt=""><figcaption><p>Activity log page</p></figcaption></figure>
1616

1717
### Overview
1818

@@ -33,16 +33,16 @@ Events are grouped into modules based on the part of the system they are related
3333

3434
Currently there are four modules:
3535

36-
* **Defguard** - operations performed in the core Web UI (e.g. adding users, modifying devices, managing groups etc.)&#x20;
36+
* **Defguard** - operations performed in the core Web UI (e.g. adding users, modifying devices, managing groups etc.)
3737
* **Client** - actions performed by desktop client applications
38-
* **Enrollment** - events related to the [user enrollment](../help/enrollment/) process
38+
* **Enrollment** - events related to the [user enrollment](../../help/enrollment/) process
3939
* **VPN -** events related to VPN clients (e.g. client connecting to a location)
4040

4141
### Filtering
4242

43-
<figure><img src="../.gitbook/assets/image (1).png" alt=""><figcaption><p>Event filter modal</p></figcaption></figure>
43+
<figure><img src="../../.gitbook/assets/image (1).png" alt=""><figcaption><p>Event filter modal</p></figcaption></figure>
4444

45-
By clicking the `Filter` button above the list you can narrow down the displayed events based on following criteria:&#x20;
45+
By clicking the `Filter` button above the list you can narrow down the displayed events based on following criteria:
4646

4747
* Event
4848
* Module
@@ -52,11 +52,11 @@ For each of those you can select multiple options.
5252

5353
Filtering by date can be done by clicking the `Time range` button above the list.
5454

55-
<figure><img src="../.gitbook/assets/image (2).png" alt=""><figcaption><p>Time range filter modal</p></figcaption></figure>
55+
<figure><img src="../../.gitbook/assets/image (2).png" alt=""><figcaption><p>Time range filter modal</p></figcaption></figure>
5656

5757
### Sorting
5858

59-
By default the Activity log is sorted in reverse chronological order (most recent event on top).&#x20;
59+
By default the Activity log is sorted in reverse chronological order (most recent event on top).
6060

6161
To change the order you can click on the header of the `Date` column.
6262

@@ -169,4 +169,3 @@ At the moment following events are tracked in the Activity log:
169169
## Streaming to external SIEM systems
170170

171171
Please note, that enterprise version supports streaming of audit logs to e[xternal SIEM systems. More on this topic in dedicated documentation section](activity-log-streaming/).
172-

activity-log/activity-log-streaming/README.md renamed to admin-and-features/activity-log/activity-log-streaming/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: >-
88
# Audit Log Streaming to SIEM systems
99

1010
{% hint style="warning" %}
11-
This is an enterprise feature. To use it, purchase our [enterprise license](../../enterprise/license.md) or ensure that your deployment does not exceed the [usage limits](../../enterprise/license.md#enterprise-is-free-up-to-certain-limits).
11+
This is an enterprise feature. To use it, purchase our [enterprise license](../../../enterprise/license.md) or ensure that your deployment does not exceed the [usage limits](../../../enterprise/license.md#enterprise-is-free-up-to-certain-limits).
1212
{% endhint %}
1313

1414
{% hint style="info" %}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

integrations/api-tokens.md renamed to admin-and-features/integrations/api-tokens.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# REST API
22

33
{% hint style="warning" %}
4-
This is an enterprise feature. To use it, purchase our [enterprise license](../enterprise/license.md) or ensure that your deployment does not exceed the [usage limits](../enterprise/license.md#enterprise-is-free-up-to-certain-limits).
4+
This is an enterprise feature. To use it, purchase our [enterprise license](../../enterprise/license.md) or ensure that your deployment does not exceed the [usage limits](../../enterprise/license.md#enterprise-is-free-up-to-certain-limits).
55
{% endhint %}
66

77
{% hint style="warning" %}
88
API functionality:
99

1010
1. requires Defguard version 1.2.4+
11-
2. is also **available without enterprise license**, if your instance does not exceed the limits [described here](../enterprise/license.md#enterprise-is-free-up-to-certain-limits).
11+
2. is also **available without enterprise license**, if your instance does not exceed the limits [described here](../../enterprise/license.md#enterprise-is-free-up-to-certain-limits).
1212
{% endhint %}
1313

1414
## REST API documentation
1515

16-
You can explore the Defguard REST API using [Swagger UI](https://swagger.io/tools/swagger-ui/) by going to `<YOUR_DEFGUARD_URL>/api-docs`.
16+
You can explore the Defguard REST API using [Swagger UI](https://swagger.io/tools/swagger-ui/) by going to `<YOUR_DEFGUARD_URL>/api-docs`.
1717

1818
API specification JSON in OpenAPI format can also be fetched from `<YOUR_DEFGUARD_URL>/api/v1/api-docs`.
1919

@@ -27,19 +27,19 @@ Tokens retain the same access permissions as their owner, so be careful when sha
2727

2828
To generate a new API token go to your profile page and click the `Add new API Token`button:
2929

30-
<figure><img src="../.gitbook/assets/image (62).png" alt=""><figcaption></figcaption></figure>
30+
<figure><img src="../../.gitbook/assets/image (62).png" alt=""><figcaption></figcaption></figure>
3131

3232
Fill in your chosen token name and submit form:
3333

34-
<figure><img src="../.gitbook/assets/image (64).png" alt=""><figcaption></figcaption></figure>
34+
<figure><img src="../../.gitbook/assets/image (64).png" alt=""><figcaption></figcaption></figure>
3535

3636
Copy generated token. This is the only time the token will be available in plain text form. If you lose it you will have to generate a new one.
3737

38-
<figure><img src="../.gitbook/assets/image (65).png" alt=""><figcaption></figcaption></figure>
38+
<figure><img src="../../.gitbook/assets/image (65).png" alt=""><figcaption></figcaption></figure>
3939

4040
In the API token list you can later rename or delete a token:
4141

42-
<figure><img src="../.gitbook/assets/image (66).png" alt=""><figcaption></figcaption></figure>
42+
<figure><img src="../../.gitbook/assets/image (66).png" alt=""><figcaption></figcaption></figure>
4343

4444
## Usage
4545

@@ -56,8 +56,3 @@ Example GET request:
5656
```bash
5757
curl -H "Authorization: Bearer <token>" <YOUR_DEFGUARD_URL>/api/v1/me
5858
```
59-
60-
61-
62-
63-
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)