feat: add Passkey APIs to Authentication API reference#1373
Merged
Conversation
Add the missing main/docs/api/authentication/passkey/register.mdx that should have been part of the previous commit, and remove main/docs/authenticate/login/embedded-login/use-cases/enrollment.mdx, which was committed by mistake and is out of scope for this PR. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
# Conflicts: # main/config/navigation/generated/authentication.en.json
Remove the manually-edited authentication.en.json from this PR. The Passkey API pages are added as content-only; navigation will be handled separately through the OAS-generated nav pipeline. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
|
|
||
| <Expandable title="properties"> | ||
| <ParamField body="email" type="string"> | ||
| User's email address. Validated against the JSON Schema email format. |
Contributor
There was a problem hiding this comment.
Suggested change
| User's email address. Validated against the JSON Schema email format. | |
| User's email address. Validated against the `JSON` schema email format. |
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
| </ParamField> | ||
|
|
||
| <ParamField body="username" type="string"> | ||
| User's username. Validated against the connection's username policy (length and allowed characters). |
Contributor
There was a problem hiding this comment.
Suggested change
| User's username. Validated against the connection's username policy (length and allowed characters). | |
| User's username. Validates against the connection's username policy (length and allowed characters). |
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
avanscoy
reviewed
Jun 11, 2026
hazel-nut
previously approved these changes
Jun 16, 2026
hazel-nut
left a comment
Contributor
There was a problem hiding this comment.
lgtm, just some alignment with the existing auth api docs :)
Co-authored-by: Hazel Virdó <github@virdo.name>
avanscoy
approved these changes
Jun 17, 2026
agiannelli-auth0
approved these changes
Jun 17, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds reference documentation for the new Passkey APIs (
POST /passkey/challengeand
POST /passkey/register) under the Authentication API, in support of theEmbedded Capabilities GA relaunch (Passkey APIs going GA — covers native iOS,
native Android, and web).
What's in this PR:
main/docs/api/authentication/passkey/challenge.mdx— documentsPOST /passkey/challenge. Covers the request body (client_id,client_secret,realm,organization), prerequisites (custom domain,first-party + OIDC-conformant client, passkey grant enabled), and the
WebAuthn
PublicKeyCredentialRequestOptionsreturned inauthn_params_public_keyalongside theauth_sessionvalue used in thesubsequent token exchange.
main/docs/api/authentication/passkey/register.mdx— documentsPOST /passkey/register. Coversuser_profilesignup attributes andvalidation rules,
user_metadataconstraints (max 10 fields, reservedfield-name blocklist), and the WebAuthn
PublicKeyCredentialCreationOptionsreturned (
rp,user,pubKeyCredParams,authenticatorSelection).main/config/navigation/generated/authentication.en.json— adds a new"Passkeys" group between "Passwordless" and "Device Authorization" that
links to both new pages.
Testing
mint devfrommain/and confirm:"Passwordless" and "Device Authorization".
/passkey/challengeand/passkey/registerpages render withparameter, response field, and status code tables.
resolve.
Checklist
CONTRIBUTING.md.