Skip to main content

Editing Templates

You'll spend most of your time editing templates—whether you're adjusting provider settings, changing sync schedules, or updating field configurations. The template editor organizes everything into clear sections, making it easy to find what you need.

Opening the editor

You can open the template editor in two ways:

  1. Click the "Edit" button next to any template in the list
  2. Double-click any template row

Either way, you'll see the same editor with all the configuration options.

Template Editor Detail View

Editor overview

The template editor is organized into distinct sections. Each section has its own Edit button or inline controls, so you can focus on one thing at a time. You don't need to configure everything at once—just work through the sections you need.

Template name and provider connection

At the top of the editor, you'll find:

Template Name — Edit this directly in the text field. Use descriptive names like "Employee Mobile ID" or "Visitor Access" so they're easy to identify later.

Provider Connection — The "Check Connection & Credits" button lets you test your provider connection. Use this after configuring Credentials to verify everything works and check your available credits. The status will show whether the connection has been tested yet.

Settings

The Settings section contains quick toggles for common options. Each setting has two options you can switch between:

SettingOptionWhat it does
Visible in portalVisibleOperators can see and use this template when ordering or creating new Credentials
HiddenTemplate stays hidden from operators (useful for unfinished or testing templates)
AMR SyncSyncAMR (Access Management Request) synchronization is enabled
DisabledAMR sync is turned off
Provision MethodAutomaticCredentials are provisioned immediately when issued
ManualRequires manual provisioning steps
Duo IDEnabledTemplate supports Duo ID functionality
DisabledStandard mobile ID Credentials only
Settings section
Visibility Requirements

Templates can't be made visible until provider configuration is complete. Incomplete configurations automatically stay hidden to prevent errors during Credential issuance.

General settings

Click "General settings" to expand this section. Here you'll find:

FieldDescription
Private ID FieldMaps your internal Credential data to the provider's synchronization fields. Defaults to "Credential - Number", but you can select a different field if needed.
Send end dateCheck this box if you want Credential expiration dates sent to the provider.
External layout nameOptional. Use this if you want to configure and design the layout in the STid portal instead of using Breeze layouts. Generally not recommended—only use in specific cases where external layout configuration is required. See Layout section for the recommended approach.
External ReferenceOptional custom identifier for linking to external systems like CRM or HR platforms.
DescriptionAdd detailed notes about the template's configuration. This helps administrators and operators understand how to use it.
InstructionsStep-by-step guidance for operators who will issue Credentials using this template. This appears as user-facing help text.
General settings section

Account Credentials

Required Roles

Required roles: System Administrator, Manage Templates - Mobile Credential

To configure provider settings, you need one of the roles listed above.

Click "Edit" to configure your provider connection. This opens a dialog where you enter:

FieldDescription
Provider usernameYour authentication Credential for provider API access. This is stored securely.
Provider passwordYour provider account password.
Site IDIdentifies your organization's site within the provider system. You'll get this from your mobile ID provider.
Provider configuration IDA specific configuration identifier for your provider setup. Also provided by your mobile ID provider.

After entering Credentials, click "Validate" to test the connection before saving. The dialog shows a step-by-step progress indicator as you configure each part.

Account Credentials dialog
Connection Testing

Always test provider connections after configuration changes using the "Validate" button in the Credentials dialog, or the "Check Connection & Credits" button at the top of the editor.

Sync Configuration

Click "Edit" to configure provider synchronization settings. This opens a dialog where you can:

Enable/Disable Sync — Turn automatic synchronization on or off. When enabled, Breeze automatically keeps mobile IDs synchronized between Breeze and your mobile ID provider.

The dialog shows your current sync status and lets you toggle synchronization for this template.

For more information about how provider synchronization works, see Provider Synchronization.

Sync Configuration dialog

Incident Recipients

Click "Edit" to configure who receives alerts when something goes wrong.

Enter email addresses separated by semicolons, like security-ops@company.com;helpdesk@company.com. Having multiple recipients ensures someone gets notified even if one email address has issues.

What triggers incidents:

  • Connection failures — Provider connectivity issues
  • Sync errors — Synchronization process failures
  • Provisioning issues — Problems creating Credentials
  • Authentication errors — Provider Credential validation failures
Incident Recipients dialog

Layout

Click "Edit" to select a card layout for this template. The layout you choose serves multiple purposes:

  • Credential Preview — Used as a template when creating the Credential Preview in Breeze
  • Provider Transfer — The image is transferred to your mobile ID provider (STid)
  • Mobile ID App — This will be the card design shown in the Mobile ID app

This is the default behavior and is the recommended approach for most use cases.

Layout dialog showing card layouts selection

Alternative: External Layout Configuration

If you want to configure and design the layout in the STid portal instead of using Breeze layouts, you can enter the layout name in the External layout name field under General settings. This approach is generally not recommended and should only be used in certain specific cases where external layout configuration is required.

Template Field Settings

This section shows all the fields used when issuing Credentials from this template.

Template Field Settings section

Default fields

Templates include some predefined fields:

FieldTypeRequirementDescription
Person - EmailTXTRequiredPrimary contact email for the Credential holder
Person - First NameTXTRequiredFirst name of the Credential holder
Person - Last NameTXTRequiredLast name of the Credential holder

Each field shows its type (like TXT) and whether it's required. Each field has three edit buttons:

  • Configure field properties
  • Set validation rules
  • Control display settings

Adding custom fields

Click "Add field" to add a new field. Configure:

SettingDescription
Field NameGive it a clear, descriptive name
Field TypeChoose the data type (TXT, NUM, DATE, etc.)
RequirementMark it as required or optional

Background Removal Settings

Click "Change setting" to configure how photo backgrounds are handled.

Background Color — Controls what happens when photo backgrounds are removed. Default is white (#FFFFFF).

OptionDescription
TransparentKeeps the alpha channel (PNG format)
Solid ColorFlattens to the specified hex color
Background Removal Settings dialog

Duplicate vCard Handling

Click "Change setting" to configure what happens when the same vCard already exists:

OptionDescription
ERRORThe workflow fails if a duplicate exists. Gives you strict control but may cause workflow failures.
REPLACEThe existing vCard is replaced with new data
REUSEThe existing vCard is reused instead of creating a new one
Duplicate vCard Handling dialog
Duplicate Handling

Choose carefully. ERROR mode gives you control but may cause failures. REPLACE and REUSE handle duplicates automatically but could have unintended consequences.

Number Ranges and Formulas

Click "Edit" to assign number ranges and formulas:

Number Series Assignment — Assign number ranges for Credential identifier generation. You can link to existing number series or create new ones. Templates can use up to 3 number series per Credential.

Formula Assignment — Apply calculation formulas for dynamic field values. Useful for automatic date calculations, conditional values, and formatting rules.

Saving your changes

  1. Make your configuration changes in any section
  2. Click "Save" at the top right to save your changes
  3. Click "Close" to return to the template list without saving

Remember, you can always come back and edit things later—you don't need to get everything perfect in one session.

Before making a template visible

Before operators can use your template, make sure:

  • Provider Credentials are valid and tested (use "Check Connection & Credits")
  • Required fields are properly configured
  • Sync settings match your needs
  • Incident recipients are set up correctly

What's next?

You've configured your template! After saving, operators can start using it to issue mobile ID Credentials.