Skip to content

Commit 1e4f07d

Browse files
committed
docs(adt): add
1 parent 52cafda commit 1e4f07d

File tree

7 files changed

+93
-96
lines changed

7 files changed

+93
-96
lines changed
Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,20 @@
11
---
2-
macro: audit-trail-iam-endpoints
2+
macro: adt-iam-endpoints
33
---
44

5-
### Supported endpoints
5+
<Concept>
6+
## IAM
67

7-
The following IAM endpoints are supported and will be logged in Audit Trail:
8+
### IAM supported endpoints
89

9-
- CreateSSHKey (`POST /iam/v1alpha1/ssh-keys`)
10-
- UpdateSSHKey (`PATCH /iam/v1alpha1/ssh-keys/{ssh_key_id}`)
11-
- DeleteSSHKey
10+
The following IAM endpoints are supported and will be logged in Audit Trail:
1211

13-
### Non supported endpoints
12+
- CreateSSHKey (`POST /iam/v1alpha1/ssh-keys`)
13+
- UpdateSSHKey (`PATCH /iam/v1alpha1/ssh-keys/{ssh_key_id}`)
14+
- DeleteSSHKey (`DELETE /iam/v1alpha1/ssh-keys/{ssh_key_id}`)
1415

15-
The following IAM endpoints are not supported and will not be logged in Audit Trail:
16+
### Additional information
1617

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.
18+
- When a Scaleway Organization is created, default policies and groups are automatically generated. These actions are logged in Audit Trail.
19+
- Invitations to join a Scaleway Organization expire after seven days. On day seven, the user is removed, and this action is logged in Audit Trail.
20+
</Concept>
Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,22 @@
11
---
2-
macro: audit-trail-key-manager-endpoints
2+
macro: adt-key-manager-endpoints
33
---
44

5-
### Supported endpoints
5+
<Concept>
6+
## Key Manager
67

7-
The following Key Manager endpoints are supported and will be logged in Audit Trail:
8+
### Key Manager supported endpoints
89

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`)
10+
The following Key Manager endpoints are supported and will be logged in Audit Trail:
1911

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`)
12+
- CreateKey (`POST /key-manager/v1alpha1/regions/{region}/keys`)
13+
- UpdateKey (`PATCH /key-manager/v1alpha1/regions/{region}/keys/{key_id}`)
14+
- DeleteKey (`DELETE /key-manager/v1alpha1/regions/{region}/keys/{key_id}`)
15+
- ProtectKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/protect`)
16+
- UnprotectKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/unprotect`)
17+
- RotateKey (Manual rotation) (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/rotate`)
18+
- DisableKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/disable`)
19+
- EnableKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/enable`)
20+
- ImportKeyMaterial (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/import-key-material`)
21+
- DeleteKeyMaterial (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/delete-key-material`)
22+
</Concept>
Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,22 @@
11
---
2-
macro: audit-trail-kubernetes-endpoints
2+
macro: adt-kubernetes-endpoints
33
---
44

5-
### Supported endpoints
5+
<Concept>
6+
## Kubernetes
67

7-
The following Kubernetes endpoints are supported and will be logged in Audit Trail:
8+
### Kubernetes supported endpoints
89

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`)
10+
The following Kubernetes endpoints are supported and will be logged in Audit Trail:
1911

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`)
12+
- CreateKey (`POST /key-manager/v1alpha1/regions/{region}/keys`)
13+
- UpdateKey (`PATCH /key-manager/v1alpha1/regions/{region}/keys/{key_id}`)
14+
- DeleteKey (`DELETE /key-manager/v1alpha1/regions/{region}/keys/{key_id}`)
15+
- ProtectKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/protect`)
16+
- UnprotectKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/unprotect`)
17+
- RotateKey (Manual rotation) (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/rotate`)
18+
- DisableKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/disable`)
19+
- EnableKey (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/enable`)
20+
- ImportKeyMaterial (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/import-key-material`)
21+
- DeleteKeyMaterial (`POST /key-manager/v1alpha1/regions/{region}/keys/{key_id}/delete-key-material`)
22+
</Concept>
Lines changed: 17 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,23 @@
11
---
2-
macro: audit-trail-secret-manager-endpoints
2+
macro: adt-secret-manager-endpoints
33
---
44

5-
### Supported endpoints
5+
<Concept>
6+
## Secret Manager
67

7-
The following Secret Manager endpoints are supported and will be logged in Audit Trail:
8+
### Secret Manager supported endpoints
89

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`)
10+
The following Secret Manager endpoints are supported and will be logged in Audit Trail:
2011

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`)
12+
- Create a secret (`POST /secret-manager/v1beta1/regions/{region}/secrets`)
13+
- Update metadata of a secret (`PATCH /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}`)
14+
- Delete a secret (`DELETE /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}`)
15+
- Allow a product to use the secret (`POST /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/add-owner`)
16+
- Enable secret protection (`POST /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/protect`)
17+
- Disable secret protection (`POST /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/unprotect`)
18+
- Create a version (`/secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions`)
19+
- Update metadata of a version (`PATCH /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions/{revision}`)
20+
- Delete a version (`DELETE /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions/{revision}`)
21+
- Disable a version (`POST /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions/{revision}/disable`)
22+
- Enable a version (`POST /secret-manager/v1beta1/regions/{region}/secrets/{secret_id}/versions/{revision}/disable`)
23+
</Concept>

menu/navigation.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -516,6 +516,10 @@
516516
{
517517
"label": "Audit Trail product integration",
518518
"slug": "resource-integration-with-adt"
519+
},
520+
{
521+
"label": "Supported endpoints for Audit Trail",
522+
"slug": "adt-supported-endpoints"
519523
}
520524
],
521525
"label": "Additional Content",
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
meta:
3+
title: Supported endpoints for Audit Trail
4+
description: Discover current Scaleway product integrations and endpoints supported in Audit Trail for event tracking.
5+
content:
6+
h1: Supported endpoints for Audit Trail
7+
paragraph: Discover current Scaleway product integrations and endpoints supported in Audit Trail for event tracking.
8+
tags: audit-trail product-integration products endpoints
9+
dates:
10+
validation: 2025-03-20
11+
posted: 2025-03-20
12+
categories:
13+
- identity-and-access-management
14+
---
15+
16+
This page provides information on the specific endpoints logged in [Audit Trail](/audit-trail/) for Scaleway products. Refer to the [dedicated documentation](/audit-trail/reference-content/resource-integration-with-adt/) for a list of Scaleway products integrated with Audit Trail.
17+
18+
19+
<Macro id="adt-iam-endpoints" />
20+
21+
22+
<Macro id="adt-key-manager-endpoints" />
23+
24+
25+
<Macro id="adt-kubernetes-endpoints" />
26+
27+
28+
<Macro id="adt-secret-manager-endpoints" />

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

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,6 @@ The following table provides details about the Scaleway products that are integr
2525
| Secret Manager | **Integrated** |
2626

2727

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-
4028
## Planned product integration
4129

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

0 commit comments

Comments
 (0)