Safeguard.sh Documentation Center
Portal

My Products

Manage your product catalog and associated SBOMs in Portal

My Products

The My Products section in Portal allows you to organize and manage your software products and their associated SBOMs for sharing with customers and partners.

Overview

My Products helps you:

  • Create a product catalog
  • Associate SBOMs with products
  • Manage product versions
  • Track product lifecycle
  • Enable SBOM sharing

Product Catalog

What is a Product?

A Product represents a shippable software item that you provide to customers:

  • Commercial software applications
  • Open source projects
  • Internal tools shared externally
  • APIs and services
  • Hardware firmware

Product vs Project

ConceptDescriptionUse Case
ProjectInternal scanning unitDevelopment & security
ProductExternal-facing catalog itemCustomer sharing

Projects generate SBOMs; Products organize them for distribution.

Creating a Product

Step 1: Navigate to My Products

  1. Go to PortalMy Products
  2. Click + New Product

Step 2: Enter Product Details

FieldDescriptionRequired
Product NameDisplay nameYes
SKUUnique identifierYes
DescriptionProduct descriptionNo
CategoryProduct categoryNo
WebsiteProduct website URLNo
LogoProduct logo imageNo

Step 3: Configure Settings

SettingDescription
VisibilityPublic catalog or private
Auto-publish SBOMsAutomatically publish new versions
Require ApprovalApproval workflow for publishing

Step 4: Save Product

Click Create Product to add to your catalog.

Managing Products

Product List

View all products in your catalog:

ColumnDescription
NameProduct name
SKUProduct identifier
VersionsNumber of versions
Latest VersionMost recent version
StatusActive/Deprecated

Product Actions

ActionDescription
EditModify product details
Add VersionAdd new version
View SBOMsSee associated SBOMs
ShareConfigure sharing
DeprecateMark as deprecated
DeleteRemove product

Product Versions

Adding a Version

  1. Open product
  2. Click + Add Version
  3. Enter version details:
FieldDescription
Version NumberSemantic version (e.g., 2.1.0)
Release DateWhen version was released
Release NotesChanges in this version
StatusCurrent, Deprecated, EOL
  1. Associate SBOM (see below)
  2. Click Save Version

Version Lifecycle

StatusMeaning
Pre-releaseNot yet released
CurrentActive supported version
DeprecatedStill supported but superseded
End of LifeNo longer supported

Associating SBOMs

Associate an SBOM from ESSCM:

  1. Open product version
  2. Click Associate SBOM
  3. Select from available projects
  4. Choose specific version
  5. Click Associate

Upload New SBOM

Upload an SBOM directly:

  1. Open product version
  2. Click Upload SBOM
  3. Select SBOM file (CycloneDX or SPDX)
  4. Click Upload

SBOM Requirements

For published products, SBOMs should include:

  • All NTIA minimum elements
  • Accurate component data
  • Current vulnerability status
  • Valid format and structure

Publishing Products

Publishing Workflow

  1. Draft - Product created but not visible
  2. Review - Pending approval (if enabled)
  3. Published - Visible to authorized parties
  4. Archived - Removed from active catalog

Publishing a Version

  1. Ensure SBOM is associated
  2. Complete all required fields
  3. Click Publish
  4. Confirm publication

Unpublishing

To remove a published version:

  1. Open version
  2. Click Unpublish
  3. Provide reason
  4. Confirm

Product Sharing

Share with Customers

Configure who can access your products:

  1. Open product
  2. Go to Sharing tab
  3. Add recipients by:
    • Email address
    • Organization
    • Public link (if allowed)

Access Levels

LevelCapabilities
ViewSee product and SBOM details
DownloadDownload SBOM files
SubscribeReceive update notifications

See Sharing for detailed sharing options.

Product Analytics

View Analytics

Track product engagement:

MetricDescription
ViewsNumber of product views
DownloadsSBOM download count
SubscribersActive subscribers
SharesTimes shared

Analytics Dashboard

  1. Open product
  2. Go to Analytics tab
  3. View metrics and trends

Bulk Operations

Import Products

Import multiple products:

  1. Click Import
  2. Download CSV template
  3. Fill in product data
  4. Upload CSV file
  5. Review and confirm

Export Products

Export product catalog:

  1. Click Export
  2. Select format (CSV, JSON)
  3. Choose fields to include
  4. Download file

API Access

# List products
curl -X GET https://api.safeguard.sh/v1/portal/products \
  -H "Authorization: Bearer $API_KEY"

# Create product
curl -X POST https://api.safeguard.sh/v1/portal/products \
  -H "Authorization: Bearer $API_KEY" \
  -d '{"name": "My Product", "sku": "PROD-001"}'

# Add version
curl -X POST https://api.safeguard.sh/v1/portal/products/{id}/versions \
  -H "Authorization: Bearer $API_KEY" \
  -d '{"version": "2.0.0", "sbom_id": "sbom-uuid"}'

Best Practices

Product Organization

  • Use consistent SKU naming
  • Maintain accurate descriptions
  • Keep versions up to date
  • Archive old products

SBOM Quality

  • Ensure SBOMs pass validation
  • Include all dependencies
  • Update with each release
  • Verify accuracy

Sharing

  • Review sharing settings regularly
  • Use appropriate access levels
  • Track who has access
  • Revoke access when needed

Next Steps

On this page