Skip to content

Commit 5b45d6b

Browse files
committed
docs(add): saml and auth methods
1 parent 1b51bf8 commit 5b45d6b

File tree

1 file changed

+102
-1
lines changed

1 file changed

+102
-1
lines changed

pages/audit-trail/reference-content/iam-authentication-logs.mdx

Lines changed: 102 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,106 @@ dates:
77
posted: 2025-09-30
88
---
99

10-
This page explains how to differentiate IAM member login methods and understand what is logged whenever you log in as an IAM member.
10+
This page explains how to differentiate IAM member authentication methods and understand and how they appear in Audit Trail.
11+
12+
13+
## 1. Authentication code login
14+
15+
This flow allows a user to log in using an **authentication code** sent via email.
16+
17+
- `InitiateMagicCodeLogin`
18+
Sends the user an email containing a 6-digit authentication code.
19+
20+
- `CreateMagicCodeLogin`
21+
Authenticates the user based on their username and the 6-digit authentication codee received.
22+
23+
If multifactor authentication (MFA) is required, the flow proceeds to `CheckLoginMFAOTP`. Otherwise, the flow redirects to `CommitLogin`.
24+
25+
26+
## 2. Password login
27+
28+
This is the standard login method using a username and password.
29+
30+
- `CreatePasswordLogin`
31+
Authenticates the user with their username and password.
32+
33+
If MFA is required, the system verifies it through `CheckLoginMFAOTP`. If not, the flow continues directly to `CommitLogin`.
34+
35+
36+
37+
## 3. OAuth2 login
38+
39+
This flow is based on external OAuth2 authentication providers.
40+
41+
- `InitiateOAuth2Login`
42+
Redirects the user to the external OAuth2 provider for authentication.
43+
44+
- `CreateOAuth2Login`
45+
Finalizes authentication once the OAuth2 provider confirms the user identity.
46+
47+
As with the other methods, if MFA is required, `CheckLoginMFAOTP` is triggered before committing the login. Otherwise, the flow continues to `CommitLogin`.
48+
49+
50+
## 4. SAML login
51+
52+
This flow integrates with **SAML (Security Assertion Markup Language)** for Single Sign-On (SSO).
53+
It allows you to set up identity federation on your Organization and provide your teams with secure access to their via an Identity Provider (IdP).
54+
55+
- `InitiateSamlLogin`
56+
Starts the SAML login process and redirects the user to the Identity Provider (IdP).
57+
58+
- `CreateSamlLogin`
59+
Finalizes authentication once the SAML response is received and validated.
60+
61+
- `EnableOrganizationSaml`
62+
Activates SAML authentication for the organization.
63+
64+
- `AddSamlCertificate`
65+
Adds a certificate used to validate SAML assertions.
66+
67+
- `UpdateSaml`
68+
Updates the SAML configuration for the organization.
69+
70+
- `DeleteSaml`
71+
Removes the SAML configuration for the organization.
72+
73+
- `DeleteSamlCertificate`
74+
Deletes an existing SAML certificate.
75+
76+
- `CreateJWT`
77+
Creates a JWT token after successful SAML authentication.
78+
79+
- `DeleteJWT`
80+
Deletes a previously issued JWT token.
81+
82+
## Common steps
83+
84+
- `CheckLoginMFAOTP`
85+
Validates the Multi-Factor Authentication one-time password (OTP) if required.
86+
87+
- `CommitLogin`
88+
The final step of the login process. Transforms the authenticated session into a JWT (JSON Web Token).
89+
90+
91+
## Summary of authentication methods
92+
93+
| Method name | Description | Authentication flow |
94+
|---------------------------|--------------------------------------------------------------------|--------------------------|
95+
| **InitiateMagicCodeLogin**| Sends the user an email containing a 6-digit authentication code. | Authentication code login |
96+
| **CreateMagicCodeLogin** | Authenticates using username and the 6-digit authentication code. | Authentication code login |
97+
| **CreatePasswordLogin** | Authenticates using username and password. | Password login |
98+
| **InitiateOAuth2Login** | Redirects the user to the OAuth2 provider for authentication. | OAuth2 login |
99+
| **CreateOAuth2Login** | Finalizes authentication after OAuth2 provider confirmation. | OAuth2 login |
100+
| **InitiateSamlLogin** | Starts the SAML login process and redirects to the IdP. | SAML login |
101+
| **CreateSamlLogin** | Finalizes authentication after receiving SAML response. | SAML login |
102+
| **EnableOrganizationSaml**| Enables SAML authentication for the organization. | SAML login |
103+
| **AddSamlCertificate** | Adds a certificate to validate SAML assertions. | SAML login |
104+
| **UpdateSaml** | Updates SAML configuration. | SAML login |
105+
| **DeleteSaml** | Deletes SAML configuration. | SAML login |
106+
| **DeleteSamlCertificate** | Removes a SAML certificate. | SAML login |
107+
| **CreateJWT** | Issues a JWT token after successful SAML authentication. | SAML login |
108+
| **DeleteJWT** | Deletes a previously issued JWT token. | SAML login |
109+
| **CheckLoginMFAOTP** | Validates the MFA one-time password if required. | All flows (if MFA) |
110+
| **CommitLogin** | Finalizes login and transforms the session into a JWT. | All flows |
111+
11112

0 commit comments

Comments
 (0)