Skip to content

Commit

Permalink
SDK-1500 Document passkeys better (#133)
Browse files Browse the repository at this point in the history
* SDK-1500 Document passkeys better

* Add links to Passkeys documentation to main readmes
  • Loading branch information
jhaven-stytch authored Mar 11, 2024
1 parent a5f5d04 commit ce62b7d
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ the near future! The full list of currently supported products is as follows:
- [OAuth](sdk/src/main/java/com/stytch/sdk/consumer/oauth/README.md)
- Register/authenticate with native Google OneTap
- Register/authenticate with our supported third-party OAuth providers (Amazon, BitBucket, Coinbase, Discord, Facebook, Github, GitLab, Google, LinkedIn, Microsoft, Salesforce, Slack, Twitch, or Yahoo)
- [Passkeys](passkeys)
- Register/authenticate with Passkeys
- [User Management](sdk/src/main/java/com/stytch/sdk/consumer/userManagement/README.md)
- Get or fetch the current user object (sync/cached or async options available)
- Delete factors by id from the current user
Expand Down
1 change: 1 addition & 0 deletions sdk/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ tasks.named("dokkaHtmlPartial").configure {
"src/main/java/com/stytch/sdk/consumer/magicLinks/README.md",
"src/main/java/com/stytch/sdk/consumer/oauth/README.md",
"src/main/java/com/stytch/sdk/consumer/otp/README.md",
"src/main/java/com/stytch/sdk/consumer/passkeys/README.md",
"src/main/java/com/stytch/sdk/consumer/passwords/README.md",
"src/main/java/com/stytch/sdk/consumer/sessions/README.md",
"src/main/java/com/stytch/sdk/consumer/userManagement/README.md",
Expand Down
2 changes: 2 additions & 0 deletions sdk/src/main/java/com/stytch/sdk/consumer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Stytch's consumer SDK makes it simple to seamlessly onboard, authenticate, and e
- [OAuth](oauth)
- Register/authenticate with native Google OneTap
- Register/authenticate with our supported third-party OAuth providers (Amazon, BitBucket, Coinbase, Discord, Facebook, Github, GitLab, Google, LinkedIn, Microsoft, Salesforce, Slack, Twitch, or Yahoo)
- [Passkeys](passkeys)
- Register/authenticate with Passkeys
- [User Management](userManagement)
- Get or fetch the current user object (sync/cached or async options available)
- Delete factors by id from the current user
Expand Down
12 changes: 12 additions & 0 deletions sdk/src/main/java/com/stytch/sdk/consumer/passkeys/README.md
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.

0 comments on commit ce62b7d

Please sign in to comment.