Skip to content

Commit e6ec752

Browse files
authored
audit-trail(add): iam authentication methods (#5589)
1 parent 48f5817 commit e6ec752

File tree

2 files changed

+95
-0
lines changed

2 files changed

+95
-0
lines changed

menu/navigation.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3763,6 +3763,10 @@
37633763
"label": "Audit Trail product integration",
37643764
"slug": "resource-integration-with-adt"
37653765
},
3766+
{
3767+
"label": "IAM authentication events in Audit Trail",
3768+
"slug": "iam-authentication-events"
3769+
},
37663770
{
37673771
"label": "Supported endpoints for Audit Trail",
37683772
"slug": "adt-supported-endpoints"
Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: IAM authentication events in Audit Trail
3+
description: Discover which IAM events are logged in Audit Trail and what they mean.
4+
tags: audit-trail iam-authentication iam-logs authentication-logs
5+
dates:
6+
validation: 2025-10-01
7+
posted: 2025-10-01
8+
---
9+
10+
This page explains how to differentiate IAM members authentication methods and understand and how they appear in Audit Trail.
11+
12+
This page only covers **Unauthenticated API** methods that actually perform and/or complete an authentication step.
13+
14+
## Authentication code login
15+
16+
This flow allows a user to log in using an **authentication code** sent via email.
17+
18+
- `InitiateMagicCodeLogin`
19+
Sends the user an email containing a 6-digit authentication code.
20+
21+
- `CreateMagicCodeLogin`
22+
Authenticates the user based on their username and the 6-digit authentication code received.
23+
24+
If multifactor authentication (MFA) is required, the flow proceeds to `CheckLoginMFAOTP`. Otherwise, the flow redirects to `CommitLogin`.
25+
26+
27+
## Password login
28+
29+
This method allows you to authenticate using a username and password.
30+
31+
- `CreatePasswordLogin`
32+
Authenticates the user with their username and password.
33+
34+
If MFA is required, the system verifies it through `CheckLoginMFAOTP`. If not, the flow continues directly to `CommitLogin`.
35+
36+
37+
38+
## OAuth2 login
39+
40+
This flow is based on external OAuth2 authentication providers.
41+
42+
- `InitiateOAuth2Login`
43+
Redirects the user to the external OAuth2 provider for authentication.
44+
45+
- `CreateOAuth2Login`
46+
Finalizes authentication once the OAuth2 provider confirms the user identity.
47+
48+
As with the other methods, if MFA is required, `CheckLoginMFAOTP` is triggered before committing the login. Otherwise, the flow continues to `CommitLogin`.
49+
50+
51+
## SAML login
52+
53+
This flow integrates with **SAML (Security Assertion Markup Language)** for Single Sign-On (SSO).
54+
It allows you to set up identity federation on your Organization and provide your teams with secure access to their accounts via an Identity Provider (IdP).
55+
56+
- `InitiateSamlLogin`
57+
Starts the SAML login and redirects the user to the IdP.
58+
59+
- `CreateSamlLogin`
60+
Finalizes authentication once the SAML response is received and validated.
61+
62+
As with the other methods, if MFA is required, `CheckLoginMFAOTP` is triggered before committing the login. Otherwise, the flow continues to `CommitLogin`.
63+
64+
## Common steps
65+
66+
- `CheckLoginMFAOTP`
67+
Validates the Multi-Factor Authentication one-time password (OTP) if required.
68+
69+
- `CommitLogin`
70+
The final step of the login process. Transforms the authenticated session into a JWT (JSON Web Token).
71+
72+
- `RenewJWT`
73+
Exchanges a valid login session/refresh context for a new JWT without re-authenticating credentials. JWTs are valid for 1 hour. If a member refreshes the Scaleway console or performs actions more than 1 hour after the last creation or update of a JWT, the JWT will be renewed.
74+
75+
76+
## Summary of authentication methods
77+
78+
| Method name | Description | Authentication flow |
79+
|---------------------------|--------------------------------------------------------------------|--------------------------|
80+
| **InitiateMagicCodeLogin**| Sends the user an email containing a 6-digit authentication code. | Authentication code login |
81+
| **CreateMagicCodeLogin** | Authenticates using username and the 6-digit authentication code. | Authentication code login |
82+
| **CreatePasswordLogin** | Authenticates using username and password. | Password login |
83+
| **InitiateOAuth2Login** | Redirects the user to the OAuth2 provider for authentication. | OAuth2 login |
84+
| **CreateOAuth2Login** | Finalizes authentication after OAuth2 provider confirmation. | OAuth2 login |
85+
| **InitiateSamlLogin** | Redirects the user to the SAML IdP. | SAML login |
86+
| **CreateSamlLogin** | Finalizes login after SAML response validation. | SAML login |
87+
| **CheckLoginMFAOTP** | Validates MFA OTP when required. | All flows (if MFA) |
88+
| **CommitLogin** | Commits login and issues the JWT. | All flows |
89+
| **RenewJWT** | Renews the JWT without full re-authentication. | Session maintenance |
90+
91+

0 commit comments

Comments
 (0)