Repository navigation
Document scoped API keys - #694
Merged
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
sjmiller609
marked this pull request as ready for review
October 13, 2026 23:30
Sayan-
requested changes
Oct 14, 2026
Sayan-
left a comment
Contributor
There was a problem hiding this comment.
- p1:
info/api-key-permissions.mdx:63-64saysprojects:readandorganizations:readallow metadata and limit reads. These action names are accepted in policies, but all corresponding endpoints reject scoped keys with403 insufficient_scope, even with the documented grants. - p2:
info/api-keys.mdx:162limits its expiry/revocation warning to already-open browser connections. Previously obtained CDP and WebDriver URLs can also establish new connections after the API key expires or is deleted, while the browser remains active. Those URLs authenticate independently of the API key.
Contributor
Author
|
Thanks, both addressed in 9b2cf5f:
|
masnwilliams
approved these changes
Oct 14, 2026
This branch was successfully deployed
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.
Documents scoped API keys on the API Keys page: creating a key with a
policyof allow statements, and setting an exactexpires_at.Changes
info/api-keys.mdx): new Scope a key to specific resources section. It explains statements, actions, and resources briefly, then gives TypeScript and Python examples and the expiry, revocation, and rotation rules. The list, rotate, and troubleshooting sections now coverpolicy.info/api-key-permissions.mdx, new): reference page with resource formats, every action by resource kind, operations that need more than one action, and what scoped keys can't do. Added to the Manage navigation after API Keys.Before merging
Merge once scoped key issuance ships in the API and the SDKs expose
policyandexpires_atonapiKeys.create. The examples use those SDK fields. Go examples are left out until the generated Go types exist.Checked locally with
mintlify dev: the page renders and the new anchors resolve.Note
Low Risk
Documentation-only changes with no runtime or security logic modifications.
Overview
Adds documentation for scoped API keys: creating keys with a
policyof allow statements and optional exactexpires_at, plus a dedicated permissions reference.API Keys (
info/api-keys.mdx) gains a Scope a key to specific resources section (policy model, TypeScript/Python create examples, expiry/revocation caveats including that CDP URLs survive key deletion). List/retrieve, rotate, and troubleshooting now mentionpolicy,insufficient_scope, and scoped-key validation errors.API Key Permissions (
info/api-key-permissions.mdx) is new: resource patterns, actions per resource kind, multi-action operations, and endpoints scoped keys cannot use. It’s linked from the API Keys page and added to the Manage nav indocs.json.Reviewed by Cursor Bugbot for commit 9b2cf5f. Bugbot is set up for automated code reviews on this repo. Configure here.