Repository navigation
Document scoped API keys - #694
Draft
sjmiller609 wants to merge 3 commits into
Draft
sjmiller609 wants to merge 3 commits into
sjmiller609 wants to merge 3 commits into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
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
1 participant
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.