chore: renamed passwordless to passkey (#11338)

# Which Problems Are Solved

Inconsistent naming of passkeys

# How the Problems Are Solved

translations are done using gemini

# Additional Changes


# Additional Context

- Closes #11298

---------

Co-authored-by: Gayathri Vijayan <[email protected]>
This commit is contained in:
Wim Van Laer
2026-01-13 08:19:42 +01:00
committed by GitHub
co-authored by Gayathri Vijayan
parent 7276c40261
commit 26e7c8499d
63 changed files with 652 additions and 623 deletions
@@ -9,7 +9,7 @@ The flow is represented by the following Ids in the API: `3`
## Post Authentication
A user has authenticated directly at ZITADEL.
ZITADEL validated the users inputs for password, one-time password, security key or passwordless factor.
ZITADEL validated the users inputs for password, one-time password or passkey.
Each validation step triggers the action.
The trigger is represented by the following Ids in the API: `TRIGGER_TYPE_POST_AUTHENTICATION` or `1`.
+1 -1
View File
@@ -20,7 +20,7 @@ Imagine signing in without passwords! Passkeys, replacing traditional passwords,
* **Seamless Registration:** Create unique passkeys for users on various devices. Optionally pair them with specific users and choose cross-platform or platform-specific options.
* **User Control:** Users manage their passkeys directly through ZITADEL's self-service portal, allowing registration, viewing, and deletion.
* **Intuitive Login:** Users initiate passwordless login by selecting the passkey option and verifying themselves with the device's biometrics (fingerprint, face ID, etc.).
* **Intuitive Login:** Users initiate passkey login by selecting the passkey option and verifying themselves with the device's biometrics (fingerprint, face ID, etc.).
* **Robust Fallback:** Traditional password login remains available for users without passkeys.
### Developer Resources
@@ -9,7 +9,7 @@ In this guide, you will have all necessary information to migrate from Actions v
### Post Authentication
A user has authenticated directly at ZITADEL.
ZITADEL validated the users inputs for password, one-time password, security key or passwordless factor.
ZITADEL validated the users inputs for password, one-time password or passkey factor.
To react to different authentication actions, the session service, `zitadel.session.v2.SessionService`, provides the different endpoints. As a rule of thumb, use response triggers if you primarily want to handle successful and failed authentications. On the other hand, use event triggers if you need more fine-granular handling, for example by the used authentication factors.
@@ -43,7 +43,7 @@ By default, all of these login methods are allowed and can be adjusted by [Manag
### Support for multiple authentication methods
The hosted login page supports various authentication methods, including traditional username/password authentication, social login options, multi-factor authentication (MFA), and passwordless authentication methods like [passkeys](/docs/concepts/features/passkeys.md).
The hosted login page supports various authentication methods, including traditional username/password authentication, social login options, multi-factor authentication (MFA), and passkey authentication method.
The second factor (2FA) and multi-factor authentication methods (MFA) available in ZITADEL include OTP via an authenticator app, TOTP via SMS, OTP via email, and U2F.
Developers can configure the authentication methods offered on the login page based on their application's security and usability requirements.
@@ -122,9 +122,9 @@ You can disable the prompt, in case multifactor authentication is not enforced b
#### Enroll passkeys
Users can select a button to initiate passwordless login or use a fall-back method (ie. login with username/password), if available.
Users can select a button to initiate passkey login or use a fall-back method (ie. login with username/password), if available.
The passwordless with [passkeys](/docs/concepts/features/passkeys.md) login flow follows the FIDO2 / WebAuthN standard.
The [passkeys](/docs/concepts/features/passkeys.md) login flow follows the FIDO2 / WebAuthN standard.
With the introduction of passkeys the gesture can be provided on ANY of the user's devices.
This is not strictly the device where the login flow is being executed (e.g., on a mobile device).
The user experience depends mainly on the operating system and browser.
@@ -150,7 +150,7 @@ For the first implementation we have excluded the following features:
- **Create Users:** The new TypeScript Login app is built with the session and the user V2 API, the users V2 API does have some differences to the v1 API, so make sure you create users through the new API.
- **External IDPs:** If you want to use external identity provider login, such as Login with Google or Apple. You can follow our existing setup guides, just make sure to use the following redirect url: `${CUSTOM_DOMAIN}/idps/callback`
- **Passkey/U2F:** Those authentication methods are bound to a domain. As your new login runs on a different domain than the previous login, existing passwordless authentication and u2f (fingerprint, face id, etc.) can’t be used. Also when they are managed through the management console of ZITADEL, they are added on a different domain.
- **Passkey/U2F:** Those authentication methods are bound to a domain. As your new login runs on a different domain than the previous login, existing passkey authentication (fingerprint, face id, etc.) can’t be used. Also when they are managed through the management console of ZITADEL, they are added on a different domain.
<br />
*Note: If you run the login on a subdomain of your current instance, this problem
can be avoided. E.g myinstance.zitadel.cloud and login.myinstance.zitadel.cloud*
@@ -173,7 +173,7 @@ In this case these are the following events:
- Password verification failed
- One-time password (OTP) check failed (Authenticator Apps like Authy, Google Authenticator, etc)
- Universal Second Factor (U2F) check failed (FaceID, WindowsHello, FingerPrint, etc)
- Passwordless/Passkey check failed (FaceID, WindowsHello, FingerPrint, etc)
- Passkey check failed (FaceID, WindowsHello, FingerPrint, etc)
```bash
curl --request POST \
@@ -43,6 +43,6 @@ In this case please enable the Feature Flag "Use V2 Api in Console for User crea
You can prompt the user to add a second factor method too by checking the **Force MFA** toggle in [Login behaviour settings](/docs/guides/manage/console/default-settings#login-behavior-and-access).
When logged in, a user can then manage the profile in the console, adding a profile picture, external IDPs and Passwordless authentication devices.
When logged in, a user can then manage the profile in the console, adding a profile picture, external IDPs and Passkeys.
<img src="/docs/img/guides/console/myprofile.png" alt="Profile Self Manage" />
@@ -18,7 +18,7 @@ When you configure your default settings, you can set the following:
- **Organizations**: A list of your organizations
- [**Features**](#features): Feature Settings let you try out new features before they become generally available. You can also disable features you are not interested in.
- [**Notification settings**](#notification-settings): Setup Notification and Email Server settings for initialization-, verification- and other mails. Setup Twilio as SMS notification provider.
- [**Login Behavior and Access**](#login-behavior-and-access): Multifactor Authentication Options and Enforcement, Define whether Passwordless authentication methods are allowed or not, Set Login Lifetimes and advanced behavior for the login interface.
- [**Login Behavior and Access**](#login-behavior-and-access): Multifactor Authentication Options and Enforcement, Define whether passkeys are allowed or not, Set Login Lifetimes and advanced behavior for the login interface.
- [**Identity Providers**](#identity-providers): Define IDPs which are available for all organizations
- [**Password Complexity**](#password-complexity): Requirements for Passwords ex. Symbols, Numbers, min length and more.
- [**Password Expiry**](#password-expiry): Set an expiry for passwords. After the expiration, a user will be prompted to change their password during the next login.
@@ -173,14 +173,14 @@ Change default redirect url of instance: `https://${CUSTOM_DOMAIN}/ui/console/in
width="600px"
/>
### Passwordless
### Passkeys
Passwordless authentication means that the user doesn't need to enter a password to login. In our case the user has to enter his loginname and as the next step proof the identity through a registered device or token.
Passkey authentication means that the user doesn't need to enter a password to login. In our case the user has to enter his loginname and as the next step proof the identity through a registered device or token.
There are two different types one is depending on the device (e.g. Fingerprint, Face recognition, WindowsHello) and the other is independent (eg. Yubikey, Solokey).
### Multifactor (MFA)
In the multifactors section you can configure what kind of multifactors should be allowed. For passwordless to work, it's required to enable U2F (Universal Second Factor) with PIN. There is no other option at the moment.
In the multifactors section you can configure what kind of multifactors should be allowed. For passkeys to work, it's required to enable U2F (Universal Second Factor) with PIN. There is no other option at the moment.
Multifactors:
- U2F (Universal Second Factor) with PIN, e.g FaceID, WindowsHello, Fingerprint, Hardwaretokens like Yubikey
@@ -322,10 +322,10 @@ Also you can set the link associated to the Documentation button in the console.
These are the texts for your notification mails. Available for change are:
| Message Text | Description |
| --------------- | -------------------------------------------------------------------------------------------------------------------------- |
|-----------------|----------------------------------------------------------------------------------------------------------------------------|
| Domain Claim | The Mail after an organisation claimed a domain for itself. Users on other organisations with this domain will be notified |
| Initialization | The mail after a user has been created. A code is part of the message which then must be verified on first login |
| Passwordless | The Mail to register an additional passwordless device by a link |
| Passkey | The Mail to register an additional passkey device by a link |
| Password Reset | The Mail to reset the password by a link |
| Verify Email | The mail after the email has been changed. A code is part of the message which then must be verified on the next login |
| Password Change | Notify the user, that the password has been changed. Can be configured in [Notification](#notification) |
@@ -382,7 +382,7 @@ The following secrets can be configured:
- Email verification code
- Phone verification code
- Password reset code
- Passwordless initialization code
- Passkey initialization code
- Application secrets
- One Time Password (OTP) - SMS
- One Time Password (OTP) - Email
@@ -105,7 +105,7 @@ Those settings are the same as your default settings.
> Note: that the following links, redirect to default settings to omit redundancy.
- [**Login Behavior and Access**](./default-settings#login-behaviour-and-access): Multifactor Authentication Options and Enforcement, Define whether Passwordless authentication methods are allowed or not, Set Login Lifetimes and advanced behavior for the login interface.
- [**Login Behavior and Access**](./default-settings#login-behaviour-and-access): Multifactor Authentication Options and Enforcement, Define whether passkeys are allowed or not, Set Login Lifetimes and advanced behavior for the login interface.
- [**Identity Providers**](./default-settings#identity-providers): Define IDPs which are available for all organizations
- [**Password Complexity**](./default-settings#password-complexity): Requirements for Passwords ex. Symbols, Numbers, min length and more.
- [**Lockout**](./default-settings#lockout): Set the maximum attempts a user can try to enter the password or any (T)OTP method. When the number is exceeded, the user gets locked out and has to be unlocked.
+1 -1
View File
@@ -14,7 +14,7 @@ A human user has an email address and a password, and can additionally save info
A service user only has a name and a description aside his username.
A service user can be authenticated with JWT profile or Personal Access Tokens. Both methods can specify an expiry.
A human user can authenticate itself with his password, add multiple factors for additional security, and enable passwordless authentication.
A human user can authenticate itself with his password, add multiple factors for additional security, and enable passkey authentication.
Service users are primarily used to gain access for a backend service or iot device. The fact that service users can also be ZITADEL managers is used to restrict access to specific projects or organizations.
To get an understanding on how service users are used, take a look at our NextJS B2B Demo application.
@@ -14,9 +14,9 @@ If you are collecting all the user information and a password, you can directly
With the `password_change_required` flag you can choose if the user has to change the password on the first login or not.
This might make sense if an administrator created the user.
## With passwordless
## With passkey
You can directly ask for a link to create the passwordless registration for the user.
You can directly ask for a link to create the passkey registration for the user.
Fill the user data and set the attribute `request_passwordless_registration` to true.
You will get a link for the registration and an expiration time in the response.
@@ -27,11 +27,11 @@ If you add `requestPlatformType` as query parameter to the link you can define w
If nothing is requested, the type will not be restricted and all possibilities of the device will be taken into account.
### Add passwordless to existing user
### Add passkey to existing user
If you already have a user in ZITADEL, it is possible to add passwordless later.
If you already have a user in ZITADEL, it is possible to add passkey later.
[Add Passwordless Registration ](/apis/resources/mgmt)
[Add Passkey Registration ](/apis/resources/mgmt)
Send the user_id in the request and you will get a link and an expiration as response.
You can then customize the link the same as described above in the creation process.
@@ -39,7 +39,7 @@ You can then customize the link the same as described above in the creation proc
The second possibility is to send the link directly to the user per email.
Use the following request in that case:
[Send Passwordless Registration ](/apis/resources/mgmt)
[Send Passkey Registration ](/apis/resources/mgmt)
## Verified Email Address
+1 -1
View File
@@ -20,7 +20,7 @@ The following scripts don't include:
- Machine keys
- Personal Access Tokens
- Application keys
- Passwordless authentication
- Passkey authentication
Which results in that if you want to import, and you have no defined organization-specific custom policies, the experience for your users will not be exactly like in your old instance.
+1 -1
View File
@@ -4,7 +4,7 @@ sidebar_label: Overview
---
Most applications require user identity for access control, secure data storage in the cloud, and to provide a consistent, personalized experience across all of a user's devices.
With ZITADEL, you can rely on a hardened and extensible turnkey solution to address all your authentication and authorization needs. We offer a wide range of features out of the box to accelerate your project. These features include multi-tenancy with branding customization, secure login, self-service, OpenID Connect, OAuth2.x, SAML2, Passwordless with FIDO2 (including Passkeys), OTP, U2F, and an unlimited audit trail. Execute custom code on selected events within ZITADEL to ensure compatibility with your unique and complex software landscape and data models.
With ZITADEL, you can rely on a hardened and extensible turnkey solution to address all your authentication and authorization needs. We offer a wide range of features out of the box to accelerate your project. These features include multi-tenancy with branding customization, secure login, self-service, OpenID Connect, OAuth2.x, SAML2, Passkeys, OTP, U2F, and an unlimited audit trail. Execute custom code on selected events within ZITADEL to ensure compatibility with your unique and complex software landscape and data models.
## Get started
+2 -2
View File
@@ -39,7 +39,7 @@ Requests to the management API are rate limited. Read our [Rate limit Policy](/d
### User Authentication
User Authentication can be performed in multiple ways. Default method in ZITADEL is username and password with MFA enabled.
ZITADEL allows you to configure Multifactor- and Passwordless Authentication in order to enhance security for your users. All authentication methods are available from the FREE Tier.
ZITADEL allows you to configure Multifactor- and Passkey Authentication in order to enhance security for your users. All authentication methods are available from the FREE Tier.
To setup your organizations login policy, go to your organizations detail in [Console](https://${CUSTOM_DOMAIN}.zitadel.cloud/ui/console/org).
When planning your application consider the following questions about User Authentication:
@@ -62,7 +62,7 @@ ZITADEL supports signup with OIDC Identity providers as well as JWT Identity Pro
### Hosted Login
ZITADEL offers a "secure by default approach" and comes with a Hosted Login which is a fixed endpoint for your users to authenticate.
It's safe and secure and comes with Multifactor, Federated Login and Passwordless capabilities.
It's safe and secure and comes with Multifactor, Federated Login and Passkey capabilities.
OIDC (OpenID Connect) opens the doors to Single Sign On (SSO). Especially if you have more than one application, you may want a central and familiar authentication experience.
With SSO, ZITADEL provides a seamless experience across all your apps.