Skip to main content

Consent API reference

Reference for Consent API reference: every documented symbol, parameter, and endpoint.

Overview

The SupportConsentProvider interface provides a customer-controlled consent gate for the debug capture feature. This gate governs access to rich Tier-1 and Tier-2 support data; basic Tier-0 telemetry is not gated. The system includes two distinct implementations, ByocConsentProvider for self-hosted deployments and SaasConsentProvider for the SaaS environment, which determine how consent is managed.

Symbols

NameKindSignatureDescription
ByocConsentProviderclasspublic final class ByocConsentProvider implements SupportConsentProviderBring-Your-Own-Cloud (default) support-consent provider. Consent is license-driven: it delegates to LicenseValidator#debugCaptureConsent exactly as the Debug-Capture service did before this gate existed, so the default deployment mode has zero behavioural change. All redaction profiles are permitted (the customer-controlled per-profile toggle is a SaaS-only concept).
ByocConsentProviderconstructorpublic ByocConsentProvider(LicenseValidator licenseValidator)
ConsentViewrecordrecord ConsentView( boolean saasMode, boolean consented, OffsetDateTime consentedAt, Set<String> allowedProfiles, boolean breakGlass)Immutable view of the current consent state (for the read endpoint).
SaasConsentProviderclasspublic final class SaasConsentProvider implements SupportConsentProviderSpecaria-operated (saas) support-consent provider. Consent and the permitted redaction profiles are customer-set via the Settings UI and persisted in the system-setting table: saas.support_consent — boolean, default false. saas.support_consent_updated_at — ISO-8601 timestamp string. saas.support_consent_profiles — CSV subset of masked,raw.
SaasConsentProviderconstructorpublic SaasConsentProvider(SystemSettingRepository settings, PlatformSettingsProvider platformSettings)
SupportConsentProviderinterfacepublic interface SupportConsentProviderthe customer-controlled Support-Data consent gate in front of the tiered Debug-Capture feature. Tier-0 basic telemetry stays UN-gated (it carries no customer bodies); this gate covers the Tier-1 (masked) and Tier-2 (raw) capture bundles. See Two implementations, selected at runtime by the SaaS license capability (gov.specaria.tenant.
allowedProfilesmethodpublic Set<String> allowedProfiles
allowedProfilesmethodpublic Set<String> allowedProfiles
allowedProfilesmethodSet<String> allowedProfiles@return the redaction profiles the customer permits — a subset of {@code {structural, masked, raw}}. In saas this is EMPTY when the customer has not consented (a capture session taps raw data regardless of profile, so structural is gated too); once consented it always includes #PROFILE_STRUCTURAL. In byoc all three are permitted (license-driven).
breakGlassmethodpublic boolean breakGlass
breakGlassmethoddefault boolean breakGlass@return true iff the platform break-glass override is forcing consent on (saas only); false in byoc and un-overridden saas.
consentedmethodpublic boolean consented
consentedmethodpublic boolean consented
consentedmethodboolean consented@return true iff rich (Tier-1/Tier-2) debug capture is permitted at all. Fail-closed: returns false when consent is absent.
consentedAtmethodpublic OffsetDateTime consentedAt
consentedAtmethodpublic OffsetDateTime consentedAt
consentedAtmethodOffsetDateTime consentedAt@return when consent was last set, or null if never / not applicable.
isSaasModemethodpublic boolean isSaasMode
isSaasModemethodpublic boolean isSaasMode
isSaasModemethodboolean isSaasMode@return true iff this deployment is Specaria-operated (saas).
viewmethoddefault ConsentView view@return a ConsentView snapshot of the current state.

Parameters

ByocConsentProvider

ParameterType
licenseValidatorLicenseValidator

SaasConsentProvider

ParameterType
settingsSystemSettingRepository
platformSettingsPlatformSettingsProvider

See also

  • Admin API reference
  • Api API reference
  • Auth API reference
  • Config API reference
  • Contract API reference
  • Db API reference
  • Debug API reference
  • Encoding API reference
  • Fleet API reference
  • I18n API reference
  • License API reference
  • Metering API reference
  • Model API reference
  • Net API reference
  • Openapi API reference
  • Relay API reference
  • Repo API reference
  • Runtime API reference
  • Settings API reference
  • Spec API reference
  • Tenant API reference
  • Web API reference
  • Worker API reference
  • Wsdl API reference

All SOAP-to-REST docs