Skip to content

docs: Workspace exclusions for org-level guardrails - #1007

Open
kiran-4444 wants to merge 4 commits into
mainfrom
cursor/workspace-exclusions-guardrails-docs-7b22
Open

docs: Workspace exclusions for org-level guardrails#1007
kiran-4444 wants to merge 4 commits into
mainfrom
cursor/workspace-exclusions-guardrails-docs-7b22

Conversation

@kiran-4444

@kiran-4444 kiran-4444 commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the workspace exclusions feature from Portkey-AI/albus#2232, which lets organization owners/admins exclude specific workspaces from organization-level input and/or output guardrails.

Product docs

  • Expanded Enforcing Org Level Guardrails with workspace exclusions behavior, permissions/scopes, API overview, and an example
  • Cross-linked from Enforcing Workspace Level Guardrails so the interaction with org defaults is clear

Admin API docs

Added Control Plane pages under Workspace Exclusions:

  • Update Workspace Exclusions — covers PUT .../input-guardrails and PUT .../output-guardrails
  • List Workspace Exclusions — covers GET for both entity types

These are manually documented (request/response examples + parameters) because the shared OpenAPI spec does not include these routes yet. Pages use Mintlify api frontmatter for sidebar method badges.

API key scopes

Documented new Admin (organisation-service) scopes:

  • organisation_exclusions.update
  • organisation_exclusions.list

in API Keys (AuthN and AuthZ), and referenced them from the exclusions product/API pages.

Navigation

Registered the new pages in docs.json under Admin APIs.

Test plan

  • Preview org-level guardrails page and confirm exclusions + scopes section reads clearly
  • Confirm workspace-level page links to org exclusions
  • Spot-check Update/List Admin API pages (PUT/GET badges, params, curl examples, required scopes)
  • Confirm new scopes appear under Admin API key Organization Management in AuthN/AuthZ docs
  • Confirm Workspace Exclusions appears in Admin APIs nav with only two pages

Slack Thread

Open in Web Open in Cursor 

Add product guidance and Admin API reference pages for excluding
workspaces from organization default input/output guardrails.

Co-authored-by: Chandra Kiran G <kiran-4444@users.noreply.github.com>
@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
portkey-docs 🟢 Ready View Preview Jul 28, 2026, 3:58 PM

Merge the input/output-specific Admin API pages into a single update
and list reference that documents both entity-type endpoints.

Co-authored-by: Chandra Kiran G <kiran-4444@users.noreply.github.com>
Use Mintlify api frontmatter so the Admin API sidebar shows method
tags for the update and list workspace exclusions pages.

Co-authored-by: Chandra Kiran G <kiran-4444@users.noreply.github.com>
Add organisation_exclusions.update and .list to Admin API key scopes
and call them out on the workspace exclusions product and API pages.

Co-authored-by: Chandra Kiran G <kiran-4444@users.noreply.github.com>
@kiran-4444
kiran-4444 marked this pull request as ready for review July 28, 2026 16:13
@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
portkey-docs 🟡 Building Jul 28, 2026, 3:56 PM

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