Settings - Client
Organization-wide client settings.
ποΈ Get Client
Retrieve the authenticated client's profile as a signed JWT payload. Requires a bearer token with the 'uid' scope. Returns 404 if the client record does not exist.
ποΈ Update Client Organization Information
Partially or fully update the client's company information, structure, and regulations sections. Only the fields present in the request body are merged into the existing company data. Returns 404 if the client does not exist. Set require_complete to enforce the required organization fields on the effective (merged) profile: the write is rejected with 422 unless legal_name, email, url_company and category all carry a valid value, and, when a structure is sent, the headquarters location is non-empty. Bootstrap callers that legitimately write a partial profile leave it false.
ποΈ Request Scan-Complete Email Notification
Register the authenticated user for a one-time email sent when the current scan finishes (every repository enriched). Idempotent per user β repeat requests replace the previous one. Returns 503 when transactional email delivery is not configured.
ποΈ Update Client Setup Information
Mark the client's account setup as completed by recording the current timestamp. The call is idempotent: if setup was already recorded, it succeeds without changes.
ποΈ Enable Deep Reasoning Enrichment
Enable the deep reasoning enrichment flag on the authenticated client. Returns 404 if the client is not found or the flag was already enabled.
ποΈ Save Plugin Configuration
Save or update the configuration of a known plugin (github, gitlab, bitbucket_cloud, gitea, forgejo, azure-devops, plexalyzer; 422 otherwise) for the client. Needs a signed-in web session and the connector write permission (403 otherwise). Body keys the plugin does not allow are dropped (W1). The change is recorded in the audit log. Returns 404 if the client is not found or nothing changed.
ποΈ Delete Plugin Configuration
Remove the stored configuration of a known plugin (github, gitlab, bitbucket_cloud, gitea, forgejo, azure-devops, plexalyzer; 422 otherwise) from the client. Needs a signed-in web session and the connector write permission (403 otherwise). Returns 404 if the client is not found or the configuration was already absent.
ποΈ Save Tool Configuration
Save or update the configuration of a security tool identified by 'tool_name' for the client. The change is recorded in the audit log. Returns 404 if the client is not found or nothing changed.
ποΈ Delete Tool Configuration
Reset the configuration of a security tool identified by 'tool_name' to an empty object for the client. Returns 404 if the client is not found or nothing changed.
ποΈ Save Included Tools List
Replace the client's entire included tools list in a single call. Deprecated: prefer the add/remove included-tool endpoints for incremental changes. Returns 404 if the client is not found or nothing changed.
ποΈ Add Included Tool
Add a security tool to the client's list of tools included in scans. If the tool is already present the call succeeds without changes. Returns 400 when 'tool_name' is missing and 404 if the client is not found.
ποΈ Remove Included Tool
Remove a security tool from the client's list of tools included in scans. If the tool is not in the list the call succeeds without changes. Returns 404 if the client is not found.
ποΈ Save Connector Configuration
Save or update a named connector configuration on the client. The connector name must be one of the supported connectors (appscan, black_duck, burp, checkmarx, fortify, issue_webhook, kiuwan, snyk, vanta; 422 otherwise); the retired legacy DAST 'strix' connector returns 410. Returns 404 if the client is not found.
ποΈ Delete Connector Configuration
Remove a named connector configuration from the client. The connector name must be one of the supported connectors or a retired one (422 otherwise). Returns 404 if the client is not found or the configuration was already absent.