Update from code changes: document INACTIVE subscription-status filter - #127
Open
mintlify[bot] wants to merge 1 commit into
Open
Update from code changes: document INACTIVE subscription-status filter#127mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit 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
The
subscriptionStatusfilter onPOST /user/orgs(and theallMyOrgspath ofGET /organization/metrics) and the CLI's--subscription-statusflag now acceptINACTIVE, so churned organizations can be listed by explicitly asking for them.Changes
cli/commands/orgs.mdx: addedINACTIVEto the--subscription-statusvalues, noted the live-status default, and added a churned-orgs example.cli/commands/metrics.mdx: addedINACTIVEto the--subscription-statusvalues formetrics organization --all-my-orgswith the default noted.external-api/user-orgs.mdx: replaced the stale "INACTIVEorganizations are always excluded" note with the filterable-vs-default split and the unchanged access scoping.Context
Source: chainpatrol/chainpatrol-web#7745 ("Allow listing inactive organizations"). Defaults are unchanged: unfiltered calls still return only
PROSPECT,POC,ACTIVE, andINTEGRATION.Note
Low Risk
Documentation-only updates with no code or runtime behavior changes in this repository.
Overview
Documentation now matches the platform change that lets callers explicitly include churned organizations via
INACTIVEon org listing and multi-org metrics, while defaults stay the same (only live statuses:PROSPECT,POC,ACTIVE,INTEGRATION).CLI (
orgs listandmetrics organization --all-my-orgs):--subscription-statuslistsINACTIVEas an allowed value, explains the live-status default, and adds an example for inactive orgs still running detection.API (
POST /user/orgs): Replaces the incorrect note that inactive orgs are always excluded with the same default-vs-explicit-INACTIVEbehavior and clarifies that the filter does not broaden credential access.Reviewed by Cursor Bugbot for commit 553538e. Bugbot is set up for automated code reviews on this repo. Configure here.