Skip to content

docs: Add API key permissions page [AE-485]#361

Open
sejla wants to merge 2 commits into
mainfrom
AE-485/api-key-permissions
Open

docs: Add API key permissions page [AE-485]#361
sejla wants to merge 2 commits into
mainfrom
AE-485/api-key-permissions

Conversation

@sejla
Copy link
Copy Markdown
Contributor

@sejla sejla commented May 28, 2026

Summary

Adds a new page under Admin API documenting API key permissions: how scoped vs unrestricted developer keys behave, the currently available permissions and the endpoints they cover, and how admins create or edit permissions on a key from the account UI.

Details

  • New page slotted under Admin API (same level as Managing Developer Keys), not nested.
  • Screenshots referenced under _assets/images/ are placeholders to be added in a follow-up.
  • Page describes the user-facing behavior only; no internal implementation details.

Jira: AE-485

Co-Authored-By: Claude Code

Explains how admins can scope developer API keys to specific endpoints, lists
the available permissions and the endpoints they cover, and walks through the
create / edit flows in the account UI.

Co-Authored-By: Claude Code
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 28, 2026

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

Project Status Preview Updated (UTC)
deepl-c950b784 🟢 Ready View Preview May 28, 2026, 8:58 AM

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

List every publicly documented v2 and v3 endpoint each scope grants, with
links to the matching API reference pages, and clarify that endpoints without
a permission requirement remain accessible to scoped keys.

Co-Authored-By: Claude Code
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.

1 participant