Get Organization CLI
https://app.fossa.com/api/cli/organizationRetrieves organizations capability and preferences for CLI. This is used by CLI to infer default preference and capability of an organization. For example, 'supportsIssueDiffs' of True indicates to the CLI, that this organization, and this endpoint can support issue diffing. This endpoint accepts push-only tokens in addition to full API tokens.
Responses
200Organizations capability and preferences for CLIorganizationIdintegerUnique organization identifier
usesSAMLbooleanTrue if organization uses SAML, otherwise False.
supportsCliLicenseScanningbooleanTrue if organization supports CLI license scanning (native), otherwise False.
supportsAnalyzedRevisionsQuerybooleanTrue if organization supports analyzed revision query, otherwise False.
supportsDependenciesCachePollingbooleanTrue if organization supports dependencies cache polling, otherwise False.
supportsIssueDiffsbooleanTrue if organization supports issue diffing, otherwise False.
defaultVendoredDependencyScanTypeenumDefault vendor scanning preferred by the organization.
ArchiveUploadCLILicenseScansupportsNativeContainerScansbooleanTrue if organization supports native container scanning, otherwise False.
requireFullFileUploadsbooleanTrue if the organization wants CLI-side license scans to upload full file contents instead of just the match string
supportsPathDependencybooleanTrue if the organization supports path dependencies. Otherwise False.
supportsFirstPartyScansbooleanTrue if the FOSSA instance supports first-party scans. Otherwise False.
defaultToFirstPartyScansbooleanTrue if the organization defaults to first-party scans. Otherwise False.
customLicenseScanConfigsobject[]Configuration for custom license scans
namestringcustom license scan name
matchCriteriastringregular expression for the custom license scan
requirePolicyOnUploadbooleanTrue if the organization requires a policy to be assigned when uploading, otherwise False.
archiveUploadAndCLILicenseScanEnabledbooleanTrue if the organization is permissioned for CLI license scanning and archive uploads, otherwise False.
supportsPreflightChecksbooleanTrue if the organization supports CLI preflight checks, otherwise False.
supportsGitBackedCargoLocatorsbooleanTrue if Core understands git-backed cargo locators in the format `cargo+<repoUrl>#<crateName>$<version>`. When False, the CLI should fall back to plain crate names for git-sourced cargo dependencies.
supportsFasterRGAddProjectbooleanTrue if Core exposes the `cli/project_group/release_lookup` endpoint, which resolves a release group title and release title to their numeric ids server-side. When False, the CLI falls back to listing all release groups and releases and filtering client-side.
subscriptionenumThe organization subscription access level.
FreePremiumpackageLabelScopesenum[]The package label scopes supported by the organization.
snippetScanSourceCodeRetentionDaysintegerNumber of days source code from snippet scans is retained for the organization.
401Unauthenticated RequestuuidstringUnique identifier associated with the error
codeintegerfossa specific error code
messagestringmessage associated with this error
namestringname of the error
httpStatusCodeintegerhttp status code number
Try this endpoint
Build a request and run it against app.fossa.com.
Stored in this browser for 24 hours. Try It uses a docs proxy for CORS and does not store tokens server-side.
GET https://app.fossa.com/api/cli/organizationcurl --request GET \ --url 'https://app.fossa.com/api/cli/organization' \ --header 'accept: application/json' \ --header 'authorization: Bearer YOUR_API_TOKEN'Real request. Mutating methods can change data.