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
| Concept | Description | Use Case |
|---|---|---|
| Project | Internal scanning unit | Development & security |
| Product | External-facing catalog item | Customer sharing |
Projects generate SBOMs; Products organize them for distribution.
Creating a Product
Step 1: Navigate to My Products
- Go to Portal → My Products
- Click + New Product
Step 2: Enter Product Details
| Field | Description | Required |
|---|---|---|
| Product Name | Display name | Yes |
| SKU | Unique identifier | Yes |
| Description | Product description | No |
| Category | Product category | No |
| Website | Product website URL | No |
| Logo | Product logo image | No |
Step 3: Configure Settings
| Setting | Description |
|---|---|
| Visibility | Public catalog or private |
| Auto-publish SBOMs | Automatically publish new versions |
| Require Approval | Approval 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:
| Column | Description |
|---|---|
| Name | Product name |
| SKU | Product identifier |
| Versions | Number of versions |
| Latest Version | Most recent version |
| Status | Active/Deprecated |
Product Actions
| Action | Description |
|---|---|
| Edit | Modify product details |
| Add Version | Add new version |
| View SBOMs | See associated SBOMs |
| Share | Configure sharing |
| Deprecate | Mark as deprecated |
| Delete | Remove product |
Product Versions
Adding a Version
- Open product
- Click + Add Version
- Enter version details:
| Field | Description |
|---|---|
| Version Number | Semantic version (e.g., 2.1.0) |
| Release Date | When version was released |
| Release Notes | Changes in this version |
| Status | Current, Deprecated, EOL |
- Associate SBOM (see below)
- Click Save Version
Version Lifecycle
| Status | Meaning |
|---|---|
| Pre-release | Not yet released |
| Current | Active supported version |
| Deprecated | Still supported but superseded |
| End of Life | No longer supported |
Associating SBOMs
Link Existing SBOM
Associate an SBOM from ESSCM:
- Open product version
- Click Associate SBOM
- Select from available projects
- Choose specific version
- Click Associate
Upload New SBOM
Upload an SBOM directly:
- Open product version
- Click Upload SBOM
- Select SBOM file (CycloneDX or SPDX)
- 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
- Draft - Product created but not visible
- Review - Pending approval (if enabled)
- Published - Visible to authorized parties
- Archived - Removed from active catalog
Publishing a Version
- Ensure SBOM is associated
- Complete all required fields
- Click Publish
- Confirm publication
Unpublishing
To remove a published version:
- Open version
- Click Unpublish
- Provide reason
- Confirm
Product Sharing
Share with Customers
Configure who can access your products:
- Open product
- Go to Sharing tab
- Add recipients by:
- Email address
- Organization
- Public link (if allowed)
Access Levels
| Level | Capabilities |
|---|---|
| View | See product and SBOM details |
| Download | Download SBOM files |
| Subscribe | Receive update notifications |
See Sharing for detailed sharing options.
Product Analytics
View Analytics
Track product engagement:
| Metric | Description |
|---|---|
| Views | Number of product views |
| Downloads | SBOM download count |
| Subscribers | Active subscribers |
| Shares | Times shared |
Analytics Dashboard
- Open product
- Go to Analytics tab
- View metrics and trends
Bulk Operations
Import Products
Import multiple products:
- Click Import
- Download CSV template
- Fill in product data
- Upload CSV file
- Review and confirm
Export Products
Export product catalog:
- Click Export
- Select format (CSV, JSON)
- Choose fields to include
- 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