-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
SDK-1500 Document passkeys better (#133)
* SDK-1500 Document passkeys better * Add links to Passkeys documentation to main readmes
- Loading branch information
1 parent
a5f5d04
commit ce62b7d
Showing
4 changed files
with
17 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 12 additions & 0 deletions
12
sdk/src/main/java/com/stytch/sdk/consumer/passkeys/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Package com.stytch.sdk.consumer.passkeys | ||
The [Passkeys](Passkeys.kt) interface provides methods for registering and authenticating with Passkeys. | ||
|
||
To enable passkey support for your Android app, associate your app with a website that your app owns. You can declare this association by following the instructions [here](https://developer.android.com/training/sign-in/passkeys#add-support-dal) | ||
|
||
Once you've associated your app and domain, you can use the below methods to register and authenticate with the Stytch Passkeys product. | ||
|
||
Call `StytchClient.passkeys.register()` to create a new Passkey registration. | ||
|
||
Call `StytchClient.passkeys.authenticate()` to authenticate a user with an existing Passkey. | ||
|
||
Call `StytchClient.passkeys.update()` to update the name of an existing Passkey. |