diff --git a/README.md b/README.md index 6b11ea4fb..7d87f9c83 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/sdk/build.gradle b/sdk/build.gradle index 36a438def..db5f9b354 100644 --- a/sdk/build.gradle +++ b/sdk/build.gradle @@ -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", diff --git a/sdk/src/main/java/com/stytch/sdk/consumer/README.md b/sdk/src/main/java/com/stytch/sdk/consumer/README.md index f49ac7584..eab3b2dce 100644 --- a/sdk/src/main/java/com/stytch/sdk/consumer/README.md +++ b/sdk/src/main/java/com/stytch/sdk/consumer/README.md @@ -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 diff --git a/sdk/src/main/java/com/stytch/sdk/consumer/passkeys/README.md b/sdk/src/main/java/com/stytch/sdk/consumer/passkeys/README.md new file mode 100644 index 000000000..e679ed244 --- /dev/null +++ b/sdk/src/main/java/com/stytch/sdk/consumer/passkeys/README.md @@ -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.