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

Passkey overview #849

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Passkey overview #849

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 33 additions & 0 deletions database/apidocs/docs/v2/customer-identity-api/passkey/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Passkey Overview

Passkeys are advanced cryptographic keys designed to replace passwords, offering faster, easier, and more secure sign-ins across websites and apps on all your devices. Unlike traditional passwords, passkeys are inherently strong, resistant to phishing, and eliminate the need for shared secrets.
Passkeys represent a secure, passwordless future where each passkey is a unique cryptographic key pair enabling seamless access to online services.

**Benefits of Using Passkeys**

- Enhanced Security: Resistance to phishing attacks and stronger authentication.
- Improved User Experience: Faster logins without the hassle of remembering passwords.
- Reduced Risk of Credential Theft: Elimination of password-related risks.
- Future-Proof Authentication: Ready for evolving security standards and technologies.

## LoginRadius API usage for Passkey:

### Passkey Registration Flow:

- Initiate Registration using [Get Registration Begin by Passkey API](/api/v2/customer-identity-api/passkey/registration-begin-by-passkey/), which starts the registration process.

- Complete Registration using [POST Register Finish By Passkey API](/api/v2/customer-identity-api/passkey/register-finish-by-passkey/) to finalize passkey registration.

- (Optional) Add Another Passkey using POST [Account: Add Passkey Finish API](/api/v2/customer-identity-api/passkey/add-passkey-finish/), which Adds additional passkeys to the account.

### Passkey Login Flow:

- Initiate Login with [Get Login Begin by Passkey API](/api/v2/customer-identity-api/passkey/login-begin-by-passkey/), which starts login with the user's Passkey.

- Complete Login using [POST Login Finish By Passkey API](/api/v2/customer-identity-api/passkey/login-finish-by-passkey/): to finalize passkey-based login.

### Reset Passkey:

- Start the Reset Process using [Get Login Reset Passkey Begin API](/api/v2/customer-identity-api/passkey/login-reset-passkey-begin/): which Begins the Passkey reset.

- Complete Reset with [POST Login Reset Passkey Finish API](/api/v2/customer-identity-api/passkey/login-reset-passkey-finish/):. Complete the reset with a new passkey.