Skip to content

Document vault passkeys and credential field add/remove - #724

Merged
rgarcia merged 2 commits into
mainfrom
hypeship/vault-passkeys
Oct 27, 2026
Merged

rgarcia merged 2 commits into
mainfrom
hypeship/vault-passkeys

Conversation

@rgarcia

@rgarcia rgarcia commented Oct 27, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents vault passkeys, now available in the API, the Node, Python, and Go SDKs (0.131.0), and the CLI (0.50.0).

  • New page vaults/passkeys: adding a passkey field, register_passkey to create a passkey on a website, importing a passkey as a CXF value, arm_passkey to sign in, disarm_passkey, CLI usage, and behavior and limits (one armed passkey per website per browser, one pending registration per browser, counter 0 with backup flags, ES256 only, new-tab reload, collection forms and vault-react 0.4.0 leaving passkey fields out, 409 on browsers whose image doesn't support passkeys). It includes the security warning that while a passkey is armed, any script on the website's pages can obtain a sign-in.
  • vaults/credentials: passkey added to the field types. The "field definitions are immutable" paragraph is replaced by a new Add or remove fields section for spec.add_fields and spec.remove_fields, with examples. Forms and custom collection surfaces omit passkey fields, and a Use passkeys section links to the new page.
  • vaults/overview: one paragraph pointing to passkeys.
  • docs.json: adds the page to the Vaults group after Credential Items.

Validation

  • Every TypeScript example on both pages type-checks with tsc --strict against @onkernel/sdk 0.132.0, and every Python example compiles.
  • Behavior statements were checked against the API's OpenAPI descriptions and the signer code (for example, allowCredentials matching and NotSupportedError for non-ES256 requests).
  • The broken-links check passes. I couldn't run the local preview server in my environment, so the rendered pages haven't been viewed.

@mintlify

mintlify Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
Kernel 🟢 Ready View Preview Oct 27, 2026, 7:03 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@AnnaXWang AnnaXWang left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approved with one request:

  • in vaults/passkeys.mdx:170 the Python import example uses os.environ without importing os, so it fails when copied as shown. add import os to the block.

@rgarcia
rgarcia merged commit c6b7cd2 into main Oct 27, 2026
3 checks passed
@rgarcia
rgarcia deleted the hypeship/vault-passkeys branch October 27, 2026 19:04

This branch was successfully deployed

1 active deployment
staging — a2b7d945 Deployed Oct 27, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants