Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

stages/authenticator_email: Email Authenticator Stage Documentation #12853

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Duo authenticator setup stage
title: Duo Authenticator Setup stage
---

This stage configures a Duo authenticator. To get the API Credentials for this stage, open your Duo Admin dashboard.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Email Authenticator Setup stage
---

This stage configures an email-based authenticator that sends a one-time code to a user's email address for authentication.

When a user goes through a flow that includes this stage, they are prompted for their email address (if not already set). The user then receives an email with a one-time code, which they enter into the authentik Login panel.

The email address will be saved and can be used with the [Authenticator validation](../authenticator_validate/index.md) stage for future authentications.

## Flow integration

To use the Email Authenticator Setup stage in a flow, follow these steps:

1. [Create](../../flow/index.md#create-a-custom-flow) a new flow or edit an existing one.
2. On the flow's **Stage Bindings** tab, click **Create and bind stage** to create and add the Email Authenticator Setup stage. (If the stage already exists, click **Bind existing stage**.)
3. Configure the stage settings as described below.

- **Name**: provide a descriptive name, such as Email Authenticator Setup.
- **Authenticator type name**: define the display name for this stage.
- **Use global connection settings**: the stage can be configured in two ways: global settings or stage-specific settings.

- Enable (toggle on) the **Use global connection settings** option to use authentik's global email configuration. Note that you must already have configured your environment variables to use the global settings. See instructions for [Docker Compose](../../../../install-config/install/docker-compose#email-configuration-optional-but-recommended) and for [Kubernetes](../../../../install-config/install/kubernetes#optional-step-configure-global-email-credentials).

- If you need different email settings for this stage, disable (toggle off) **Use global connection settings** and configure the following options:

- **Connection settings**:

- **SMTP Host**: SMTP server hostname (default: localhost)
- **SMTP Port**: SMTP server port number(default: 25)
- **SMTP Username**: SMTP authentication username (optional)
- **SMTP Password**: SMTP authentication password (optional)
- **Use TLS**: Enable TLS encryption
- **Use SSL**: Enable SSL encryption
- **Timeout**: Connection timeout in seconds (default: 10)
- **From Address**: Email address that messages are sent from (default: system@authentik.local)

- **Stage-specific settings**:

- **Subject**: Email subject line (default: "authentik Sign-in code")
- **Token Expiration**: Time in minutes that the sent token is valid (default: 30)
- **Configuration flow**: select the flow to which you are binding this stage.

4. Click **Update** to complete the creation and binding of the stage to the flow.

The new Email Authenticator Setup stage now appears on the **Stage Bindings** tab for the flow.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: SMS authenticator setup stage
title: SMS Authenticator Setup stage
---

This stage configures an SMS-based authenticator using either Twilio, or a generic HTTP endpoint.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Static authenticator setup stage
title: Static Authenticator Setup stage
---

This stage configures static Tokens, which can be used as a backup method to time-based OTP tokens.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: TOTP authenticator setup stage
title: TOTP Authenticator Setup stage
---

This stage configures a time-based OTP Device, such as Google Authenticator or Authy.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Authenticator validation stage
title: Authenticator Validation stage
---

This stage validates an already configured Authenticator Device. This device has to be configured using any of the other authenticator stages:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: WebAuthn authenticator setup stage
title: WebAuthn Authenticator Setup stage
---

This stage configures a WebAuthn-based Authenticator. This can either be a browser, biometrics or a Security stick like a YubiKey.
Expand Down
3 changes: 2 additions & 1 deletion website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -286,11 +286,12 @@ export default {
items: [
"add-secure-apps/flows-stages/stages/authenticator_duo/index",
"add-secure-apps/flows-stages/stages/authenticator_endpoint_gdtc/index",
"add-secure-apps/flows-stages/stages/authenticator_email/index",
"add-secure-apps/flows-stages/stages/authenticator_sms/index",
"add-secure-apps/flows-stages/stages/authenticator_static/index",
"add-secure-apps/flows-stages/stages/authenticator_totp/index",
"add-secure-apps/flows-stages/stages/authenticator_validate/index",
"add-secure-apps/flows-stages/stages/authenticator_webauthn/index",
"add-secure-apps/flows-stages/stages/authenticator_validate/index",
"add-secure-apps/flows-stages/stages/captcha/index",
"add-secure-apps/flows-stages/stages/deny",
"add-secure-apps/flows-stages/stages/email/index",
Expand Down
Loading