Release notes

Release 4.6.0, March 5th, 2026

Feature

  1. Added support for a new user type called App Developer. This user type is intended for developers that need to create test clients in Firely Auth, but do not need access to the admin dashboard. App Developers can only create and view clients that they own, and they do not have access to any other functionality in the admin dashboard. They will not be able to edit or delete clients. They are also blocked from obtaining access tokens. Clients created by App Developers must be reviewed and approved by an Admin before they can be used. See App Developer Portal for more information.

  2. Added support for retrieving the users fhirUser claim based on a lookup in a Master Patient Index. Note that this feature can only be used together with Firely Server v6.7.0. For more information, see FHIR User Lookup - $fhirUser-lookup.

  3. We improved the mobile viewing experience of the Firely Auth UI by making key pages responsive.

  4. We added support for serilog hot reloading of the log settings similar to Firely Server. This allows you to change the log level without needing to restart Firely Auth. See also Hot-reloading log event level for more details.

  5. We updated our API to support editing and deleting Admin users. Admin users can now be managed from the User Management page in the UI. These APIs are public as well and can checked out in our swagger documentation at the /swagger endpoint. Note that the last remaining Admin user cannot be deleted to prevent being locked out of the admin dashboard.

Fix

  1. We fixed an issue were database creation would fail if the user specified in the connection string did not have permissions to the master database. This is especially relevant for users using Azure SQL, where it is common to have a user with permissions only to a specific database.

  2. We updated the SQLite dependencies of Firely Server to address CVE-2025-6965. The package SQLitePCLRaw.provider.e_sqlite3 has been updated to the latest version 3.0.2, and the SQLite version that is used is updated to version 3.50.4.2

  3. The Firely Auth version will now also be visible in the Metrics Dashboard when metrics are enabled. This allows you to monitor which version of Firely Auth you are running in your environment.

Release 4.5.0, December 15th, 2025

Feature

  1. Added support for configuring the Duende IdentityServer license key via environment variable or appsettings.json file. This provides more flexibility in managing the license key, especially in containerized or cloud environments. See Deployment for more details.

  2. Added additional settings to the ExternalIdentityProviders section:

    • Support requesting specific scopes during the SSO login process.

    • Clarify whether Firely Auth should expect an id_token directly or an authorization code that still needs to be redeemed.

    • Support displaying an SVG image instead of static text for the login button on the Firely Auth login page.

    • Enable decryption of the id_token in case the SSO provider returns a JWE payload to further protect the claims it contains.

    For more information, see External identity providers.

  3. The user creation form was updated to perform a fhirUser lookup in Firely Server for the creation of local users. Users will be looked up based on their name and email, and the resulting Patient or Practitioner id will be used as a value for the fhirUser claim. Note that for this lookup to work, the patients name as registered in Firely Auth should be listed in the name.text element of the Patient resource in Firely Server.

  4. As a beta feature we implemented support for letting authorized representatives (e.g., caregivers) retrieve access tokens on behalf of a patient. For more information, see Authorized representatives and Designated Authorized Representative.

Fix

  1. Fixed a bug that would prevent custom favicons configured in the appsettings from being displayed to the user.

Release 4.4.1, September 24th, 2025

Fix

  1. We upgraded to IdentityServer 7.3.2 to address an issue where Firely Auth would not start with the provided Duende license key.

Release 4.4.0, August 19th, 2025

Feature

  1. Added the ability to assign custom tags to a client registration for better categorization. Admin users can label clients with tags such as "Testing" or "In-Production".

  2. SMART clients can now request a wildcard scope, even when restricted to certain resource types in the client registration. When a wildcard is requested, scopes will only be granted for the registered, allowed resource types.

  3. The client registration process has been streamlined to improve the experience for admin users registering applications with the introduction of client types. Clients can be created following a type, which is either a Standalone/EHR Launch type, a Backend Service type, or a Management API type. Be aware that during upgrading you might be prompted to update your clients to pass the newly introduced client validation. Clients that are not yet updated will remain active with their full functionality. Upon editing these clients the admin will be prompted to update them to the new client registration format.

  4. The client registration form now includes a “Legal & Compliance” section to document the following:

    - Contact Us URL
- Privacy Policy URL
- Terms of Use URL
- Legal Company Name

  5. The FHIR Server Availability section on the admin dashboard now includes the FHIR Server endpoint information.

  6. The Firely Auth user interface has been upgraded to visualize given consent and disclaimers per client as well as client compliance details more clearly.

  7. The setting TrustedProxyIPNetworks now supports a new flag: AllowAnyNetworkOrigins. - Previously, bypassing IP restrictions was only possible by setting ASPNETCORE_ENVIRONMENT=Development. - With this release, the same behavior can be achieved explicitly via AllowAnyNetworkOrigins. - Note: This setting is disabled by default and should only be enabled in trusted, secure environments.

  8. Firely Auth now includes an App Developer Portal that allows external application developers to self-register for an account and request OAuth2 client registrations, subject to administrator approval. For more information, see App Developer Portal.

Configuration

  1. Added the AppDeveloperPortal configuration section to control the self-service portal for external app developers. For more information, see AppDeveloperPortal.

Fix

  1. Fixed an ArgumentNullException that could occur if FhirUserLookupClaimsMapping was missing in the appsettings.

  2. Improved error handling for scenarios where the FHIR Server is not connected to Firely Auth and a client attempts to retrieve an access token.

  3. Fixed a startup issue that occurred while retrieving the CapabilityStatement from the FHIR Server configured with FHIR STU3 as its default information model.

Release 4.3.0, February 18th, 2025

Feature

  1. We have made Firely Auth safer by adding security headers to the responses. For more information, see Security headers.

  2. Firely Auth will now check the JWKS URL for updated keys if a new request for an access token is made by the client. Before, Firely Auth would only retrieve these keys from the JWKS URL once, and would not check for updated keys.

  3. We made improvements to the Standalone Launch and EHR Launch flows for the selection of the launch scope during the token request. For more information, see LaunchContext endpoint and EHR and standalone launch context settings.

  4. We improved the behavior of Firely Auth when a user requests a token for a client that enforces 2FA without that user having enabled 2FA. Users will now get prompted to activate 2FA.

  5. If a fhirUser claim is added as a ClientClaim, Firely Auth now enforces that this claim points to a Device resource.

Configuration

  1. We added two new options to the UI settings: OrganizationTitle and OrganizationFavIconPath. For more information, see UI Settings.

  2. We introduced the setting AllowedOperationScopes to restrict the custom operation scopes that can be requested by a client. For more information, see Clients.

  3. We introduced the ReverseProxySupport setting to enable and configure allowed IP ranges for X-Forwarded-* headers. For more information, see Proxy headers.

  4. Based on the ResourceTypeGrouping setting it is now possible to create groups of resources that can be selected by the admin as AllowedResources for a client, see Resource Grouping for Allowed Resources.

Release 4.2.1, October 10th, 2024

Feature

  1. With this hotfix release we enabled the use of X-Forwarded-Host and X-Forwarded-Prefix headers in combination with Firely Server. Also see Using X-Forwarded-Host header for more information.

Fix

  1. We fixed an issue where clients could no longer be saved in the UI if no external identity provider was configured.

  2. We removed the “*” option from the Allowed Resources section in the client registration form as this lead the client to not accept any resources at all. To accept all resources the Allowed Resources field can be left empty.

  3. We fixed an issue where the client grant consent lifetime would be set to zero if not otherwise configured, causing the consent to expire as soon as it was granted by the user. Consent will now only expire if an expiration time or date is set.

Release 4.2.0, September 25th, 2024

Feature

  1. The user interface for regular users has been improved in several ways. Users can now view and revoke the consent they have given to clients. In addition, they can view and revoke the disclaimers they have accepted. For more information, see Disclaimer Registration.

  2. Admins are now able to view the .well-known/smart-configuration of the connected Firely Server instance.

  3. The client registration form has been improved to become more intuitive. Depending on the grant type (either client_credentials or authorization_code), the form will show the necessary fields to fill in.

  4. Firely Auth implemented $liveness and $readiness endpoints. These endpoints can be used to check the health of Firely Auth. For more information, see Liveness and readiness.

Configuration

  1. With this release, it is possible to restrict auto provisioning of SSO users by their security groups. For this we added a new setting: AutoProvisionFromSecurityGroup. For more information, see External identity providers.

  2. It is now possible to derive the FhirUser claim for SSO auto-provisioning from existing users in the Firely Server database using the FhirUserLookupClaimsMapping setting. For more information, see External identity providers.

  3. It is now possible to set ConsentLifetime settings to control the lifetime of consent to clients. After this period has expired, users will be prompted again to give consent to this client. For more information, see Clients.

  4. Added the option ShowDisclaimerFor to the disclaimer section to control when a disclaimer should be shown to the user. For more information, see Disclaimer Registration.

Release 4.1.1, September 4th, 2024

Fix

  1. This is a hotfix release where we fixed the manual update scripts for updating the user databases to v4.1.x and higher. The scripts were not working correctly in the previous release.

Release 4.1.0, August 1st, 2024

Feature

  1. With this release, it is possible to let users log in via the Single Sign-On using external providers flow without them needing a user account in Firely Auth first. Upon logging in, these users will be automatically created via auto-provisioning and stored in the Firely Auth user database.

  2. It is now possible to add and edit client settings via the user interface. Before, these settings could only be changed by altering the appsettings. Note that because of this change, Firely Auth will load clients from the appsettings only once. After this initial load client settings need to be removed from the appsettings, or they will block start up of Firely Auth.

  3. We have made several improvements to the UI for a better user experience.

Configuration

  1. Added Lockout options to customize the lockout period and max amount of failed lock-in requests.

  2. It is now possible to add custom disclaimer templates that will be visible when the user tries to retrieve an access token. For more information, see Disclaimer Registration.

Fix

  1. Allow a missing trailing “/” when comparing the FHIR Server base url against the aud parameter when requesting a token.

Database

Attention

Starting with Firely Auth 4.1.0, every user account needs to contain a fhirUser claim in login. Users will be blocked from receiving an access token if the claim is not present. Please check after the migration if every user account, especially Practitioner accounts, have the claim present or add it if necessary.

  1. This release comes with an upgrade in the database structure to support the user auto-provisioning feature mentioned above. Any necessary database migrations will be automatically performed by Firely Auth upon start up.

Release 4.0.0, June 24th, 2024

Attention

The current release of Firely Auth, version 4.0, features new API capabilities, a redesigned user interface, and enhanced SMART on FHIR capabilities. With this release, Firely is deprecating support for any previous version of Firely Auth. It is recommended that all customers upgrade to the latest version.

Note

Support for .NET 6 ends in November 2024. See .NET Support Policy. This version of Firely Auth supports .NET 8. So, we recommend that you upgrade to Firely Auth 4.0.0 and hence .NET 8 before November 2024.

Feature

  1. (Important) Firely Auth has been upgraded to .NET 8. Please update the .NET runtime accordingly if installing Firely Auth using binaries. The Docker image has been updated for you.

  2. The homepage of Firely Auth provides a logged-in admin user the possibility to visualize the local .well-known/openid-configuration document incl. an overview of exposed endpoints and requestable SMART / OpenID scopes.

  3. The homepage of Firely Auth provides a logged-in admin user the possibility to view statistics about registered clients and users.

  4. Implemented an overview of all registered client applications for logged-in admin users which can be filtered based on different criteria.

  5. The management CLI for Firely Auth has been removed. As an alternative, all functionality has been moved to a management API. See Firely Auth User Management for more details.

  6. The user management for Firely Auth has been redesigned. In-Memory users are no longer available. As an alternative Firely Auth now provides, by default, a SQLite database as an administration backend. Please migrate all In-Memory users manually either through the UI or management API. See Sqlite user store for more details.

  7. Implemented an overview of all registered users (local and SSO) for logged-in admin users.

Configuration

  1. Added the possibility to provide custom email templates for the account verification of local users.

  2. Added the possibility to customize the logo and text on the welcome page of Firely Auth.

Release 3.3.1, April 22nd, 2024

Fix

  1. Fixed an issue were Firely Auth running in docker was unable to connect to a SQL server user store.

Release 3.3.0, March 20th, 2024

Security

  1. Disabling 2FA authentication for a client will now require a 2FA token from the user as an additional security step

  2. Added ‘Require2fa’ to the default appsettings. This replaces the current ‘RequireMfa’ setting.

Feature

  1. Firely Auth will now warn about invalid key/value pairs submitted to the launchContext API

  2. Values in the form of ‘<resourceType>/<id>’ submitted to the launchContext API will now be automatically translate to id-only values

Release 3.3.0-rc3, February 1st, 2024

Configuration

  1. EnableLegacyFhirContext is added to switch the syntax of fhirContext between SoF v2.1 and v2.0. See Firely Auth Settings for details.

  2. ClientClaims and ClientClaimPrefix are added to help a client to define custom claims in the client credential flow. See Firely Auth Settings for details.

Feature

  1. Harmonized Serilog sinks with Firely Server. See Changing the sink for details of all supported sinks.

  2. Enabled clients to add static custom claims in the client credential flow. See Firely Auth Settings for details.

Fix

  1. Fixed the EHR launch context in case of a user login via an external identity provider.

  2. Improved the validation of setting AllowedResourceTypes. Any invalid FHIR resource types will be rejected now.

  3. Improved the validation of setting AllowFirelySpecialScopes. Firely special scopes can now only be requested if an registered client has the setting set to true.

  4. In case of the EHR launch, no System.ArgumentException is thrown if both launch and launch/patient scopes are present in the request for the access token.

Release 3.3.0-rc2, November 23nd, 2023

Feature

  1. You can restrict a client to specific FHIR resource types, using the setting AllowedResourceTypes in the Clients. If the client requests SMART scopes for other resource types, the request will be denied.

Release 3.2.0, June 20th, 2023

Configuration

Attention

To make it easier to understand, some configuration sections are renamed or reorganized. Please check the bullets below for a summary of changes. For the details, please check page Firely Auth Settings.

  1. Section KeyManagementConfig is renamed to KeyManagement.

  2. Section FhirServerConfig is renamed to FhirServer.

  3. Section ClientRegistrationConfig is renamed to ClientRegistration.

  4. Section TokenConfig is removed, the AccessTokenType for each client is moved to the registration of the specific client.

  5. Section TokenIntrospectionConfig is removed, the secret of a token introspection end point can be configured using setting IntrospectionSecret within section FhirServer.

  6. For registering a specific client, the LaunchIds setting is removed. A dynamic Smart on Fhir launch context can be requested via the LaunchContext endpoint. See LaunchContext endpoint for details about how to request launch context dynamically.

Feature

  1. Users now can change their own passwords after login.

  2. A user account will be blocked temporarily after 5 unsuccessful authentication attempts and it will be unblocked in 5 minutes.

  3. Added a setting KeySize to adjust the RSA key size generated by Firely Auth. By default, it is set to 2048.

  4. Added a setting PasswordHashIterations to adjust the password hashing iterations in case of different security considerations. By default it is set to 600000. See User store for more details.

  5. Introduced LaunchContext endpoint for requesting Smart on Fhir launch context dynamically. See LaunchContext endpoint for more details.

  6. Added security attributes to session cookies.

Fix

  1. Disabled Client Initiated Backchannel Authentication (CIBA).

Attention

The aud used in an access token is updated to the FHIR_BASE_URL instead of the name of FHIR server.

Release 3.1.0, March 9th, 2023

Feature

  1. Added a setting to configure CORS support for only a limited set of origins. See AllowedOrigins for more details.

Release 3.0.0, December 2022

This is the first public release of Firely Auth, providing support for SMART on FHIR v1 and v2 and a SQL Server user store.