Skip to content

Update from code changes: document /user/orgs portal + brand fields#97

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/ef5de647
Open

Update from code changes: document /user/orgs portal + brand fields#97
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/ef5de647

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Document the new organization visibility, brand metadata, and portal customization fields returned by the /user/orgs and /user/orgs/{slug} endpoints.

Changes

  • Added external-api/user-orgs-list.mdx and external-api/user-orgs-get.mdx covering the endpoints, with detailed reference tables and use cases for the new portalVisibility, reportVisibility, metricsVisibility, brandMetadata, and portalCustomization fields.
  • Added a new "User" group to the API Reference nav in docs.json.
  • Extended concepts/security-portal.mdx with a section linking each dashboard control to the corresponding API field, so readers can move between the concept page and the endpoint reference.

Context

Follows upstream feature work that surfaces these fields on the external API, JavaScript SDK (UserOrg), and CLI (chainpatrol orgs get / orgs list):

  • chainpatrol/chainpatrol-web#7077 — surface portalVisibility on /user/orgs, SDK, and CLI
  • chainpatrol/chainpatrol-web#7081 — surface report/metrics visibility, brand metadata, and portal customization

Note

Low Risk
Documentation-only changes with no runtime, auth, or data-handling impact.

Overview
Documents the User org endpoints and the portal / brand / customization fields recently added to their responses.

New pages user-orgs-list and user-orgs-get describe POST /user/orgs and GET /user/orgs/{slug}: auth behavior, full reference for portalVisibility, reportVisibility, metricsVisibility, brandMetadata, and portalCustomization, plus examples and audit-oriented use cases (visibility grouping, missing security contact, empty banner).

docs.json adds an API Reference User group pointing at those pages. concepts/security-portal updates the meta description and adds Reading Portal Configuration via the API, mapping dashboard toggles to the same fields and the SDK UserOrg shape.

Reviewed by Cursor Bugbot for commit b6a7919. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify
mintlify Bot requested a review from NikitaVr July 7, 2026 13:13
@mintlify

mintlify Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
chainpatrol 🔴 Failed Jul 7, 2026, 1:18 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.

0 participants