Safeguard.sh Documentation Center
Portal

Portal Settings

Configure Portal preferences and organization settings

Portal Settings

Configure Portal-specific settings including preferences, notifications, branding, and integration options.

Accessing Settings

  1. Navigate to Portal
  2. Click Settings (gear icon)
  3. Select the settings category

General Settings

Organization Profile

Configure your organization's Portal profile:

SettingDescription
Organization NameDisplay name in Portal
LogoOrganization logo (displayed to customers)
WebsiteCompany website URL
Support EmailCustomer support contact
DescriptionBrief company description

Default Settings

SettingDescription
Default SBOM FormatCycloneDX or SPDX
Default Export FormatJSON, XML, or PDF
Auto-Enrich SBOMsEnable automatic enrichment
TimezoneDefault timezone for timestamps

Sharing Settings

Default Sharing Permissions

SettingOptions
Default Access LevelView Only, Download, Full Access
Require ApprovalYes/No for sharing requests
Expiration PolicyNever, 30/60/90 days, Custom
WatermarkingEnable/disable SBOM watermarks

Sharing Restrictions

Control who can share:

  • By role (Admin, Manager, User)
  • By product category
  • By customer type
  • Require manager approval

Public Sharing

SettingDescription
Allow Public LinksEnable public SBOM access
Public Link ExpirationDefault expiration time
Require RegistrationRequire account for download
Track DownloadsLog public downloads

Notification Settings

Email Notifications

NotificationTrigger
New Share RequestCustomer requests SBOM
Share AcceptedCustomer accepts share
SBOM UpdatedLinked SBOM is updated
Vulnerability AlertNew vulnerability in shared SBOM
Expiration WarningShare nearing expiration

Notification Preferences

Configure per notification type:

  • Email delivery (immediate, daily digest, weekly)
  • In-app notification
  • Webhook delivery

Webhook Configuration

Send notifications to external systems:

  1. Go to Settings → Webhooks
  2. Click + Add Webhook
  3. Configure:
FieldDescription
URLWebhook endpoint
EventsEvents to trigger
SecretSigning secret
ActiveEnable/disable

Branding Settings

Customer Portal Branding

Customize the customer-facing portal:

ElementCustomization
LogoHeader logo
FaviconBrowser tab icon
Primary ColorBrand color
Custom CSSAdvanced styling

Email Branding

Customize notification emails:

ElementCustomization
LogoEmail header logo
FooterCustom footer text
Reply-ToReply email address

Custom Domain

Use your own domain for Portal:

  1. Go to Settings → Custom Domain
  2. Enter your domain (e.g., sbom.yourcompany.com)
  3. Configure DNS records
  4. Verify domain ownership
  5. Enable custom domain

Integration Settings

ESSCM Integration

Link Portal with Enterprise ESSCM:

SettingDescription
Auto-Sync ProjectsImport SBOMs automatically
Sync FrequencyReal-time, hourly, daily
Project FilterWhich projects to sync
Version MappingHow versions map to products

Third Party Risk Manager (TPRM)

Connect Portal with TPRM:

SettingDescription
Link VendorsAssociate vendors with suppliers
Share RequestsRoute requests through TPRM
Risk DataInclude risk scores in shares

External Integrations

IntegrationPurpose
ServiceNowTicket creation
SlackNotifications
Microsoft TeamsNotifications
Email (SMTP)Custom email delivery

Security Settings

Access Control

SettingDescription
Session TimeoutAuto-logout duration
IP AllowlistRestrict access by IP
Download LimitsRate limiting for downloads

Audit Settings

SettingDescription
Retention PeriodHow long to keep logs
Log LevelDetail level of logging
Export EnabledAllow audit log export

Data Protection

SettingDescription
EncryptionAt-rest encryption options
Data ResidencyRegion restrictions
Backup FrequencyBackup schedule

Compliance Settings

EO 14028 Defaults

SettingDescription
Auto-ValidateCheck SBOMs on upload
Require ComplianceBlock non-compliant shares
Compliance ReportInclude in shares

NTIA Minimum Elements

SettingDescription
Enforce MinimumsRequire all elements
Warn on MissingAlert for missing data
Auto-EnrichFill in missing data

API Settings

API Access

SettingDescription
API EnabledEnable Portal API access
Rate LimitsRequests per minute/hour
Allowed IPsIP restrictions for API

API Keys

Manage Portal-specific API keys:

  1. Go to Settings → API Keys
  2. View existing keys
  3. Create new keys with scoped permissions
  4. Rotate or revoke keys

Import/Export Settings

Default Formats

TypeOptions
SBOM ImportCycloneDX, SPDX, Syft, Trivy
SBOM ExportCycloneDX, SPDX, CSV, PDF
Report ExportPDF, HTML, Excel

Bulk Operations

SettingDescription
Max Upload SizeMaximum file size
Batch SizeItems per bulk operation
Async ThresholdWhen to process async

Saving Settings

  • Click Save after making changes
  • Some settings require confirmation
  • Changes take effect immediately unless noted

Reset to Defaults

  1. Go to settings section
  2. Click Reset to Defaults
  3. Confirm reset
  4. Previous settings are logged

Next Steps

Audit Trails

Complete activity logging for compliance and security

User Roles

Understanding Portal user roles and permissions

On this page

Portal SettingsAccessing SettingsGeneral SettingsOrganization ProfileDefault SettingsSharing SettingsDefault Sharing PermissionsSharing RestrictionsPublic SharingNotification SettingsEmail NotificationsNotification PreferencesWebhook ConfigurationBranding SettingsCustomer Portal BrandingEmail BrandingCustom DomainIntegration SettingsESSCM IntegrationThird Party Risk Manager (TPRM)External IntegrationsSecurity SettingsAccess ControlAudit SettingsData ProtectionCompliance SettingsEO 14028 DefaultsNTIA Minimum ElementsAPI SettingsAPI AccessAPI KeysImport/Export SettingsDefault FormatsBulk OperationsSaving SettingsReset to DefaultsNext Steps