zuplo 6.72.2 → 6.72.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/articles/accounts/audit-logs.mdx +4 -4
- package/docs/articles/audit-logging.mdx +65 -0
- package/docs/articles/audit-logs.mdx +222 -0
- package/docs/articles/{custom-audit-log-policy.mdx → custom-audit-logs.mdx} +26 -22
- package/docs/policies/_index.md +1 -0
- package/docs/policies/audit-log-inbound/doc.md +16 -11
- package/docs/policies/authzen-inbound/schema.json +1 -1
- package/docs/policies/axiomatics-authz-inbound/schema.json +1 -1
- package/docs/policies/mtls-auth-inbound/intro.md +52 -5
- package/docs/policies/okta-fga-authz-inbound/schema.json +1 -1
- package/docs/policies/openfga-authz-inbound/schema.json +1 -1
- package/docs/policies/require-user-claims-inbound/doc.md +120 -0
- package/docs/policies/require-user-claims-inbound/intro.md +9 -0
- package/docs/policies/require-user-claims-inbound/schema.json +1323 -0
- package/docs/policies/semantic-cache-inbound/schema.json +1 -1
- package/docs/policies/upstream-gcp-federated-auth-inbound/schema.json +1 -1
- package/docs/programmable-api/overview.mdx +0 -7
- package/package.json +4 -4
- package/docs/programmable-api/audit-log.mdx +0 -74
|
@@ -124,13 +124,6 @@ about built-in request handlers.
|
|
|
124
124
|
|
|
125
125
|
## Plugins
|
|
126
126
|
|
|
127
|
-
### AuditLogPlugin
|
|
128
|
-
|
|
129
|
-
- **Status**: Documented ([Audit Log](./audit-log.mdx))
|
|
130
|
-
- **Description**: Comprehensive request/response logging
|
|
131
|
-
- **Key Features**: Configurable request/response capture, custom output
|
|
132
|
-
providers
|
|
133
|
-
|
|
134
127
|
### Logging Plugins
|
|
135
128
|
|
|
136
129
|
See [Logging documentation](/docs/articles/logging.mdx) for details on logging
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "zuplo",
|
|
3
|
-
"version": "6.72.
|
|
3
|
+
"version": "6.72.3",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "The programmable API Gateway",
|
|
6
6
|
"author": "Zuplo, Inc.",
|
|
@@ -19,9 +19,9 @@
|
|
|
19
19
|
"zuplo": "zuplo.js"
|
|
20
20
|
},
|
|
21
21
|
"dependencies": {
|
|
22
|
-
"@zuplo/cli": "6.72.
|
|
23
|
-
"@zuplo/core": "6.72.
|
|
24
|
-
"@zuplo/runtime": "6.72.
|
|
22
|
+
"@zuplo/cli": "6.72.3",
|
|
23
|
+
"@zuplo/core": "6.72.3",
|
|
24
|
+
"@zuplo/runtime": "6.72.3",
|
|
25
25
|
"@zuplo/test": "1.4.0"
|
|
26
26
|
}
|
|
27
27
|
}
|
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Audit Log Feature
|
|
3
|
-
sidebar_label: Audit Log
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
Zuplo has a built-in auditing feature that can write output to a selection of
|
|
7
|
-
data sinks.
|
|
8
|
-
|
|
9
|
-
If enabled, the Audit Log feature logs full details of
|
|
10
|
-
|
|
11
|
-
- The request including URL, headers (optional), and full body (optional)
|
|
12
|
-
- The response including status, headers (optional) and full body (optional)
|
|
13
|
-
|
|
14
|
-
These can then be written to a configured Audit Log Output Provider of your
|
|
15
|
-
choosing, like AstraDB by DataStax. Contact
|
|
16
|
-
[support@zuplo.com](mailto:support@zuplo.com) to request a new provider.
|
|
17
|
-
|
|
18
|
-
:::note
|
|
19
|
-
|
|
20
|
-
While you can use it on any tier in working-copy, the Audit Log capability is an
|
|
21
|
-
**enterprise** feature. Contact us to have Audit Logging enabled for your
|
|
22
|
-
enterprise deployment. [Pricing](https://zuplo.com/pricing)
|
|
23
|
-
|
|
24
|
-
:::
|
|
25
|
-
|
|
26
|
-
## Configuring Audit Log
|
|
27
|
-
|
|
28
|
-
Audit Logging is enabled via a plugin that's registered in the
|
|
29
|
-
`zuplo.runtime.ts` runtime extensions module;
|
|
30
|
-
[learn more about runtime extensions](./runtime-extensions.mdx). The following
|
|
31
|
-
example configures Audit Log to write to a DataStax Astra DB collection.
|
|
32
|
-
|
|
33
|
-
Note you must provide the full URL to the collection, for example
|
|
34
|
-
`https://<id-and-region>.apps.astra.datastax.com/api/rest/v2/namespaces/<namespace>/collections/<collection>`
|
|
35
|
-
|
|
36
|
-
```ts
|
|
37
|
-
import {
|
|
38
|
-
AuditLogDataStaxProvider,
|
|
39
|
-
AuditLogPlugin,
|
|
40
|
-
RuntimeExtensions,
|
|
41
|
-
} from "@zuplo/runtime";
|
|
42
|
-
|
|
43
|
-
export function runtimeInit(runtime: RuntimeExtensions) {
|
|
44
|
-
runtime.addPlugin(
|
|
45
|
-
new AuditLogPlugin(
|
|
46
|
-
new AuditLogDataStaxProvider({
|
|
47
|
-
url: "THE_FULL_URL_TO_YOUR_COLLECTION_HERE",
|
|
48
|
-
xCassandraToken: "YOUR_API_KEY_HERE",
|
|
49
|
-
}),
|
|
50
|
-
{
|
|
51
|
-
include: {
|
|
52
|
-
request: {
|
|
53
|
-
body: false,
|
|
54
|
-
},
|
|
55
|
-
response: {
|
|
56
|
-
headers: false,
|
|
57
|
-
},
|
|
58
|
-
},
|
|
59
|
-
},
|
|
60
|
-
),
|
|
61
|
-
);
|
|
62
|
-
}
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
Note the use of options to disable capture of the full request body and full
|
|
66
|
-
response headers.
|
|
67
|
-
|
|
68
|
-
:::tip
|
|
69
|
-
|
|
70
|
-
This feature logs API request and response data. For account-level activity
|
|
71
|
-
tracking (project changes, team management, deployments), see
|
|
72
|
-
[Account Audit Logs](../articles/accounts/audit-logs.mdx).
|
|
73
|
-
|
|
74
|
-
:::
|