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.

Sign up for GitHub

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

website/docs: Add Passkeys reference where WebAuthn is mentioned #13167

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+8 −6
Open

website/docs: Add Passkeys reference where WebAuthn is mentioned #13167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
277bda6
Add Passkeys reference in several parts where WebAuthn is mentioned f…
melizeche Feb 21, 2025
3cf0f46
Add version badge to Webauthn / passkeys authenticator
melizeche Feb 21, 2025
74ecb22
fix linting issues
melizeche Feb 21, 2025
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
2 changes: 1 addition & 1 deletion website/docs/add-secure-apps/flows-stages/flow/context/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ Possible options:
- `token` (Authenticated via API token)
- `ldap` (Authenticated via LDAP bind from an LDAP source)
- `auth_mfa` (Authentication via MFA device without password)
- `auth_webauthn_pwl` (Passwordless authentication via WebAuthn)
- `auth_webauthn_pwl` (Passwordless authentication via WebAuthn / Passkeys)
- `jwt` ([M2M](../../../providers/oauth2/client_credentials.mdx) authentication via an existing JWT)

##### `auth_method_args` (dictionary)
Expand Down
2 changes: 1 addition & 1 deletion website/docs/add-secure-apps/flows-stages/stages/authenticator_validate/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ You can configure this stage to only ask for MFA validation if the user hasn't a
Firefox has some known issues regarding TouchID (see https://bugzilla.mozilla.org/show_bug.cgi?id=1536482)
:::

Passwordless authentication currently only supports WebAuthn devices, like security keys and biometrics. For an alternate passwordless setup, see [Password stage](../password/index.md#passwordless-login), which supports other types.
Passwordless authentication currently only supports WebAuthn (Passkeys) devices, like security keys and biometrics. For an alternate passwordless setup, see [Password stage](../password/index.md#passwordless-login), which supports other types.

To configure passwordless authentication, create a new Flow with the designation set to _Authentication_.

Expand Down
4 changes: 3 additions & 1 deletion website/docs/add-secure-apps/flows-stages/stages/authenticator_webauthn/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: WebAuthn authenticator setup stage
title: WebAuthn / Passkeys authenticator setup stage
---

<span class="badge badge--version">authentik 2021.3.1+</span>

This stage configures a WebAuthn-based Authenticator. This can either be a browser, biometrics or a Security stick like a YubiKey.

### Options
Expand Down
2 changes: 1 addition & 1 deletion website/docs/add-secure-apps/providers/ldap/generic_setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: Create an LDAP provider
Note the DN of this user will be `cn=ldapservice,ou=users,dc=ldap,dc=goauthentik,dc=io`

:::info
Note: The `default-authentication-flow` validates MFA by default, and currently everything but SMS-based devices and WebAuthn devices are supported by LDAP. If you plan to use only dedicated service accounts to bind to LDAP, or don't use SMS-based authenticators, then you can use the default flow and skip the extra steps below and continue at [Create LDAP Application & Provider](#create-ldap-application--provider)
Note: The `default-authentication-flow` validates MFA by default, and currently everything but SMS-based devices and WebAuthn (Passkeys) devices are supported by LDAP. If you plan to use only dedicated service accounts to bind to LDAP, or don't use SMS-based authenticators, then you can use the default flow and skip the extra steps below and continue at [Create LDAP Application & Provider](#create-ldap-application--provider)
:::

### LDAP Flow
Expand Down
2 changes: 1 addition & 1 deletion website/docs/customize/policies/expression.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ This includes the following:
}
```

- `auth_webauthn_pwl`: Password-less WebAuthn login
- `auth_webauthn_pwl`: Password-less WebAuthn / Passkeys login
- `jwt`: OAuth Machine-to-machine login via external JWT
- `app_password`: App password (token)

Expand Down
2 changes: 1 addition & 1 deletion website/docs/developer-docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ authentik
│   ├── authenticator_static - Configure TOTP backup keys
│   ├── authenticator_totp - Configure a TOTP authenticator
│   ├── authenticator_validate - Validate any authenticator
│   ├── authenticator_webauthn - Configure a WebAuthn authenticator
│   ├── authenticator_webauthn - Configure a WebAuthn / Passkeys authenticator
│   ├── captcha - Make the user pass a captcha
│   ├── consent - Let the user decide if they want to consent to an action
│   ├── deny - Static deny, can be used with policies
Expand Down
Loading