Skip to content

docs: retire the public-key guide and make the AgentID sign-in guide API-first - #245

Open
sidharth0612 wants to merge 2 commits into
mainfrom
sid/retire-public-key-guide
Open

sidharth0612 wants to merge 2 commits into
mainfrom
sid/retire-public-key-guide

Conversation

@sidharth0612

@sidharth0612 sidharth0612 commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Two commits.

1. Retire the public-key authentication guide. The agent-signed approval endpoint was removed on 2026-09-08 (agentmail-api #1156) and the issuer dropped keypair approval on 2026-09-05, but the guide was still live, still in the Guides nav, and the sign-in guide still said the flow "remains supported during migration". Delete the guide, drop it from the nav, redirect its slug to /agentid-browser-enrollment so the July changelog link keeps resolving, and replace the migration section with a retirement note. Supersedes #232 (conflicts with main after #231) and #233 (the live guide already emits agentid_session_required).

2. Make the sign-in guide API-first. It described everything from the browser's side: enroll a browser, attach a browser, browser activation. The product is one authenticated call, POST /v0/inboxes/{inbox_id}/authorize, that authorizes a sign-in for an inbox; the client holding the resulting key is a detail. Rewritten around the call. "browser" goes from 39 mentions to 7, and the 7 are the slug, the browser_origin wire field in the JSON and samples, and the list of retired route names.

This also fixes two real errors in the guide:

  • The intro said the key is an API key of type browser. It is public_key, as the JSON below it already showed.
  • Both code samples validated agentmail_api_keys_endpoint against the authorize URL. That field is a deprecated alias pointing at /api-keys, so the check could never pass. They now check agentmail_authorize_endpoint.

And it brings the action example up to what the page publishes today: agentmail_api_key_status_endpoint, accept_disclosure, remembered_approval_days, and the <meta name="agentid-session-action"> mirror. The samples forward accept_disclosure when present. The required permission is stated as provider_connect, not api_key_create.

🤖 Generated with Claude Code

The agent-signed approval endpoint was removed on 2026-09-08
(agentmail-api #1156) and the issuer dropped keypair approval on
2026-09-05, but the guide stayed live and in the Guides nav, and the
enrollment guide still said the flow remains supported during migration.

Delete the guide, drop it from the nav, redirect its slug to the
enrollment guide so the changelog link keeps resolving, and replace the
migration section with a short retirement note.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

The guide described the flow from the browser's point of view: enroll a
browser, attach a browser, browser activation. The product is one
authenticated API call that authorizes a sign-in for an inbox; the client
that holds the resulting key is a detail. Rewrite around the call, and
say "client" or "the sign-in page" where the text said browser. What
remains is the slug, the browser_origin wire field, and the list of
retired routes, none of which can be renamed here.

Also fixes two errors: the intro said the key type is `browser` (it is
`public_key`), and both code samples validated
agentmail_api_keys_endpoint against the authorize URL, which can never
match; they now check agentmail_authorize_endpoint. The action example
gains the status endpoint, accept_disclosure, and remembered_approval_days
the page now publishes, and the samples forward accept_disclosure.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@sidharth0612 sidharth0612 changed the title docs: retire the AgentID public-key authentication guide docs: retire the public-key guide and make the AgentID sign-in guide API-first Sep 14, 2026
@github-actions

Copy link
Copy Markdown

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