Skip to content

Commit

Permalink
Merge pull request #853 from LoginRadius/ch_DOC-2926_#2_overview_docu…
Browse files Browse the repository at this point in the history
…mentation_of_passkey_apis

overview update
  • Loading branch information
vaibhavJainlr authored Oct 10, 2024
2 parents eb8dcc6 + 53e8086 commit 287252a
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 5 deletions.
24 changes: 20 additions & 4 deletions database/apidocs/docs/v2/customer-identity-api/passkey/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,36 @@ Passkeys represent a secure, passwordless future where each passkey is a unique

### 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.
- 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.
- 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.

### (Optional) 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.
- 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.
- 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.

### Autofill Login with Passkey:

- Initiate Autofill Login using [GET Autofill Login Begin By Passkey](/api/v2/customer-identity-api/passkey/autofill-login-begin-by-passkey/) API: which starts the login process using the browser's autofill passkey.

- Complete Autofill Login using [POST Autofill Login Finish By Passkey](/api/v2/customer-identity-api/passkey/autofill-login-finish-by-passkey/) API: which finalizes the autofill-based passkey login.

### Passkey Management APIs:

- List User Passkeys with [GET List User Passkeys](/api/v2/customer-identity-api/passkey/list-user-passkeys/) API: to Retrieves all passkeys registered by a specific user.

- Delete User Passkey by ID using [DEL Remove Passkey By ID](/docs/api/v2/customer-identity-api/passkey/remove-passkey-by-id/) API: which Deletes a specific passkey using its unique ID.

- Delete Passkey by User ID (UID) using [DEL Manage Remove Passkey By Uid](/api/v2/customer-identity-api/passkey/manage-remove-passkey-by-uid/) API: to Remove all passkeys for a user based on their unique UID.

You can also use our [POST Forgot Passkey](/api/v2/customer-identity-api/passkey/forgot-passkey/) API, which allows a user to request assistance for a forgotten passkey, and our [GET Manage List Users Passkeys](/api/v2/customer-identity-api/passkey/list-user-passkeys/) API, which allows an admin to view passkeys registered for a specific user.
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ The following displays the Progressive Profiling option on the IDX Profile page:
### JavaScript Deployment
The following are the sequential steps to deploy the passwordless feature using the LoginRadius JavaScript Libraries:
The following are the sequential steps to deploy the Progressive Profiling feature using the LoginRadius JavaScript Libraries:
**Step 1:** Include the LoginRadius JavaScript Libraries, as explained below:
Expand Down

0 comments on commit 287252a

Please sign in to comment.