Skip to main content

Documentation Updates

· 3 min read
Marius Nergård
Marius Nergård
Product owner Breeze @ Sotera

Documentation Updates - December 17, 2025​

This update adds comprehensive documentation for new features and improvements across multiple areas of Breeze, including external data sources, OAuth API authentication, Card Templates, domain-level credential management, and production history.

External Data Sources and Lookup​

New Documentation:

  • External Data Lookup — Complete guide on using external data lookup to automatically retrieve person information during credential ordering. Covers supported data sources (Norwegian Folkeregisteret, SPAR, Breeze ID Connector), step-by-step usage instructions, error handling, and best practices.

  • External Data Sources Configuration — Administrator guide for configuring external data sources at the Domain level. Includes detailed instructions for setting up Norwegian Folkeregisteret (FREG), SPAR, and Breeze ID Connector, with configuration steps, connection testing, and field mapping guidance.

Updated Documentation:

OAuth API Authentication​

New Documentation:

  • OAuth API Authentication — Comprehensive guide for authenticating API requests using OAuth 2.0 client credentials. Covers the OAuth 2.0 Client Credentials flow, token management, permissions, rate limiting, error handling, and security best practices for machine-to-machine integrations.

  • OAuth Client Management — Administrator guide for creating and managing OAuth 2.0 clients. Includes instructions for creating clients, rotating secrets, revoking access, viewing client details, and managing secret expiration. Also covers automatic expiry warning emails sent before client secrets expire.

Updated Documentation:

Card Templates​

New Documentation:

  • Card Templates Overview — Introduction to Card Templates for physical credential cards, covering key features, benefits, and getting started guides.

  • Editing Card Templates — Comprehensive guide for editing Card Templates and configuring production settings, including:

    • Production elements (status, order type, layouts, fields)
    • Encoding and ranges configuration
    • Approval workflows and Duo ID Approval Routing
    • Access control settings
    • Advanced configuration options

  • Card Template Approval Workflows — Detailed guide for configuring approval settings and Duo ID Approval Routing to delegate approvals to a specific Tenant.

Updated Documentation:

  • Template Management Overview — Added Card Templates section with links to editing and approval workflow documentation
  • Mobile Credential Templates Category — Updated position from 1 to 2 to accommodate Card Templates as position 1

Domain-Level Credential Management​

Updated Documentation:

  • Using the Credentials List View — Added comprehensive documentation for Domain View functionality:
    • Tenant View vs Domain View toggle for main Tenants
    • Instructions for viewing Credentials across all sub-Tenants in a domain
    • "Tenant - Name" column display in Domain View
    • Filtering by Tenant name
    • Setting default view preferences
    • Use cases and scenarios for Domain View

Production History​

New Documentation:

  • Production Site — Added Production History section covering:
    • How to access Production History from the Production module
    • Filtering and sorting production history entries by date, credential number, and Tenant
    • Selecting Credentials and running follow-up actions (reproduction, print carrier only)
    • Required roles and permissions

Documentation Structure Improvements​

  • Added new Card Templates category to Template Management section
  • Reorganized template management navigation to accommodate both Mobile Credential Templates and Card Templates
  • Enhanced cross-referencing between related documentation sections
  • Improved navigation structure for better discoverability