Update from code changes: document /user/orgs portal + brand fields#97
Open
mintlify[bot] wants to merge 2 commits into
Open
Update from code changes: document /user/orgs portal + brand fields#97mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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.
Summary
Document the new organization visibility, brand metadata, and portal customization fields returned by the
/user/orgsand/user/orgs/{slug}endpoints.Changes
external-api/user-orgs-list.mdxandexternal-api/user-orgs-get.mdxcovering the endpoints, with detailed reference tables and use cases for the newportalVisibility,reportVisibility,metricsVisibility,brandMetadata, andportalCustomizationfields.docs.json.concepts/security-portal.mdxwith 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):portalVisibilityon/user/orgs, SDK, and CLINote
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-listanduser-orgs-getdescribePOST /user/orgsandGET /user/orgs/{slug}: auth behavior, full reference forportalVisibility,reportVisibility,metricsVisibility,brandMetadata, andportalCustomization, plus examples and audit-oriented use cases (visibility grouping, missing security contact, empty banner).docs.jsonadds an API Reference User group pointing at those pages.concepts/security-portalupdates the meta description and adds Reading Portal Configuration via the API, mapping dashboard toggles to the same fields and the SDKUserOrgshape.Reviewed by Cursor Bugbot for commit b6a7919. Bugbot is set up for automated code reviews on this repo. Configure here.