Skip to content

Commit 52cafda

Browse files
committed
docs(adt): add endpoint macros
1 parent 4a553af commit 52cafda

File tree

5 files changed

+125
-2
lines changed

5 files changed

+125
-2
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
macro: audit-trail-iam-endpoints
3+
---
4+
5+
### Supported endpoints
6+
7+
The following IAM endpoints are supported and will be logged in Audit Trail:
8+
9+
- CreateSSHKey (`POST /iam/v1alpha1/ssh-keys`)
10+
- UpdateSSHKey (`PATCH /iam/v1alpha1/ssh-keys/{ssh_key_id}`)
11+
- DeleteSSHKey
12+
13+
### Non supported endpoints
14+
15+
The following IAM endpoints are not supported and will not be logged in Audit Trail:
16+
17+
- ListSSHKeys (`GET /iam/v1alpha1/ssh-keys`)
18+
- GeSSHKey (`GET /iam/v1alpha1/ssh-keys/{ssh_key_id}`)
19+
20+
### Additional information
21+
22+
- At the creation of the Organization, default policies and groups are created. These actions are logged in Audit Trail.
23+
24+
- Invitation expire after 7 days. At D+7, the user is removed and the creation is logged.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
macro: audit-trail-key-manager-endpoints
3+
---
4+
5+
### Supported endpoints
6+
7+
The following Key Manager endpoints are supported and will be logged in Audit Trail:
8+
9+
- CreateKey (`POST /key-manager/v1alpha1/regions/{region}/keys`)
10+
- UpdateKey (`PATCH /key-manager/v1alpha1/regions/{region}/keys/{key_id}`)
11+
- DeleteKey (`DELETE /key-manager/v1alpha1/regions/{region}/keys/{key_id}`)
12+
- ProtectKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/protect`)
13+
- UnprotectKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/unprotect`)
14+
- RotateKey (Manual rotation) (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/rotate`)
15+
- DisableKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/disable`)
16+
- EnableKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/enable`)
17+
- ImportKeyMaterial (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/import-key-material`)
18+
- DeleteKeyMaterial (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/delete-key-material`)
19+
20+
### Non supported endpoints
21+
22+
The following Key Manager endpoints are not supported and will not be logged in Audit Trail:
23+
24+
- ListKeys (`GET /key-manager/v1alpha1/regions/{region}/keys`)
25+
- GetKey (`GET /key-manager/v1alpha1/regions/{region}/keys/{key_id}`)
26+
- GenerateDataKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/generate-data-key`)
27+
- Encrypt (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/encrypt`)
28+
- Decrypt (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/decrypt`)
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
macro: audit-trail-kubernetes-endpoints
3+
---
4+
5+
### Supported endpoints
6+
7+
The following Kubernetes endpoints are supported and will be logged in Audit Trail:
8+
9+
- CreateKey (`POST /key-manager/v1alpha1/regions/{region}/keys`)
10+
- UpdateKey (`PATCH /key-manager/v1alpha1/regions/{region}/keys/{key_id}`)
11+
- DeleteKey (`DELETE /key-manager/v1alpha1/regions/{region}/keys/{key_id}`)
12+
- ProtectKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/protect`)
13+
- UnprotectKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/unprotect`)
14+
- RotateKey (Manual rotation) (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/rotate`)
15+
- DisableKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/disable`)
16+
- EnableKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/enable`)
17+
- ImportKeyMaterial (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/import-key-material`)
18+
- DeleteKeyMaterial (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/delete-key-material`)
19+
20+
### Non supported endpoints
21+
22+
The following Kubernetes endpoints are not supported and will not be logged in Audit Trail:
23+
24+
- ListKeys (`GET /key-manager/v1alpha1/regions/{region}/keys`)
25+
- GetKey (`GET /key-manager/v1alpha1/regions/{region}/keys/{key_id}`)
26+
- GenerateDataKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/generate-data-key`)
27+
- Encrypt (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/encrypt`)
28+
- Decrypt (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/decrypt`)
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
macro: audit-trail-secret-manager-endpoints
3+
---
4+
5+
### Supported endpoints
6+
7+
The following Secret Manager endpoints are supported and will be logged in Audit Trail:
8+
9+
- Create a secret (`POST /secret-manager/v1beta1/regions/{region}/secrets`)
10+
- Update metadata of a secret (`PATCH /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}`)
11+
- Delete a secret (`DELETE /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}`)
12+
- Allow a product to use the secret (`POST /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/add-owner`)
13+
- Enable secret protection (`POST /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/protect`)
14+
- Disable secret protection (`POST /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/unprotect`)
15+
- Create a version (`/secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions`)
16+
- Update metadata of a version (`PATCH /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions/{revision}`)
17+
- Delete a version (`DELETE /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions/{revision}`)
18+
- Disable a version (`POST /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions/{revision}/disable`)
19+
- Enable a version (`POST /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions/{revision}/disable`)
20+
21+
### Non supported endpoints
22+
23+
The following Secret Manager endpoints are not supported and will not be logged in Audit Trail:
24+
25+
- List secrets (Listing page) (`GET /secret-manager/v1beta1/regions/{region}/secrets`)
26+
- Get metadata using the secret's ID (Overview) (`GET /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}`)
27+
- List versions of a secret using the secret's ID (List versions of a secret without seing the payload) (`GET /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions`)
28+
- Get metadata of a secret's version using the secret's ID (Overview) (`GET /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions/{revision}`)
29+
- Access a secret's version using the secret's ID (`GET /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions/{revision}/access`)
30+
- Access a secret's version using the secret's name and path (`GET /secret-manager/v1beta1/regions/{region}/secrets-by-path/versions/{revision}/access`)

pages/audit-trail/reference-content/resource-integration-with-adt.mdx

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,32 @@ The following table provides details about the Scaleway products that are integr
1717

1818
## Product integration available
1919

20-
| **Product Name** | **Audit Trail Integration** |
20+
| **Product name** | **Audit Trail integration** |
2121
|----------------------------|---------------------------------|
2222
| IAM | **Integrated** |
2323
| Key Manager | **Integrated** |
2424
| Kubernetes | **Integrated** |
2525
| Secret Manager | **Integrated** |
2626

27+
28+
## Key Manager
29+
30+
<Macro id="audit-trail-key-manager-endpoints" />
31+
32+
## Kubernetes
33+
34+
<Macro id="audit-trail-kubernetes-endpoints" />
35+
36+
## Secret Manager
37+
38+
<Macro id="audit-trail-secret-manager-endpoints" />
39+
2740
## Planned product integration
2841

2942
The following table provides details about the Scaleway products that will be integrated with Audit Trail.
3043

3144

32-
| **Product Name** | **Audit Trail Integration** |
45+
| **Product name** | **Audit Trail integration** |
3346
|----------------------------|---------------------------------|
3447
| Object Storage | **Not integrated yet** |
3548
| Billing | **Not integrated yet** |

0 commit comments

Comments
 (0)