openapi: 3.0.0 info: description: Socket org settings API endpoints. title: Socket Org Settings API version: '0' servers: - url: https://api.socket.dev/v0 paths: /orgs/{org_slug}/settings/integrations/{integration_id}/events: get: tags: - org-settings summary: Get integration events operationId: getIntegrationEvents parameters: - name: org_slug in: path required: true description: The slug of the organization schema: type: string - name: integration_id in: path required: true description: The id of the integration schema: type: string security: - bearerAuth: - integration:list - basicAuth: - integration:list description: 'This endpoint consumes 1 unit of your quota. This endpoint requires the following org token scopes: - integration:list' responses: '200': content: application/json: schema: type: array items: type: object additionalProperties: false description: '' properties: id: type: string description: '' default: '' integration_id: type: string description: '' default: '' type: type: string description: '' default: '' payload: type: object additionalProperties: false description: '' properties: {} status_code: type: integer description: '' default: 0 error: type: string description: '' default: '' sent_at: type: string description: '' default: '' retry_info: type: array items: type: object additionalProperties: false description: '' properties: status_code: type: integer description: '' default: 0 error: type: string description: '' default: '' sent_at: type: string description: '' default: '' required: - error - sent_at - status_code description: '' created_at: type: string description: '' default: '' updated_at: type: string description: '' default: '' required: - created_at - error - id - integration_id - payload - retry_info - sent_at - status_code - type - updated_at description: '' description: Lists events for the specified integration. The authenticated user must be a member of the organization. '400': $ref: '#/components/responses/SocketBadRequest' '401': $ref: '#/components/responses/SocketUnauthorized' '403': $ref: '#/components/responses/SocketForbidden' '404': $ref: '#/components/responses/SocketNotFoundResponse' '429': $ref: '#/components/responses/SocketTooManyRequestsResponse' x-readme: {} /orgs/{org_slug}/settings/security-policy: get: tags: - security-policy summary: Get Organization Security Policy operationId: getOrgSecurityPolicy parameters: - name: org_slug in: path required: true description: The slug of the organization schema: type: string - name: custom_rules_only in: query required: false description: Return only customized security policy rules. schema: type: boolean default: false security: - bearerAuth: - security-policy:read - basicAuth: - security-policy:read description: 'Retrieve the security policy of an organization. This endpoint consumes 1 unit of your quota. This endpoint requires the following org token scopes: - security-policy:read' responses: '200': content: application/json: schema: type: object additionalProperties: false properties: securityPolicyRules: type: object additionalProperties: false properties: gptSecurity: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gptSecurity issues. required: - action gptAnomaly: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gptAnomaly issues. required: - action gptMalware: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gptMalware issues. required: - action filesystemAccess: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for filesystemAccess issues. required: - action networkAccess: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for networkAccess issues. required: - action shellAccess: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for shellAccess issues. required: - action debugAccess: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for debugAccess issues. required: - action chromePermission: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for chromePermission issues. required: - action chromeHostPermission: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for chromeHostPermission issues. required: - action chromeWildcardHostPermission: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for chromeWildcardHostPermission issues. required: - action chromeContentScript: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for chromeContentScript issues. required: - action criticalCVE: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for criticalCVE issues. required: - action cve: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for cve issues. required: - action mediumCVE: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for mediumCVE issues. required: - action mildCVE: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for mildCVE issues. required: - action emptyPackage: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for emptyPackage issues. required: - action trivialPackage: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for trivialPackage issues. required: - action noREADME: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noREADME issues. required: - action shrinkwrap: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for shrinkwrap issues. required: - action tooManyFiles: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for tooManyFiles issues. required: - action generic: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for generic issues. required: - action ghaArgToSink: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaArgToSink issues. required: - action ghaEnvToSink: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaEnvToSink issues. required: - action ghaContextToSink: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaContextToSink issues. required: - action ghaArgToOutput: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaArgToOutput issues. required: - action ghaArgToEnv: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaArgToEnv issues. required: - action ghaContextToOutput: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaContextToOutput issues. required: - action ghaContextToEnv: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaContextToEnv issues. required: - action recentlyPublished: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for recentlyPublished issues. required: - action licenseSpdxDisj: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for licenseSpdxDisj issues. required: - action unsafeCopyright: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unsafeCopyright issues. required: - action licenseChange: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for licenseChange issues. required: - action nonOSILicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for nonOSILicense issues. required: - action deprecatedLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for deprecatedLicense issues. required: - action missingLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for missingLicense issues. required: - action nonSPDXLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for nonSPDXLicense issues. required: - action unclearLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unclearLicense issues. required: - action mixedLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for mixedLicense issues. required: - action notice: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for notice issues. required: - action modifiedLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for modifiedLicense issues. required: - action modifiedException: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for modifiedException issues. required: - action licenseException: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for licenseException issues. required: - action deprecatedException: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for deprecatedException issues. required: - action miscLicenseIssues: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for miscLicenseIssues issues. required: - action unidentifiedLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unidentifiedLicense issues. required: - action noLicenseFound: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noLicenseFound issues. required: - action explicitlyUnlicensedItem: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for explicitlyUnlicensedItem issues. required: - action copyleftLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for copyleftLicense issues. required: - action nonpermissiveLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for nonpermissiveLicense issues. required: - action ambiguousClassifier: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ambiguousClassifier issues. required: - action invalidPackageJSON: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for invalidPackageJSON issues. required: - action httpDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for httpDependency issues. required: - action gitDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gitDependency issues. required: - action gitHubDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gitHubDependency issues. required: - action fileDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for fileDependency issues. required: - action noTests: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noTests issues. required: - action noRepository: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noRepository issues. required: - action badSemver: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for badSemver issues. required: - action badSemverDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for badSemverDependency issues. required: - action noV1: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noV1 issues. required: - action noWebsite: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noWebsite issues. required: - action noBugTracker: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noBugTracker issues. required: - action noAuthorData: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noAuthorData issues. required: - action typeModuleCompatibility: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for typeModuleCompatibility issues. required: - action floatingDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for floatingDependency issues. required: - action manifestConfusion: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for manifestConfusion issues. required: - action malware: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for malware issues. required: - action telemetry: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for telemetry issues. required: - action troll: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for troll issues. required: - action pendingScan: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for pendingScan issues. required: - action deprecated: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for deprecated issues. required: - action chronoAnomaly: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for chronoAnomaly issues. required: - action compromisedSSHKey: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for compromisedSSHKey issues. required: - action semverAnomaly: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for semverAnomaly issues. required: - action newAuthor: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for newAuthor issues. required: - action unstableOwnership: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unstableOwnership issues. required: - action missingAuthor: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for missingAuthor issues. required: - action unmaintained: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unmaintained issues. required: - action unpublished: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unpublished issues. required: - action majorRefactor: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for majorRefactor issues. required: - action missingTarball: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for missingTarball issues. required: - action suspiciousStarActivity: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for suspiciousStarActivity issues. required: - action notFound: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for notFound issues. required: - action unpopularPackage: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unpopularPackage issues. required: - action policy: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for policy issues. required: - action skillAutonomyAbuse: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillAutonomyAbuse issues. required: - action skillCommandInjection: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillCommandInjection issues. required: - action skillDataExfiltration: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillDataExfiltration issues. required: - action skillDiscoveryAbuse: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillDiscoveryAbuse issues. required: - action skillHardcodedSecrets: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillHardcodedSecrets issues. required: - action skillObfuscation: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillObfuscation issues. required: - action skillPreExecution: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillPreExecution issues. required: - action skillPromptInjection: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillPromptInjection issues. required: - action skillResourceAbuse: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillResourceAbuse issues. required: - action skillSupplyChain: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillSupplyChain issues. required: - action skillToolAbuse: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillToolAbuse issues. required: - action skillToolChaining: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillToolChaining issues. required: - action skillTransitiveTrust: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillTransitiveTrust issues. required: - action socketUpgradeAvailable: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for socketUpgradeAvailable issues. required: - action longStrings: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for longStrings issues. required: - action highEntropyStrings: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for highEntropyStrings issues. required: - action urlStrings: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for urlStrings issues. required: - action usesEval: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for usesEval issues. required: - action dynamicRequire: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for dynamicRequire issues. required: - action envVars: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for envVars issues. required: - action missingDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for missingDependency issues. required: - action unusedDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unusedDependency issues. required: - action peerDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for peerDependency issues. required: - action uncaughtOptionalDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for uncaughtOptionalDependency issues. required: - action unresolvedRequire: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unresolvedRequire issues. required: - action extraneousDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for extraneousDependency issues. required: - action obfuscatedRequire: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for obfuscatedRequire issues. required: - action obfuscatedFile: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for obfuscatedFile issues. required: - action minifiedFile: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for minifiedFile issues. required: - action installScripts: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for installScripts issues. required: - action hasNativeCode: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for hasNativeCode issues. required: - action binScriptConfusion: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for binScriptConfusion issues. required: - action shellScriptOverride: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for shellScriptOverride issues. required: - action didYouMean: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for didYouMean issues. required: - action gptDidYouMean: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gptDidYouMean issues. required: - action bidi: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for bidi issues. required: - action zeroWidth: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for zeroWidth issues. required: - action badEncoding: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for badEncoding issues. required: - action homoglyphs: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for homoglyphs issues. required: - action invisibleChars: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for invisibleChars issues. required: - action suspiciousString: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for suspiciousString issues. required: - action potentialVulnerability: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for potentialVulnerability issues. required: - action vsxProposedApiUsage: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxProposedApiUsage issues. required: - action vsxActivationWildcard: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxActivationWildcard issues. required: - action vsxWorkspaceContainsActivation: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxWorkspaceContainsActivation issues. required: - action vsxUntrustedWorkspaceSupported: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxUntrustedWorkspaceSupported issues. required: - action vsxVirtualWorkspaceSupported: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxVirtualWorkspaceSupported issues. required: - action vsxWebviewContribution: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxWebviewContribution issues. required: - action vsxDebuggerContribution: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxDebuggerContribution issues. required: - action vsxExtensionDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxExtensionDependency issues. required: - action vsxExtensionPack: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxExtensionPack issues. required: - action description: '' securityPolicyDefault: type: string enum: - default - low - medium - high description: The default security policy for the organization default: default description: '' description: Retrieved security policy details '400': $ref: '#/components/responses/SocketBadRequest' '401': $ref: '#/components/responses/SocketUnauthorized' '403': $ref: '#/components/responses/SocketForbidden' '404': $ref: '#/components/responses/SocketNotFoundResponse' '429': $ref: '#/components/responses/SocketTooManyRequestsResponse' x-readme: {} post: tags: - security-policy summary: Update Security Policy operationId: updateOrgSecurityPolicy parameters: - name: org_slug in: path required: true description: The slug of the organization schema: type: string - name: custom_rules_only in: query required: false description: Return only customized security policy rules in the response. schema: type: boolean default: false requestBody: content: application/json: schema: type: object additionalProperties: false properties: policyDefault: type: string enum: - default - low - medium - high description: The default security policy for the organization policyRules: type: object additionalProperties: false properties: gptSecurity: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gptSecurity issues. required: - action gptAnomaly: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gptAnomaly issues. required: - action gptMalware: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gptMalware issues. required: - action filesystemAccess: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for filesystemAccess issues. required: - action networkAccess: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for networkAccess issues. required: - action shellAccess: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for shellAccess issues. required: - action debugAccess: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for debugAccess issues. required: - action chromePermission: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for chromePermission issues. required: - action chromeHostPermission: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for chromeHostPermission issues. required: - action chromeWildcardHostPermission: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for chromeWildcardHostPermission issues. required: - action chromeContentScript: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for chromeContentScript issues. required: - action criticalCVE: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for criticalCVE issues. required: - action cve: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for cve issues. required: - action mediumCVE: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for mediumCVE issues. required: - action mildCVE: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for mildCVE issues. required: - action emptyPackage: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for emptyPackage issues. required: - action trivialPackage: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for trivialPackage issues. required: - action noREADME: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noREADME issues. required: - action shrinkwrap: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for shrinkwrap issues. required: - action tooManyFiles: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for tooManyFiles issues. required: - action generic: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for generic issues. required: - action ghaArgToSink: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaArgToSink issues. required: - action ghaEnvToSink: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaEnvToSink issues. required: - action ghaContextToSink: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaContextToSink issues. required: - action ghaArgToOutput: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaArgToOutput issues. required: - action ghaArgToEnv: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaArgToEnv issues. required: - action ghaContextToOutput: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaContextToOutput issues. required: - action ghaContextToEnv: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaContextToEnv issues. required: - action recentlyPublished: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for recentlyPublished issues. required: - action licenseSpdxDisj: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for licenseSpdxDisj issues. required: - action unsafeCopyright: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unsafeCopyright issues. required: - action licenseChange: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for licenseChange issues. required: - action nonOSILicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for nonOSILicense issues. required: - action deprecatedLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for deprecatedLicense issues. required: - action missingLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for missingLicense issues. required: - action nonSPDXLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for nonSPDXLicense issues. required: - action unclearLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unclearLicense issues. required: - action mixedLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for mixedLicense issues. required: - action notice: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for notice issues. required: - action modifiedLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for modifiedLicense issues. required: - action modifiedException: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for modifiedException issues. required: - action licenseException: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for licenseException issues. required: - action deprecatedException: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for deprecatedException issues. required: - action miscLicenseIssues: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for miscLicenseIssues issues. required: - action unidentifiedLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unidentifiedLicense issues. required: - action noLicenseFound: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noLicenseFound issues. required: - action explicitlyUnlicensedItem: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for explicitlyUnlicensedItem issues. required: - action copyleftLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for copyleftLicense issues. required: - action nonpermissiveLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for nonpermissiveLicense issues. required: - action ambiguousClassifier: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ambiguousClassifier issues. required: - action invalidPackageJSON: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for invalidPackageJSON issues. required: - action httpDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for httpDependency issues. required: - action gitDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gitDependency issues. required: - action gitHubDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gitHubDependency issues. required: - action fileDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for fileDependency issues. required: - action noTests: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noTests issues. required: - action noRepository: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noRepository issues. required: - action badSemver: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for badSemver issues. required: - action badSemverDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for badSemverDependency issues. required: - action noV1: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noV1 issues. required: - action noWebsite: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noWebsite issues. required: - action noBugTracker: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noBugTracker issues. required: - action noAuthorData: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noAuthorData issues. required: - action typeModuleCompatibility: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for typeModuleCompatibility issues. required: - action floatingDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for floatingDependency issues. required: - action manifestConfusion: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for manifestConfusion issues. required: - action malware: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for malware issues. required: - action telemetry: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for telemetry issues. required: - action troll: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for troll issues. required: - action pendingScan: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for pendingScan issues. required: - action deprecated: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for deprecated issues. required: - action chronoAnomaly: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for chronoAnomaly issues. required: - action compromisedSSHKey: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for compromisedSSHKey issues. required: - action semverAnomaly: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for semverAnomaly issues. required: - action newAuthor: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for newAuthor issues. required: - action unstableOwnership: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unstableOwnership issues. required: - action missingAuthor: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for missingAuthor issues. required: - action unmaintained: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unmaintained issues. required: - action unpublished: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unpublished issues. required: - action majorRefactor: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for majorRefactor issues. required: - action missingTarball: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for missingTarball issues. required: - action suspiciousStarActivity: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for suspiciousStarActivity issues. required: - action notFound: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for notFound issues. required: - action unpopularPackage: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unpopularPackage issues. required: - action policy: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for policy issues. required: - action skillAutonomyAbuse: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillAutonomyAbuse issues. required: - action skillCommandInjection: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillCommandInjection issues. required: - action skillDataExfiltration: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillDataExfiltration issues. required: - action skillDiscoveryAbuse: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillDiscoveryAbuse issues. required: - action skillHardcodedSecrets: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillHardcodedSecrets issues. required: - action skillObfuscation: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillObfuscation issues. required: - action skillPreExecution: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillPreExecution issues. required: - action skillPromptInjection: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillPromptInjection issues. required: - action skillResourceAbuse: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillResourceAbuse issues. required: - action skillSupplyChain: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillSupplyChain issues. required: - action skillToolAbuse: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillToolAbuse issues. required: - action skillToolChaining: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillToolChaining issues. required: - action skillTransitiveTrust: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillTransitiveTrust issues. required: - action socketUpgradeAvailable: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for socketUpgradeAvailable issues. required: - action longStrings: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for longStrings issues. required: - action highEntropyStrings: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for highEntropyStrings issues. required: - action urlStrings: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for urlStrings issues. required: - action usesEval: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for usesEval issues. required: - action dynamicRequire: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for dynamicRequire issues. required: - action envVars: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for envVars issues. required: - action missingDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for missingDependency issues. required: - action unusedDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unusedDependency issues. required: - action peerDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for peerDependency issues. required: - action uncaughtOptionalDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for uncaughtOptionalDependency issues. required: - action unresolvedRequire: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unresolvedRequire issues. required: - action extraneousDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for extraneousDependency issues. required: - action obfuscatedRequire: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for obfuscatedRequire issues. required: - action obfuscatedFile: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for obfuscatedFile issues. required: - action minifiedFile: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for minifiedFile issues. required: - action installScripts: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for installScripts issues. required: - action hasNativeCode: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for hasNativeCode issues. required: - action binScriptConfusion: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for binScriptConfusion issues. required: - action shellScriptOverride: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for shellScriptOverride issues. required: - action didYouMean: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for didYouMean issues. required: - action gptDidYouMean: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gptDidYouMean issues. required: - action bidi: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for bidi issues. required: - action zeroWidth: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for zeroWidth issues. required: - action badEncoding: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for badEncoding issues. required: - action homoglyphs: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for homoglyphs issues. required: - action invisibleChars: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for invisibleChars issues. required: - action suspiciousString: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for suspiciousString issues. required: - action potentialVulnerability: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for potentialVulnerability issues. required: - action vsxProposedApiUsage: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxProposedApiUsage issues. required: - action vsxActivationWildcard: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxActivationWildcard issues. required: - action vsxWorkspaceContainsActivation: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxWorkspaceContainsActivation issues. required: - action vsxUntrustedWorkspaceSupported: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxUntrustedWorkspaceSupported issues. required: - action vsxVirtualWorkspaceSupported: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxVirtualWorkspaceSupported issues. required: - action vsxWebviewContribution: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxWebviewContribution issues. required: - action vsxDebuggerContribution: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxDebuggerContribution issues. required: - action vsxExtensionDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxExtensionDependency issues. required: - action vsxExtensionPack: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxExtensionPack issues. required: - action description: '' resetPolicyRules: type: boolean default: false description: Reset the policy rules to the default. When set to true, do not include any policyRules updates. description: '' required: false security: - bearerAuth: - security-policy:update - basicAuth: - security-policy:update description: 'Update the security policy of an organization. This endpoint consumes 1 unit of your quota. This endpoint requires the following org token scopes: - security-policy:update' responses: '200': content: application/json: schema: type: object additionalProperties: false properties: securityPolicyRules: type: object additionalProperties: false properties: gptSecurity: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gptSecurity issues. required: - action gptAnomaly: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gptAnomaly issues. required: - action gptMalware: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gptMalware issues. required: - action filesystemAccess: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for filesystemAccess issues. required: - action networkAccess: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for networkAccess issues. required: - action shellAccess: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for shellAccess issues. required: - action debugAccess: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for debugAccess issues. required: - action chromePermission: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for chromePermission issues. required: - action chromeHostPermission: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for chromeHostPermission issues. required: - action chromeWildcardHostPermission: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for chromeWildcardHostPermission issues. required: - action chromeContentScript: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for chromeContentScript issues. required: - action criticalCVE: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for criticalCVE issues. required: - action cve: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for cve issues. required: - action mediumCVE: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for mediumCVE issues. required: - action mildCVE: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for mildCVE issues. required: - action emptyPackage: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for emptyPackage issues. required: - action trivialPackage: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for trivialPackage issues. required: - action noREADME: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noREADME issues. required: - action shrinkwrap: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for shrinkwrap issues. required: - action tooManyFiles: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for tooManyFiles issues. required: - action generic: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for generic issues. required: - action ghaArgToSink: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaArgToSink issues. required: - action ghaEnvToSink: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaEnvToSink issues. required: - action ghaContextToSink: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaContextToSink issues. required: - action ghaArgToOutput: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaArgToOutput issues. required: - action ghaArgToEnv: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaArgToEnv issues. required: - action ghaContextToOutput: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaContextToOutput issues. required: - action ghaContextToEnv: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ghaContextToEnv issues. required: - action recentlyPublished: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for recentlyPublished issues. required: - action licenseSpdxDisj: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for licenseSpdxDisj issues. required: - action unsafeCopyright: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unsafeCopyright issues. required: - action licenseChange: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for licenseChange issues. required: - action nonOSILicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for nonOSILicense issues. required: - action deprecatedLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for deprecatedLicense issues. required: - action missingLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for missingLicense issues. required: - action nonSPDXLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for nonSPDXLicense issues. required: - action unclearLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unclearLicense issues. required: - action mixedLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for mixedLicense issues. required: - action notice: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for notice issues. required: - action modifiedLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for modifiedLicense issues. required: - action modifiedException: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for modifiedException issues. required: - action licenseException: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for licenseException issues. required: - action deprecatedException: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for deprecatedException issues. required: - action miscLicenseIssues: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for miscLicenseIssues issues. required: - action unidentifiedLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unidentifiedLicense issues. required: - action noLicenseFound: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noLicenseFound issues. required: - action explicitlyUnlicensedItem: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for explicitlyUnlicensedItem issues. required: - action copyleftLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for copyleftLicense issues. required: - action nonpermissiveLicense: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for nonpermissiveLicense issues. required: - action ambiguousClassifier: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for ambiguousClassifier issues. required: - action invalidPackageJSON: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for invalidPackageJSON issues. required: - action httpDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for httpDependency issues. required: - action gitDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gitDependency issues. required: - action gitHubDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gitHubDependency issues. required: - action fileDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for fileDependency issues. required: - action noTests: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noTests issues. required: - action noRepository: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noRepository issues. required: - action badSemver: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for badSemver issues. required: - action badSemverDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for badSemverDependency issues. required: - action noV1: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noV1 issues. required: - action noWebsite: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noWebsite issues. required: - action noBugTracker: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noBugTracker issues. required: - action noAuthorData: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for noAuthorData issues. required: - action typeModuleCompatibility: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for typeModuleCompatibility issues. required: - action floatingDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for floatingDependency issues. required: - action manifestConfusion: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for manifestConfusion issues. required: - action malware: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for malware issues. required: - action telemetry: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for telemetry issues. required: - action troll: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for troll issues. required: - action pendingScan: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for pendingScan issues. required: - action deprecated: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for deprecated issues. required: - action chronoAnomaly: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for chronoAnomaly issues. required: - action compromisedSSHKey: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for compromisedSSHKey issues. required: - action semverAnomaly: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for semverAnomaly issues. required: - action newAuthor: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for newAuthor issues. required: - action unstableOwnership: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unstableOwnership issues. required: - action missingAuthor: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for missingAuthor issues. required: - action unmaintained: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unmaintained issues. required: - action unpublished: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unpublished issues. required: - action majorRefactor: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for majorRefactor issues. required: - action missingTarball: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for missingTarball issues. required: - action suspiciousStarActivity: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for suspiciousStarActivity issues. required: - action notFound: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for notFound issues. required: - action unpopularPackage: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unpopularPackage issues. required: - action policy: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for policy issues. required: - action skillAutonomyAbuse: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillAutonomyAbuse issues. required: - action skillCommandInjection: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillCommandInjection issues. required: - action skillDataExfiltration: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillDataExfiltration issues. required: - action skillDiscoveryAbuse: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillDiscoveryAbuse issues. required: - action skillHardcodedSecrets: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillHardcodedSecrets issues. required: - action skillObfuscation: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillObfuscation issues. required: - action skillPreExecution: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillPreExecution issues. required: - action skillPromptInjection: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillPromptInjection issues. required: - action skillResourceAbuse: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillResourceAbuse issues. required: - action skillSupplyChain: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillSupplyChain issues. required: - action skillToolAbuse: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillToolAbuse issues. required: - action skillToolChaining: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillToolChaining issues. required: - action skillTransitiveTrust: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for skillTransitiveTrust issues. required: - action socketUpgradeAvailable: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for socketUpgradeAvailable issues. required: - action longStrings: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for longStrings issues. required: - action highEntropyStrings: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for highEntropyStrings issues. required: - action urlStrings: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for urlStrings issues. required: - action usesEval: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for usesEval issues. required: - action dynamicRequire: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for dynamicRequire issues. required: - action envVars: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for envVars issues. required: - action missingDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for missingDependency issues. required: - action unusedDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unusedDependency issues. required: - action peerDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for peerDependency issues. required: - action uncaughtOptionalDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for uncaughtOptionalDependency issues. required: - action unresolvedRequire: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for unresolvedRequire issues. required: - action extraneousDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for extraneousDependency issues. required: - action obfuscatedRequire: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for obfuscatedRequire issues. required: - action obfuscatedFile: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for obfuscatedFile issues. required: - action minifiedFile: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for minifiedFile issues. required: - action installScripts: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for installScripts issues. required: - action hasNativeCode: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for hasNativeCode issues. required: - action binScriptConfusion: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for binScriptConfusion issues. required: - action shellScriptOverride: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for shellScriptOverride issues. required: - action didYouMean: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for didYouMean issues. required: - action gptDidYouMean: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for gptDidYouMean issues. required: - action bidi: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for bidi issues. required: - action zeroWidth: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for zeroWidth issues. required: - action badEncoding: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for badEncoding issues. required: - action homoglyphs: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for homoglyphs issues. required: - action invisibleChars: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for invisibleChars issues. required: - action suspiciousString: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for suspiciousString issues. required: - action potentialVulnerability: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for potentialVulnerability issues. required: - action vsxProposedApiUsage: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxProposedApiUsage issues. required: - action vsxActivationWildcard: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxActivationWildcard issues. required: - action vsxWorkspaceContainsActivation: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxWorkspaceContainsActivation issues. required: - action vsxUntrustedWorkspaceSupported: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxUntrustedWorkspaceSupported issues. required: - action vsxVirtualWorkspaceSupported: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxVirtualWorkspaceSupported issues. required: - action vsxWebviewContribution: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxWebviewContribution issues. required: - action vsxDebuggerContribution: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxDebuggerContribution issues. required: - action vsxExtensionDependency: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxExtensionDependency issues. required: - action vsxExtensionPack: type: object additionalProperties: false description: '' properties: action: type: string enum: - defer - error - warn - monitor - ignore description: The action to take for vsxExtensionPack issues. required: - action description: '' securityPolicyDefault: type: string enum: - default - low - medium - high description: The default security policy for the organization default: default description: '' description: Updated repository details '400': $ref: '#/components/responses/SocketBadRequest' '401': $ref: '#/components/responses/SocketUnauthorized' '403': $ref: '#/components/responses/SocketForbidden' '404': $ref: '#/components/responses/SocketNotFoundResponse' '429': $ref: '#/components/responses/SocketTooManyRequestsResponse' x-readme: {} /orgs/{org_slug}/settings/license-policy: post: tags: - license-policy summary: Update License Policy operationId: updateOrgLicensePolicy parameters: - name: org_slug in: path required: true description: The slug of the organization schema: type: string - name: merge_update in: query required: true description: Merge the policy update with the existing policy. Default is true. If false, the existing policy will be replaced with the new policy. schema: type: boolean default: false requestBody: content: application/json: schema: type: object description: '' default: null required: false security: - bearerAuth: - license-policy:update - basicAuth: - license-policy:update description: "Set the organization's license policy\n\n ## License policy schema\n\n```json\n{\n allow?: Array\n warn?: Array\n options?: Array\n}\n```\n\nElements\ \ of the `allow` and `warn` arrays strings representing items which should be allowed, or which should trigger a warning; license data found in package which not present in either array will produce\ \ a license violation (effectively a \"hard\" error). For example, to allow Apache-2.0 and MIT to the allow list, simply add the strings \"Apache-2.0\" and \"MIT\" to the `allow` array. Strings\ \ appearing in these arrays are generally \"what you see is what you get\", with two important exceptions: strings which are recognized as license classes and strings which are recognized as PURLs\ \ are handled differently to allow for more flexible license policy creation.\n\n## License Classes\n\nStrings which are license classes will expand to a list of licenses known to be in that particular\ \ license class. Recognized license classes are:\n 'permissive',\n 'permissive (model)',\n 'permissive (gold)',\n 'permissive (silver)',\n 'permissive (bronze)',\n 'permissive (lead)',\n \ \ 'copyleft',\n 'maximal copyleft',\n 'network copyleft',\n 'strong copyleft',\n 'weak copyleft',\n 'contributor license agreement',\n 'public domain',\n 'proprietary free',\n 'source available',\n\ \ 'proprietary',\n 'commercial',\n 'patent'\n\nUsers can learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading\ \ the linked resources.\n\n\n## PURLs\n\nUsers may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support\ \ glob patterns to allow a range of versions, files and directories, etc.\n\npurl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily\ \ used for allowing data from registry metadata).\n\n### Examples:\nAllow all license data found in a specific version of a package 4.14.1: `pkg:npm/lodash@4.14.1`\nAllow all license data found\ \ in a version range of a package: `pkg:npm/lodash?version_glob=15.*`\nAllow all license data in the test directory of a given package for certain version ranges: `pkg:npm/lodash@15.*.*?file_name=lodash/test/*`\n\ Allow all license data taken from the package registry for a package and version range: `pkg:npm/lodash?version_glob=*&license_provenance=registry_metadata`\n\n## Available options\n\n`toplevelOnly`:\ \ only apply the license policy to \"top level\" license data in a package, which includes registry metadata, LICENSE files, and manifest files which are closest to the root of the package.\n\n\ `applyToUnidentified`: Apply license policy to found but unidentified license data. If enabled, the license policy will be applied to license data which could not be affirmatively identified as\ \ a known license (this will effectively merge the license policy violation and unidentified license alerts). If disabled, license policy alerts will only be shown for license data which is positively\ \ identified as something not allowed or set to warn by the license policy.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- license-policy:update" responses: '200': content: application/json: schema: type: object description: '' default: null description: Updated repository details '400': $ref: '#/components/responses/SocketBadRequest' '401': $ref: '#/components/responses/SocketUnauthorized' '403': $ref: '#/components/responses/SocketForbidden' '404': $ref: '#/components/responses/SocketNotFoundResponse' '429': $ref: '#/components/responses/SocketTooManyRequestsResponse' x-readme: {} /orgs/{org_slug}/settings/license-policy/view: get: tags: - license-policy summary: Get License Policy (Beta) operationId: viewLicensePolicy parameters: - name: org_slug in: path required: true description: The slug of the organization schema: type: string security: - bearerAuth: - license-policy:read - basicAuth: - license-policy:read description: 'Returns an organization''s license policy including allow, warn, monitor, and deny categories. The deny category contains all licenses that are not explicitly categorized as allow, warn, or monitor. This endpoint consumes 1 unit of your quota. This endpoint requires the following org token scopes: - license-policy:read' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SStoredLicensePolicy' description: Saturated License Allow List '400': $ref: '#/components/responses/SocketBadRequest' '401': $ref: '#/components/responses/SocketUnauthorized' '403': $ref: '#/components/responses/SocketForbidden' '404': $ref: '#/components/responses/SocketNotFoundResponse' '429': $ref: '#/components/responses/SocketTooManyRequestsResponse' '500': $ref: '#/components/responses/SocketInternalServerError' x-readme: {} /orgs/{org_slug}/settings/socket-basics: get: tags: - org-settings summary: Get Socket Basics configuration, including toggles for the various tools it supports. operationId: getSocketBasicsConfig parameters: - name: org_slug in: path required: true description: The slug of the organization schema: type: string security: - bearerAuth: - socket-basics:read - basicAuth: - socket-basics:read description: 'Socket Basics is a CI/CD security scanning suite that runs on your source code, designed to complement Socket SCA and provide full coverage. - **SAST** - Find issues and risks with your code via static analysis using best in class Open Source tools - **Secret Scanning** - Detected potentially leaked secrets and credentials within your code - **Container Security** - Docker image and Dockerfile vulnerability scanning This endpoint consumes 1 unit of your quota. This endpoint requires the following org token scopes: - socket-basics:read' responses: '200': content: application/json: schema: type: object additionalProperties: false properties: consoleTabularEnabled: type: boolean default: false description: Enable tabular console output consoleJsonEnabled: type: boolean default: false description: Enable JSON console output verbose: type: boolean default: false description: Enable verbose logging allLanguagesEnabled: type: boolean default: false description: Enable all language SAST scanning pythonSastEnabled: type: boolean default: false description: Run Python SAST scanning javascriptSastEnabled: type: boolean default: false description: Run JavaScript SAST scanning goSastEnabled: type: boolean default: false description: Run Go SAST scanning golangSastEnabled: type: boolean default: false description: Run Golang SAST scanning javaSastEnabled: type: boolean default: false description: Run Java SAST scanning phpSastEnabled: type: boolean default: false description: Run PHP SAST scanning rubySastEnabled: type: boolean default: false description: Run Ruby SAST scanning csharpSastEnabled: type: boolean default: false description: Run C# SAST scanning dotnetSastEnabled: type: boolean default: false description: Run .NET SAST scanning cSastEnabled: type: boolean default: false description: Run C SAST scanning cppSastEnabled: type: boolean default: false description: Run C++ SAST scanning kotlinSastEnabled: type: boolean default: false description: Run Kotlin SAST scanning scalaSastEnabled: type: boolean default: false description: Run Scala SAST scanning swiftSastEnabled: type: boolean default: false description: Run Swift SAST scanning rustSastEnabled: type: boolean default: false description: Run Rust SAST scanning elixirSastEnabled: type: boolean default: false description: Run Elixir SAST scanning allRulesEnabled: type: boolean default: false description: Enable all SAST rules pythonEnabledRules: type: string description: Comma-separated list of enabled Python SAST rules default: '' pythonDisabledRules: type: string description: Comma-separated list of disabled Python SAST rules default: '' javascriptEnabledRules: type: string description: Comma-separated list of enabled JavaScript SAST rules default: '' javascriptDisabledRules: type: string description: Comma-separated list of disabled JavaScript SAST rules default: '' goEnabledRules: type: string description: Comma-separated list of enabled Go SAST rules default: '' goDisabledRules: type: string description: Comma-separated list of disabled Go SAST rules default: '' javaEnabledRules: type: string description: Comma-separated list of enabled Java SAST rules default: '' javaDisabledRules: type: string description: Comma-separated list of disabled Java SAST rules default: '' kotlinEnabledRules: type: string description: Comma-separated list of enabled Kotlin SAST rules default: '' kotlinDisabledRules: type: string description: Comma-separated list of disabled Kotlin SAST rules default: '' scalaEnabledRules: type: string description: Comma-separated list of enabled Scala SAST rules default: '' scalaDisabledRules: type: string description: Comma-separated list of disabled Scala SAST rules default: '' phpEnabledRules: type: string description: Comma-separated list of enabled PHP SAST rules default: '' phpDisabledRules: type: string description: Comma-separated list of disabled PHP SAST rules default: '' rubyEnabledRules: type: string description: Comma-separated list of enabled Ruby SAST rules default: '' rubyDisabledRules: type: string description: Comma-separated list of disabled Ruby SAST rules default: '' csharpEnabledRules: type: string description: Comma-separated list of enabled C# SAST rules default: '' csharpDisabledRules: type: string description: Comma-separated list of disabled C# SAST rules default: '' dotnetEnabledRules: type: string description: Comma-separated list of enabled .NET SAST rules default: '' dotnetDisabledRules: type: string description: Comma-separated list of disabled .NET SAST rules default: '' cEnabledRules: type: string description: Comma-separated list of enabled C SAST rules default: '' cDisabledRules: type: string description: Comma-separated list of disabled C SAST rules default: '' cppEnabledRules: type: string description: Comma-separated list of enabled C++ SAST rules default: '' cppDisabledRules: type: string description: Comma-separated list of disabled C++ SAST rules default: '' swiftEnabledRules: type: string description: Comma-separated list of enabled Swift SAST rules default: '' swiftDisabledRules: type: string description: Comma-separated list of disabled Swift SAST rules default: '' rustEnabledRules: type: string description: Comma-separated list of enabled Rust SAST rules default: '' rustDisabledRules: type: string description: Comma-separated list of disabled Rust SAST rules default: '' elixirEnabledRules: type: string description: Comma-separated list of enabled Elixir SAST rules default: '' elixirDisabledRules: type: string description: Comma-separated list of disabled Elixir SAST rules default: '' openGrepNotificationMethod: type: string description: Notification method for OpenGrep default: '' socketTier1Enabled: type: boolean default: false description: Enable Socket Tier 1 reachability analysis socketAdditionalParams: type: string description: Additional parameters for Socket SCA default: '' secretScanningEnabled: type: boolean default: false description: Enable secret scanning trufflehogExcludeDir: type: string description: Directories to exclude from Trufflehog scanning default: '' trufflehogShowUnverified: type: boolean default: false description: Show unverified secrets in Trufflehog results trufflehogNotificationMethod: type: string description: Notification method for Trufflehog default: '' containerImagesToScan: type: string description: Comma-separated list of container images to scan default: '' dockerfiles: type: string description: Comma-separated list of Dockerfiles to scan default: '' trivyImageEnabled: type: boolean default: false description: Enable Trivy image scanning trivyDockerfileEnabled: type: boolean default: false description: Enable Trivy Dockerfile scanning trivyNotificationMethod: type: string description: Notification method for Trivy default: '' trivyDisabledRules: type: string description: Comma-separated list of disabled Trivy rules default: '' trivyImageScanningDisabled: type: boolean default: false description: Disable Trivy image scanning slackWebhookUrl: type: string description: Slack webhook URL for notifications default: '' webhookUrl: type: string description: Generic webhook URL for notifications default: '' msSentinelWorkspaceId: type: string description: Microsoft Sentinel workspace ID default: '' msSentinelKey: type: string description: Microsoft Sentinel key default: '' sumologicEndpoint: type: string description: Sumo Logic endpoint URL default: '' jiraUrl: type: string description: Jira server URL default: '' jiraProject: type: string description: Jira project key default: '' jiraEmail: type: string description: Jira user email default: '' jiraApiToken: type: string description: Jira API token default: '' githubToken: type: string description: GitHub API token default: '' githubApiUrl: type: string description: GitHub API URL default: '' msteamsWebhookUrl: type: string description: Microsoft Teams webhook URL default: '' s3Enabled: type: boolean default: false description: Enable S3 upload for scan results s3Bucket: type: string description: S3 bucket name default: '' s3AccessKey: type: string description: S3 access key default: '' s3SecretKey: type: string description: S3 secret key default: '' s3Endpoint: type: string description: S3 endpoint URL default: '' s3Region: type: string description: S3 region default: '' externalCveScanningEnabled: type: boolean default: false description: Enable external CVE scanning socketScanningEnabled: type: boolean default: false description: Enable Socket dependency scanning (legacy) socketScaEnabled: type: boolean default: false description: Enable Socket SCA scanning (legacy) additionalParameters: type: string description: Additional configuration parameters (legacy) default: '' description: '' description: Socket Basics settings '403': $ref: '#/components/responses/SocketForbidden' '404': $ref: '#/components/responses/SocketNotFoundResponse' '429': $ref: '#/components/responses/SocketTooManyRequestsResponse' x-readme: {} /orgs/{org_slug}/telemetry/config: get: tags: - telemetry summary: Get Organization Telemetry Config operationId: getOrgTelemetryConfig parameters: - name: org_slug in: path required: true description: The slug of the organization schema: type: string security: - bearerAuth: [] - basicAuth: [] description: 'Retrieve the telemetry config of an organization. This endpoint consumes 1 unit of your quota. This endpoint requires the following org token scopes:' responses: '200': content: application/json: schema: type: object additionalProperties: false description: '' properties: telemetry: type: object additionalProperties: false description: Telemetry configuration properties: enabled: type: boolean default: false description: Telemetry enabled required: - enabled required: - telemetry description: Retrieved telemetry config details '400': $ref: '#/components/responses/SocketBadRequest' '401': $ref: '#/components/responses/SocketUnauthorized' '403': $ref: '#/components/responses/SocketForbidden' '404': $ref: '#/components/responses/SocketNotFoundResponse' '429': $ref: '#/components/responses/SocketTooManyRequestsResponse' x-readme: {} put: tags: - telemetry summary: Update Telemetry Config operationId: updateOrgTelemetryConfig parameters: - name: org_slug in: path required: true description: The slug of the organization schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: false properties: enabled: type: boolean default: false description: Telemetry enabled description: '' required: false security: - bearerAuth: - telemetry-policy:update - basicAuth: - telemetry-policy:update description: 'Update the telemetry config of an organization. This endpoint consumes 1 unit of your quota. This endpoint requires the following org token scopes: - telemetry-policy:update' responses: '200': content: application/json: schema: type: object additionalProperties: false description: '' properties: telemetry: type: object additionalProperties: false description: Telemetry configuration properties: enabled: type: boolean default: false description: Telemetry enabled required: - enabled required: - telemetry description: Updated telemetry config details '400': $ref: '#/components/responses/SocketBadRequest' '401': $ref: '#/components/responses/SocketUnauthorized' '403': $ref: '#/components/responses/SocketForbidden' '404': $ref: '#/components/responses/SocketNotFoundResponse' '429': $ref: '#/components/responses/SocketTooManyRequestsResponse' x-readme: {} /license-policy: post: tags: - license-policy summary: License Policy (Beta) operationId: licensePolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/LicenseAllowListRequest' required: false security: - bearerAuth: - packages:list - license-policy:read - basicAuth: - packages:list - license-policy:read description: "Compare the license data found for a list of packages (given as PURL strings) with the contents of a configurable license policy,\n returning information about license data which\ \ does not comply with the license allow list.\n\n ## Example request body:\n\n ```json\n {\n \"components\": [\n {\n \"purl\": \"pkg:npm/lodash@4.17.21\"\n \ \ },\n {\n \"purl\": \"pkg:npm/lodash@4.14.1\"\n }\n ],\n \"allow\": [\n \"permissive\",\n \"pkg:npm/lodash?file_name=foo/test/*&version_glob=4.17.*\"\ \n ],\n \"warn\": [\n \"copyleft\",\n \"pkg:npm/lodash?file_name=foo/prod/*&version_glob=4.14.*\"\n ],\n \"options\": [\"toplevelOnly\"]\n }\n ```\n\n\n \ \ ## Return value\n\n For each requested PURL, an array is returned. Each array contains a list of license policy violations\n detected for the requested PURL.\n\n Violations are accompanied\ \ by a string identifying the offending license data as `spdxAtomOrExtraData`,\n a message describing why the license data is believed to be incompatible with the license policy, and a list\n\ \ of locations (by filepath or other provenance information) where the offending license data may be found.\n\n ```json\n Array<\n Array<{\n filepathOrProvenance: Array,\n\ \ level: \"warning\" | \"violation\",\n purl: string,\n spdxAtomOrExtraData: string,\n violationExplanation: string\n }>\n >\n ```\n\n ## License policy\ \ schema\n\n```json\n{\n allow?: Array\n warn?: Array\n options?: Array\n}\n```\n\nElements of the `allow` and `warn` arrays strings representing items which should be\ \ allowed, or which should trigger a warning; license data found in package which not present in either array will produce a license violation (effectively a \"hard\" error). For example, to allow\ \ Apache-2.0 and MIT to the allow list, simply add the strings \"Apache-2.0\" and \"MIT\" to the `allow` array. Strings appearing in these arrays are generally \"what you see is what you get\",\ \ with two important exceptions: strings which are recognized as license classes and strings which are recognized as PURLs are handled differently to allow for more flexible license policy creation.\n\ \n## License Classes\n\nStrings which are license classes will expand to a list of licenses known to be in that particular license class. Recognized license classes are:\n 'permissive',\n 'permissive\ \ (model)',\n 'permissive (gold)',\n 'permissive (silver)',\n 'permissive (bronze)',\n 'permissive (lead)',\n 'copyleft',\n 'maximal copyleft',\n 'network copyleft',\n 'strong copyleft',\n\ \ 'weak copyleft',\n 'contributor license agreement',\n 'public domain',\n 'proprietary free',\n 'source available',\n 'proprietary',\n 'commercial',\n 'patent'\n\nUsers can learn more about\ \ [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.\n\n\n## PURLs\n\nUsers may also modify their license\ \ policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.\n\ \npurl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).\n\n### Examples:\nAllow all\ \ license data found in a specific version of a package 4.14.1: `pkg:npm/lodash@4.14.1`\nAllow all license data found in a version range of a package: `pkg:npm/lodash?version_glob=15.*`\nAllow all\ \ license data in the test directory of a given package for certain version ranges: `pkg:npm/lodash@15.*.*?file_name=lodash/test/*`\nAllow all license data taken from the package registry for a\ \ package and version range: `pkg:npm/lodash?version_glob=*&license_provenance=registry_metadata`\n\n## Available options\n\n`toplevelOnly`: only apply the license policy to \"top level\" license\ \ data in a package, which includes registry metadata, LICENSE files, and manifest files which are closest to the root of the package.\n\n`applyToUnidentified`: Apply license policy to found but\ \ unidentified license data. If enabled, the license policy will be applied to license data which could not be affirmatively identified as a known license (this will effectively merge the license\ \ policy violation and unidentified license alerts). If disabled, license policy alerts will only be shown for license data which is positively identified as something not allowed or set to warn\ \ by the license policy.\n\nThis endpoint consumes 100 units of your quota.\n\nThis endpoint requires the following org token scopes:\n - packages:list\n- license-policy:read" responses: '200': content: application/x-ndjson: schema: type: array items: type: object additionalProperties: false description: '' properties: filepathOrProvenance: type: array items: type: string description: '' default: '' description: '' level: type: string description: '' default: '' purl: type: string description: '' default: '' spdxAtomOrExtraData: type: string description: '' default: '' violationExplanation: type: string description: '' default: '' required: - filepathOrProvenance - level - purl - spdxAtomOrExtraData - violationExplanation description: '' description: Data about license policy violations, if any exist '400': $ref: '#/components/responses/SocketBadRequest' '401': $ref: '#/components/responses/SocketUnauthorized' '403': $ref: '#/components/responses/SocketForbidden' '404': $ref: '#/components/responses/SocketNotFoundResponse' '429': $ref: '#/components/responses/SocketTooManyRequestsResponse' '500': $ref: '#/components/responses/SocketInternalServerError' x-readme: {} /license-metadata: post: tags: - metadata - license-policy summary: License Metadata operationId: licenseMetadata parameters: - name: includetext in: query required: false description: If `true`, the response will include the full text of the requested licenses schema: type: boolean default: false requestBody: content: application/json: schema: $ref: '#/components/schemas/SLicenseMetaReq' required: false security: [] description: "For an array of license identifiers or names (short form SPDX identifiers, or long form license names),\n returns an array of metadata for the corresponding license, if the license\ \ is recognized. If the query\n parameter `includetext=true` is set, the returned metadata will also include the license text.\n\n\n ## Example request body:\n\n ```json\n [\n \"\ Apache-2.0\",\n \"BSD Zero Clause License\"\n ]\n ```\n\n\n ## Return value\n\n ```json\n // Response schema:\n Array<{\n licenseId: string,\n name?: string,\n \ \ deprecated?: string,\n crossref?: string\n classes: Array\n text?: string\n }>\n\n // Example response:\n [\n {\n \"licenseId\": \"Apache-2.0\"\ ,\n \"name\": \"Apache License 2.0\",\n \"deprecated\": false,\n \"crossref\": \"https://spdx.org/licenses/Apache-2.0.html\",\n \"classes\": [\n \"fsf libre\"\ ,\n \"osi approved\",\n \"permissive (silver)\"\n ]\n },\n {\n \"licenseId\": \"0BSD\",\n \"name\": \"BSD Zero Clause License\",\n \"deprecated\"\ : false,\n \"crossref\": \"https://spdx.org/licenses/0BSD.html\",\n \"classes\": [\n \"osi approved\",\n \"permissive (bronze)\"\n ]\n }\n ]\n ```\n\ \n ## License policy schema\n\n```json\n{\n allow?: Array\n warn?: Array\n options?: Array\n}\n```\n\nElements of the `allow` and `warn` arrays strings representing\ \ items which should be allowed, or which should trigger a warning; license data found in package which not present in either array will produce a license violation (effectively a \"hard\" error).\ \ For example, to allow Apache-2.0 and MIT to the allow list, simply add the strings \"Apache-2.0\" and \"MIT\" to the `allow` array. Strings appearing in these arrays are generally \"what you see\ \ is what you get\", with two important exceptions: strings which are recognized as license classes and strings which are recognized as PURLs are handled differently to allow for more flexible license\ \ policy creation.\n\n## License Classes\n\nStrings which are license classes will expand to a list of licenses known to be in that particular license class. Recognized license classes are:\n 'permissive',\n\ \ 'permissive (model)',\n 'permissive (gold)',\n 'permissive (silver)',\n 'permissive (bronze)',\n 'permissive (lead)',\n 'copyleft',\n 'maximal copyleft',\n 'network copyleft',\n 'strong\ \ copyleft',\n 'weak copyleft',\n 'contributor license agreement',\n 'public domain',\n 'proprietary free',\n 'source available',\n 'proprietary',\n 'commercial',\n 'patent'\n\nUsers can\ \ learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.\n\n\n## PURLs\n\nUsers may also\ \ modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files\ \ and directories, etc.\n\npurl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).\n\ \n### Examples:\nAllow all license data found in a specific version of a package 4.14.1: `pkg:npm/lodash@4.14.1`\nAllow all license data found in a version range of a package: `pkg:npm/lodash?version_glob=15.*`\n\ Allow all license data in the test directory of a given package for certain version ranges: `pkg:npm/lodash@15.*.*?file_name=lodash/test/*`\nAllow all license data taken from the package registry\ \ for a package and version range: `pkg:npm/lodash?version_glob=*&license_provenance=registry_metadata`\n\n## Available options\n\n`toplevelOnly`: only apply the license policy to \"top level\"\ \ license data in a package, which includes registry metadata, LICENSE files, and manifest files which are closest to the root of the package.\n\n`applyToUnidentified`: Apply license policy to found\ \ but unidentified license data. If enabled, the license policy will be applied to license data which could not be affirmatively identified as a known license (this will effectively merge the license\ \ policy violation and unidentified license alerts). If disabled, license policy alerts will only be shown for license data which is positively identified as something not allowed or set to warn\ \ by the license policy.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:" responses: '200': content: application/json: schema: $ref: '#/components/schemas/SLicenseMetaRes' description: Metadata for the requested licenses '400': $ref: '#/components/responses/SocketBadRequest' x-readme: {} components: requestBodies: {} responses: SocketBadRequest: content: application/json: schema: type: object additionalProperties: false description: '' properties: error: type: object additionalProperties: false description: '' properties: message: type: string description: '' default: '' details: type: object description: '' default: null nullable: true required: - details - message required: - error description: Bad request SocketUnauthorized: content: application/json: schema: type: object additionalProperties: false description: '' properties: error: type: object additionalProperties: false description: '' properties: message: type: string description: '' default: '' details: type: object description: '' default: null nullable: true required: - details - message required: - error description: Unauthorized SocketForbidden: content: application/json: schema: type: object additionalProperties: false description: '' properties: error: type: object additionalProperties: false description: '' properties: message: type: string description: '' default: '' details: type: object description: '' default: null nullable: true required: - details - message required: - error description: Insufficient max_quota for API method SocketNotFoundResponse: content: application/json: schema: type: object additionalProperties: false description: '' properties: error: type: object additionalProperties: false description: '' properties: message: type: string description: '' default: '' details: type: object description: '' default: null nullable: true required: - details - message required: - error description: Resource not found SocketTooManyRequestsResponse: description: Insufficient quota for API route headers: Retry-After: description: 'Retry contacting the endpoint *at least* after seconds. See https://tools.ietf.org/html/rfc7231#section-7.1.3' schema: format: int32 type: integer content: application/json: schema: type: object additionalProperties: false description: '' properties: error: type: object additionalProperties: false description: '' properties: message: type: string description: '' default: '' details: type: object description: '' default: null nullable: true required: - details - message required: - error SocketInternalServerError: content: application/json: schema: type: object additionalProperties: false description: '' properties: error: type: object additionalProperties: false description: '' properties: message: type: string description: '' default: '' details: type: object description: '' default: null nullable: true required: - details - message required: - error description: Internal server error SocketConflict: content: application/json: schema: type: object additionalProperties: false description: '' properties: error: type: object additionalProperties: false description: '' properties: message: type: string description: '' default: '' details: type: object description: '' default: null nullable: true required: - details - message required: - error description: Resource already exists SocketGone: content: application/json: schema: type: object additionalProperties: false description: '' properties: error: type: object additionalProperties: false description: '' properties: message: type: string description: '' default: '' details: type: object description: '' default: null nullable: true required: - details - message required: - error description: Gone schemas: SStoredLicensePolicy: type: object additionalProperties: false description: '' properties: allow: type: array items: type: string description: '' default: '' description: '' nullable: true warn: type: array items: type: string description: '' default: '' description: '' nullable: true monitor: type: array items: type: string description: '' default: '' description: '' nullable: true deny: type: array items: type: string description: '' default: '' description: '' nullable: true options: type: array items: type: string description: '' default: '' description: '' nullable: true required: - allow - deny - monitor - options - warn SLicenseMetaReq: type: object description: '' default: null LicenseAllowListRequest: type: object description: '' default: null SLicenseMetaRes: type: object description: '' default: null securitySchemes: bearerAuth: type: http scheme: bearer description: Organization Tokens can be passed as a Bearer token basicAuth: type: http scheme: basic description: Organization Tokens can be passed as the user field in basic auth