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.

📄️ Update Client CNAPP Scan Configuration

Update the client's autonomous scan flag, scheduled scan setting, and AI remediator options (language and remediation verification) with partial update support. Returns 404 if the client does not exist.

📄️ 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 an SCM plugin (e.g. github, gitlab, gitea, bitbucket_cloud) for the client. 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 an SCM plugin (e.g. github, gitlab, gitea, bitbucket_cloud) from the client. 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 lowercase alphanumeric (422 otherwise); the 'strix' connector additionally requires a URL on a verified domain. Returns 404 if the client is not found.

📄️ Delete Connector Configuration

Remove a named connector configuration from the client. The connector name must be lowercase alphanumeric (422 otherwise). Returns 404 if the client is not found or the configuration was already absent.