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

feat: document two-step registration #1694

Merged
merged 2 commits into from
Mar 28, 2024
Merged
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions docs/identities/sign-in/two-step-registration.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
id: two-step-registration
title: Two-step registration
sidebar_label: Two-step registration
slug: two-step-registration
---

With a one-step registration, when you enable multiple authentication strategies (for example password, code via email, and
passkey), the identity traits will be repeated for each authentication strategy.

Compare this to a two-step registration: Now, the user is prompted for the identity traits in the first step, and asked to choose
a credential method for authentication next. This results in a more stream-lined user experience.

:::info

Identity traits are data associated with an identity that can be modified by the user. The traits are configured through the
identity schema.

[Learn more about identity traits](../../kratos/manage-identities/managing-users-identities-metadata#traits)

:::

![Registration with two-step registration vs one-step registration](./_static/two-step-registration.png)

To disable the legacy one-step registration, go to https://console.ory.sh/projects/current/authentication and switch off "Enable
legacy one-step registration" or use the Ory CLI:

```bash
ory list projects # to get the project id

ory patch project ${project_id} \
--replace '/services/identity/config/selfservice/flows/registration/enable_legacy_one_step=false'
```
Binary file added docs/kratos/_static/passkeys/console.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 10 additions & 5 deletions docs/kratos/passwordless/05_passkeys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,19 @@ login. Here is a comparison of the two approaches:

### Configuration

:::info
By default, the passkey strategy is disabled. You can enable it in the Ory Console by going to
[https://console.ory.sh/projects/current/passwordless](https://console.ory.sh/projects/current/passwordless) and toggling the
switch for "Enable Passkey authentication".

This feature is in preview. Please report any issues to [email protected] or contact us in the
[Ory Community](https://slack.ory.sh/).
```mdx-code-block
<BrowserWindow url="https://console.ory.sh/projects/current/passwordless">

:::
![Passkey in Console](../_static/passkeys/console.png)

</BrowserWindow>
```

By default, the passkey strategy is disabled. To start using the passkey strategy, apply this configuration:
Alternatively, use the Ory CLI to enable the passkey strategy:

```mdx-code-block
import CodeBlock from '@theme/CodeBlock'
Expand Down
1 change: 1 addition & 0 deletions src/sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ module.exports = {
"identities/sign-in/check-session",
"identities/sign-in/actions",
"identities/sign-in/login-hint",
"identities/sign-in/two-step-registration",
],
},
{
Expand Down
Loading